Autenticação

A autenticação em nossa API é feita através do uso de uma chave de API. É através desta chave que nosso sistema identifica a sua conta e permite a comunicação conosco em nome da conta em questão.

Caso a chave de API seja inválida, não seja informada ou o header esteja incorreto, nossa API retornará HTTP 401.

Atenção!

• Armazenamento seguro: Após receber a sua chave de API, salve-a imediatamente em um cofre de chaves, evitando expô-la em mensagens, e-mails ou outros meios inseguros.

• Proteção no código: Nunca inclua a chave de API diretamente no código fonte dos sistemas para evitar exposição acidental.

• Confidencialidade: Não compartilhe sua chave de API em atendimentos, com terceiros ou em qualquer parte do front-end da aplicação.

• Prevenção de exposição em logs: Assegure-se de que a chave de API não apareça em logs de sistema gerados pela aplicação.

• Renovação da chave antes da produção: A primeira chave de API liberada pelo nosso time técnico será para acesso ao ambiente de Homologação. Após implementar as rotas necessárias para sua integração, será necessário que nosso time interno valide para liberação da chave de API do ambiente de Produção.

• Perda da chave de API: A chave de API não pode ser recuperada se perdida; nesse caso, será necessário solicitar uma nova.