Autenticação
Como autenticar as chamadas à API de Integração com sua chave institucional.
Todas as chamadas à API de Integração são autenticadas por uma chave institucional (API key), enviada em um header em cada requisição.
O header de autenticação
Envie sua chave no header apikey:
apikey: SUA_CHAVE_INSTITUCIONALNão há OAuth2 nem token de sessão: a autenticação é só essa API key fixa no header, em texto puro.
Guarde sua chave com segurança
A chave identifica sua instituição e dá acesso aos seus dados. Nunca a exponha em repositórios públicos, no front-end ou em logs. Trate-a como uma senha.
Como obter a chave
A chave é fornecida pela Principia no onboarding: você recebe uma para staging e outra para produção. Se ainda não tem a sua ou tem dúvida sobre qual chave usar, fale com o time de integração pelo grupo do WhatsApp ou pelo e-mail processamento@principia.net.
Exemplo de requisição autenticada
curl https://api-staging.principia.services/api-integracao/v1/parcela/originais \
-H "apikey: SUA_CHAVE_INSTITUCIONAL"Se a chave estiver ausente ou inválida, a API responde com 401 Unauthorized. Veja mais em Tratamento de erros.
Testar sem escrever código
Teste GET /v1/parcela/originais nas Rotas da API: preencha sua apikey e envie direto do navegador.