Respostas e status
Status code e signficados
| HTTP status code | Mensagem | Significado |
|---|---|---|
| 200 | OK | Solicitação bem sucedida. |
| 201 | Created | Um novo recurso foi criado no servidor. |
| 204 | No Content | Solicitação bem sucedida que retorna uma resposta sem conteúdo, sendo a informação armazenada em cache. |
| 400 | Bad Request | A solicitação não pode ser processada devido a um erro de escrita ou nos dados de entrada. |
| 401 | Unauthorized | Ocorreu falha na autenticação e o usuário não possui autorização para acessar essas informações. |
| 403 | Forbidden | O usuário está autenticado mas as credenciais de autenticação não são suficientes para acessar o recurso solicitado. |
| 404 | Not Found | Nenhuma informação associada aos dados de entrada foi encontrada. |
| 409 | Conflict | O servidor não pode concluir a solicitação devido a um conflito com o recurso de destino. |
| 412 | Precondition failed | A solicitação não pode ser concluída porque alguns prerequisitos não foram cumpridos. |
| 422 | Unprocessable Entity | O servidor não consegue processar a requisição apesar das informações estarem corretas. |
| 500 | Internal Server Error | Problemas com os nossos servidores. Ocorrem em baixa frequência. |
| 504 | Gateway timeout | O servidor, agindo como gateway ou proxy, não conseguiu uma resposta de outro servidor dentro do tempo determinado para completar a requisição. |
| CORS | Cross-Origin Resource Sharing | Mecanismo que permite uma página acessar o recursos de outro domínio. Erro de CORS indica que o servidor não autorizou a página a acessar estes recursos porque alguma informação de cabeçalho não está compatível com as configurações. |
Códigos de resposta
Códigos de resposta 2xx
200 OK
{
"mensagem": "Segue o valor da fatura de jan 2023: R$124,33",
"numeroCelular": "+5583900000000",
"resposta": "Requisição recebida. O SMS será processado em instantes."
}
201 Created
{
"idGrauParentesco": 5,
"idDependente": 9999,
"telefone": "83999999999",
"cpf": "99999999999",
"idClienteTitularAssociado": 999999,
"nome": "PORTADOR DA FICCAO",
"nomeSocial": "string",
"dataNascimento": "1990-02-16",
"sexo": "M",
"nomeMae": "MAE DO PORTADOR",
"status": "A"
}204 No content
Figura 1. Exemplo de response de sucesso com código 204 No Content
Códigos de resposta 4xx
400 Bad Request
{
"timestamp": "2024-08-08T13:47:43.358454549",
"statusCode": 400,
"message": "ARGUMENTO_INVALIDO",
"path": "/api/v1/broker/sms",
"fieldErrors": [
{
"objectName": "smsRequest",
"field": "numeroCelular",
"message": "campo deve possuir o tamanho entre 11 e 11"
}
]
}{
"timestamp": "2024-08-01T09:42:09.508611519",
"statusCode": 400,
"message": "Cartão não encontrado para o codigo informado.",
"path": "/api/v1/cartoes/segunda-via"
}Erro 400 ao utilizar ambientes
Figura 2. Erro 400 por utilizar cURL do ambiente de homologação num ambiente de Sandbox.
401 Unauthorized
{
"timestamp": "2024-08-08T11:11:16.061-03:00",
"status": 401,
"error": "Unauthorized",
"path": "/api/v1/portuno/accounts"
}Problemas na autenticação? Leia o artigo de autenticação para mais informações.
403 Forbidden
{
"timestamp": "2024-08-08T11:11:16.061-03:00",
"status": 403,
"error": "Forbidden",
"path": "/api/v1/portuno/accounts"
}Problemas na autenticação? Leia o artigo de autenticação para mais informações.
404 Not Found
{
"timestamp": "2024-07-08T16:21:34.774500834",
"statusCode": 404,
"message": "Recurso não encontrado (Account).",
"path": "/api/v1/recompensas/portador/201/anuidade/adesao"
}409 Conflict
{
"timestamp": "2024-07-04T16:54:59.388429838",
"status": 409,
"message": "Atributo repetido. O CNPJ informado é utilizado por outra loja.",
"path": "/api/v1/lojas"
}422 Unprocessable Entity
{
"timestamp": "025-07-08T16:21:34.774500834",
"status": 422,
"error": "Unprocessable Entity",
"path": "/api/v1/seguros/termos/portador/2001/adesao/1"
}Códigos de resposta 5xx
500 Internal Server Error
{
"timestamp": "2024-07-08T19:16:19.626+00:00",
"status": 500,
"error": "Internal Server Error",
"path": "/api/v1/recompensas/portador//anuidade/cancelamento"
}Soluções de erros
| Status code | URL do erro | Descrição do erro | Solução |
|---|---|---|---|
| 400 | /api/v1/faturamentos/parcelamento/2002/antecipacao | Número do id não está cadastrado (2002). | Cheque qual id foi cadastrada para esse serviço. |
| 400 | - | Sem corpo de resposta | Provável timeout, cheque sua conexão e as informações do endpoint. |
| 400 | /api/v1/faturamentos/parcelamento/x/antecipacao/total | Tipo do id inválido. Geralmente acompanhado da mensagem: "O tipo do campo deve ser: Long" | Cheque qual o tipo da id cadastrada para esse serviço. |
| 401 | - | "Unauthorized" | Sem autorização para usar a plataforma porque as credenciais são inválidas para o serviço em questão.Verifique as informações de autenticação |
| 401 | /api/v1/cartoes/vipagem/2001/reemissa | Endpoint escrito errado | Revise a escrita do path do enpoint e tente novamente. |
| 403 | "Forbidden" | Sem autorização para usar a plataforma porque as credenciais são inválidas, não foram informadas ou expiraram. | Verifique as informações de autenticação |
| 404 | /api/v1/faturamentos/faturas/antecipacao/simulacao | Não foi possível encontrar a resposta porque o campo idParcelamentoFatura não está preenchido. | Revise a escrita do endpoint e verifique qual id foi cadastrada para esse serviço. |
| 409 | api/v1/lojas/9/acordos-formas-pagamentos | Atributo repetido | Número do id já foi cadastrado para outro cliente. |
| 412 | /api/v1/seguros/adesao | Prerequisito não cumprido | Número de CPF não corresponde ao portador cadastrado. |
| 500 | "Network Error occurred." | Erro interno do servidor | Verifique a conexão com a internet, cheque se o serviço está disponível na plataforma. Se todas as informações acima estiverem corretas, é um possível problema de CORS. Contate nosso time. |
| 504 | "Gateway timeout" | Tempo limite do gateway atingido | Espere um pouco e tente novamente. Se o erro persistir, contate nosso time. |
| - | CORS | Cross-Origin Resource Sharing | Faça a limpeza do cache do seu navegador (cada navegador possui suas próprias instruções de como fazer isto) e tente novamente. |