Autenticação
Todos os endpoints de integração usam uma API Key, enviada no cabeçalho X-API-Key.
A tua conta pode gerir mais do que uma empresa — ver Empresas para adicionar, listar e gerir (activar/desactivar) as empresas vinculadas à conta.
Obter a chave
Gera e gere as tuas chaves de API no dashboard, em Configurações → API Keys. A chave só é mostrada uma vez no momento em que é criada — guarda-a num local seguro (cofre de segredos / variável de ambiente).
Podes ter várias chaves (ex.: uma para produção, outra para testes) e revogar qualquer uma a qualquer momento pelo dashboard.
O cabeçalho correcto é X-API-Key, não Api-Key. Um cabeçalho com o nome errado é tratado como ausente e devolve 403.
Usar a chave
curl https://<host>/v1/client/status/<requestId> \
-H "X-API-Key: agt_live_XXXXXXXX.xxxxxxxxxxxxxxxxxxxxxx"Pré-requisitos geridos no dashboard
Antes de submeteres documentos, garante que a tua conta tem:
- A chave RSA do contribuinte carregada (necessária para assinar digitalmente os documentos).
- Pelo menos uma série activa para cada tipo de documento que vais emitir.
- Um plano de facturação activo — sem isto, qualquer pedido devolve
402 Payment Required.
Estes três itens são configurados e consultados directamente no dashboard, não através da API de integração.
Erros de autenticação
| Situação | Resposta |
|---|---|
Cabeçalho X-API-Key ausente ou mal formatado | 403 |
| Chave inexistente ou revogada | 403 |
| Conta com pagamento pendente | 402 |
Se receberes 403 de forma persistente, confirma no dashboard se a chave ainda está activa.