Autenticação
A API CorbMax autentica cada requisição pela chave de API do parceiro. A chave identifica o parceiro e a rede parceira a que ele pertence; todos os dados retornados são restritos a esse parceiro.
Enviar a chave
Seção intitulada “Enviar a chave”Envie a chave no header api-key, sem prefixo:
curl https://ms-credit-api-az.kemosoft.com.br/v1/catalog/credit-groups/options \ -H "api-key: SUA_CHAVE_DE_API"A chave tem o formato de um UUID, como 3f2a9c1e-8b4d-4f6a-9e2b-7c5d1a0b4e8f.
Não use Authorization: Bearer: esse header é reservado à sessão do painel.
Obter uma chave
Seção intitulada “Obter uma chave”A chave de API do parceiro é emitida pela rede parceira. Peça a chave ao administrador da sua rede parceira e informe para qual sistema ela será usada.
Erros de autenticação
Seção intitulada “Erros de autenticação”Quando a chave não é aceita, a API responde com HTTP 401 e uma das mensagens abaixo.
| Mensagem | Causa | O que fazer |
|---|---|---|
| Chave de API malformada | O valor enviado não tem o formato de uma chave. | Confira se a chave foi copiada inteira. |
| Chave de API não encontrada | A chave não existe. | Confira a chave com o administrador da rede. |
| Chave de API revogada | A chave foi revogada. | Solicite uma nova chave. |
| Chave de API removida | A chave foi removida. | Solicite uma nova chave. |
| Chave de API sem empresa vinculada | A chave não está associada a um parceiro. | Solicite uma chave de parceiro. |
| Empresa bloqueada | O parceiro está bloqueado. | Fale com o administrador da sua rede parceira. |
| Rede parceira bloqueada | A rede parceira está bloqueada. | Fale com o suporte CorbMax. |
Proteja sua chave
Seção intitulada “Proteja sua chave”A chave dá acesso aos dados dos clientes do parceiro e pode consumir créditos. Trate-a como uma senha.
- Use a chave somente em servidores. Nunca a coloque em aplicativos, páginas web ou qualquer código executado no dispositivo do usuário.
- Guarde a chave em um cofre de segredos ou em variáveis de ambiente, nunca no código-fonte ou no controle de versão.
- Nunca envie a chave em URLs ou parâmetros de consulta. URLs ficam gravadas em históricos, logs e cabeçalhos de referência.
- Não registre a chave em logs.
- Se suspeitar de vazamento, peça imediatamente ao administrador da sua rede parceira que revogue a chave e emita uma nova.