Visão geral

Bem-vindo à documentação da API! Nesta página, você encontrará tudo o que precisa saber para melhorar a segurança e a qualidade dos seus aplicativos usando nossa API.

Integração

A API da CAF segue o REST padrão. Portanto, nossa API possui URLs previsíveis orientadas a recursos que aceitam e retornam dados em formato JSON, além de usar códigos HTTP padrão na resposta.

Aviso importante sobre autenticação e integrações

Todas as integrações com as APIs da CAF devem ser implementadas exclusivamente via backend/server-side. Integrações no lado do cliente ou baseadas em frontend podem ser bloqueadas e aumentam significativamente o risco de exposição da chave de autenticação.

A Caf monitora continuamente o uso e a exposição das chaves de autenticação. Qualquer chave identificada como exposta, comprometida ou usada em implementações não conformes será revogada imediatamente, o que pode resultar na interrupção da operação associada, sem aviso prévio.

É responsabilidade do integrador garantir conformidade com os padrões de autenticação recomendados e as melhores práticas de segurança descritas nesta documentação.

Respostas

Usamos códigos de resposta convencionais para indicar sucesso ou falha em uma solicitação. Em resumo, códigos na 2xx faixa representam sucesso. Códigos na 4xx faixa indicam tipos de erro de validação com as informações fornecidas ou falhas mapeadas. Por fim, códigos na 5xx faixa indicam um erro nos servidores ou alguma outra falha imprevista.

Além disso, todas as respostas têm um identificador para a solicitação, o requestId campo. Esse campo é útil para encontrarmos a solicitação exata em caso de investigação.