Assinafy
Crie requests da Assinafy com credenciais por conta e erros tipados do SignatureKit.
Assinafy cria o documento, registra o signatário e cria o assignment na conta configurada. SignatureKit mantém o shape tipado e deixa a cerimônia com a Assinafy.
Instalação
npm install @signature-kit/http @signature-kit/assinafyQuando usar
Use Assinafy quando organização por conta e acompanhamento de assignment pertencem à Assinafy. Use assinatura local quando o app controla bytes assinados e posicionamento.
Mantenha credenciais Redacted
Tokens de provider entram como Redacted.make(...) e são abertos apenas dentro da fronteira HTTP do pacote. Nunca passe tokens remotos para componentes React ou logs.
Request mínimo
import * as Alchemy from "alchemy"
import { AssinafySignatureRequest, providers as assinafyProviders } from "@signature-kit/assinafy"
import { signatureHttpClientLive } from "@signature-kit/http"
import { Effect, Layer, Redacted } from "effect"
export default class Contracts extends Alchemy.Stack<Contracts>()(
"Contracts",
{
providers: Layer.merge(
assinafyProviders({
apiKey: Redacted.make(process.env.ASSINAFY_API_KEY ?? ""),
accountId: process.env.ASSINAFY_ACCOUNT_ID ?? "",
environment: "sandbox",
}),
signatureHttpClientLive,
),
state: Alchemy.inMemoryState(),
},
Effect.gen(function* () {
return yield* AssinafySignatureRequest("contrato-de-servico", {
title: "Contrato de serviço",
message: "Revise e assine este documento.",
documents: [{ fileName: "contract.pdf", mimeType: "application/pdf", contentBase64: pdfBase64 }],
recipients: [{ name: "Ana Silva", email: "ada@example.com", routingOrder: 1 }],
send: true,
})
}),
) {}Fatos do provider
- Credenciais incluem API key e account id. Alternativamente, passe
accessTokenno lugar deapiKeypara autenticar comAuthorization: Bearer <token>em vez deX-Api-Key. - O adapter cria documento, signatário e assignment no mesmo fluxo.
- Falhas recuperáveis de HTTP e shape de resposta saem como
SignatureKitError.
Erros
Input inválido, falhas HTTP remotas e shapes de resposta inválidos falham como SignatureKitError. Os campos provider, operation e status HTTP são preservados quando a resposta upstream expõe esses dados.
Relacionados
Como está este guia?