Chaves de API e Webhooks

Se a sua empresa integra a Assin com outros sistemas (ERP, CRM, site), use chaves de API para enviar e consultar envelopes e webhooks para receber avisos automáticos quando algo acontece. Tudo fica em Integrações no menu lateral, com as opções API Keys e Webhook.

Só para empresa (PJ): Esta função não está disponível na conta de pessoa física. Veja a diferença em Usando a Assin como pessoa física.

Esse menu aparece para empresas com o acesso a API liberado no plano. Se você não o vê, fale com o Suporte ou com o seu gestor.

API Keys

1. Em Integrações > API Keys, a lista mostra o Nome, a Public Key, o Status (Ativa ou Inativa), a data de criação e de atualização e as Ações.

2. Para criar, clique em “Nova API Key”, dê um nome que identifique a integração (por exemplo, “Integração CRM”) e clique em “Avançar”. Copie a chave gerada e guarde em local seguro: ela dá acesso à conta da sua empresa.

3. Em Ações você pode:

• Ativar chave / Desativar chave: liga ou desliga o uso da chave sem excluí-la.
• Regenerar chave: gera uma nova chave no lugar da atual. A ação não pode ser desfeita e as integrações que usam a chave antiga precisam ser atualizadas.
• Deletar chave: remove a chave definitivamente.

Boas práticas: crie uma chave por integração, nunca compartilhe a chave por e-mail ou chat e desative as que não usa mais. As requisições são feitas pela API pública da Assin (documentação disponível para a sua equipe de desenvolvimento).

Webhooks

Um webhook é um endereço (URL) do seu sistema que recebe um aviso da Assin quando um evento acontece, por exemplo, quando um envelope é finalizado.

4. Em Integrações > Webhook (tela Destinos de evento), a lista mostra a URL do endpoint, a Descrição e as Ações (editar e excluir).

5. Clique em “Novo endpoint”, informe a URL e uma descrição (até 200 caracteres) e clique em “Avançar”. A URL precisa ser pública e usar HTTPS: não pode ser localhost nem um IP da rede interna.

6. Use o lápis para editar e a lixeira para excluir um endpoint (a plataforma pergunta “Deseja deletar esse endpoint?”). Ao abrir um endpoint você também vê o histórico de entregas, com horário e endereço IP.

Pontos de atenção:

• O seu servidor deve responder com sucesso (código 2xx) e tratar o mesmo evento com segurança caso ele chegue mais de uma vez (idempotência).
• Se o seu sistema estiver fora do ar, a Assin registra a falha no log do endpoint, mas não reenvia automaticamente.

Para mais informações acesse nosso site https://assin.com.br/

Viu como é simples Assin?

Assin Assinatura Digital