Criar uma chave API

As chaves API permitem que outro sistema comande o AssinaJá — o seu ERP a criar documentos, ou um assistente de IA a trabalhar pela interface MCP.

Chaves de acesso à API pública e ao MCP do AssinaJá. Crie uma por cada sistema externo ou assistente de IA, com os acessos limitados ao que essa integração precisa.

Uma chave por integração

Crie uma chave por cada sistema externo que integra com a API pública (cabeçalho X-Api-Key). Cada chave pode ser suspensa ou eliminada isoladamente, sem afetar as restantes integrações.

É essa a razão da regra: uma chave partilhada não pode ser revogada sem partir tudo o que a usa. Uma chave por sistema permite cortar uma integração e deixar as outras a funcionar.

Criar uma

Escolha Nova API Key.

1. Nome — dê-lhe o nome do sistema que a vai usar, por exemplo ERP Primavera.
2. Data de validade — “A chave é válida até esta data, inclusive (deixa de autenticar no fim desse dia).”
3. Acessos — marque apenas o que esta integração precisa. É obrigatório pelo menos um: “Selecione pelo menos um acesso — a chave só pode fazer o que estiver marcado.”
4. Criar chave.

A chave é mostrada uma única vez

Copie e guarde esta chave em local seguro. Não será mostrada novamente.

Não há forma de a recuperar depois. Se a perder, elimina a chave e cria outra.

Acessos

Acesso	O que permite
Modelos — consultar	Listar e consultar modelos, incluindo signatários e campos de preenchimento.
Documentos — consultar	Listar documentos, acompanhar o progresso das assinaturas e descarregar ficheiros e relatórios.
Documentos — criar	Criar documentos a partir de modelos, de DOCX (MailMerge) ou de um PDF próprio.
Documentos — publicar	Publicar rascunhos — envia emails aos signatários e é irreversível.
Documentos — arquivar/eliminar	Arquivar e eliminar documentos.
Organização — consultar	Ver os dados da organização, o plano ativo e as funcionalidades disponíveis.
Catálogo de modelos	Só no plano Enterprise — ver abaixo.

Publicar é o perigoso

Documentos — publicar envia emails aos signatários e é irreversível. Criar e publicar são acessos deliberadamente separados, para que uma integração possa preparar rascunhos para uma pessoa rever, sem nunca os poder enviar. Conceda-o só quando o sistema deva mesmo enviar sozinho.

O acesso ao catálogo de modelos

Catálogo de modelos — servir outras organizações é diferente dos restantes:

Permite que outras organizações gerem documentos a partir do catálogo de modelos desta organização (cabeçalho X-Api-Key-TemplateCatalog). Não dá nenhum outro acesso.

Usa o seu próprio cabeçalho e não concede mais nada. Está Disponível apenas no plano Enterprise.

Gerir chaves

A lista mostra Nome, Chave, Acessos, Validade, Estado, Criada e Último uso — este último a dizer Nunca para uma chave que nunca autenticou. Essa coluna é a forma mais rápida de detetar uma chave que ninguém usa.

Ação	Efeito
Editar	Alterar o nome, a validade ou os acessos
Suspender	“Suspensa, a chave deixa de autenticar até ser reativada.”
Ativar	Reactivar uma chave suspensa
Eliminar	Definitivo

O Estado de uma chave é Ativa, Suspensa ou Expirada.

Suspenda antes de eliminar

Suspender é reversível; eliminar não é — “é irreversível — a integração que a usa deixa imediatamente de conseguir autenticar.” Se suspeitar que uma chave está comprometida ou sem uso, suspenda-a e veja o que parte. Pode sempre reactivar.

Ver também

• Papéis e permissões — gerir integrações é só de Owner e Admin
• Configurar políticas da organização