A API Ceape Brasil foi desenvolvida de acordo com os melhores padrões REST.
As operações são feitas por requisições aos endpoints, de acordo com os verbos HTTP, com corpos de mensagem em JSON. As respostas podem ser interpretadas através do código de status HTTP. Isso permite que quaisquer aplicações consumam a API de forma simples e clara, independente da linguagem utilizada.
Confira a baixo a documentação
A utilização da API do Ceape Brasil se inicia com a obtenção de um token que será utilizado em toda requisição à API. Para obter um token e consequentemente consumir os recursos contidos na API do Ceape Brasil você precisará fazer login com um usuário e uma senha, conforme descrito no tópico Requisição:
Você também poderá conferir o retorno de sua requisão ao endpoint Autenticação no tópico Resposta
Para a obtenção do seu Token API você precisará informar dois campos antes de efetuar a requisição. São eles: Usuario (seu login no Ceape Brasil) e Senha (sua senha no Ceape Brasil)
Segue abaixo, os parâmetros necessários para realizar o login e obter o Token API de sua conta na API Ceape Brasil
| Nome do Parâmetro | Tipo | Obrigatório |
|---|---|---|
| Usuario | String | SIM |
| Senha | String | SIM |
Para obter o seu TOKEN API e realizar a Autenticação na API Ceape Brasil, você deverá enviar o seu Usuario e sua Senha na Requisição.
Confira a baixo um exemplo do JSON a ser enviado ao endpoint de Autenticação
{
"Usuario":"NOME DO USUÁRIO",
"Senha":"5e17b942669a5b61da2de567d5522f2e"
}
O Endpoint poderá retornar dois tipos de dados, após a relização da Autenticação.
Caso a Autenticação seja feita com SUCESSO a API do Ceape Brasil retornará um JSON semelhante ao exemplo abaixo.
{
"Empresa":"NOME DA EMPRESA",
"TokenApi":"5e17b942669a5b61da2de567d5522f2e"
}
Código HTTP da Requisição: 200
Caso a Autenticação apresente FALHA a API do Ceape Brasil retornará um JSON semelhante ao exemplo abaixo.
{
"Message":"Usuário ou senha inválidos",
}
Caso nenhum dos Parâmetros obrigatórios seja informado, a API Ceape Brasil retornará o seguinte JSON.
{
"Message":"Os dados de autenticação são inválidos."
}
Código HTTP em ambas as Requisições: 400