CON
| Dica |
|---|
|
Campos marcaos com o * (asteristico) o seu preenchimento é obrigatório |
...
04. ERROS
A seguir, alguns dos erros comuns que podem ser apresentados ao lidar com requisições HTTP e suas respectivas respostas:
- HTTP Status Code - 400 - Bad Request
| Âncora |
|---|
| status_code_400 |
|---|
| status_code_400 |
|---|
|
O código de status HTTP 400, conhecido como "Bad Request" (Requisição Inválida), indica que o servidor não pôde processar a requisição do cliente devido a uma sintaxe inválida, estrutura malformada ou dados inválidos presentes na requisição.
4.1 - Formato inválido do JSON esperado:
A requisição foi enviada com um JSON malformado ou inválido, o que impede o sistema de interpretá-la corretamente. Isso ocorre quando a estrutura JSON contém erros de sintaxe, como chaves ou colchetes incorretos.
| Bloco de código |
|---|
| title | JSON Inválido |
|---|
| linenumbers | true |
|---|
|
{
"integrationHubServiceId": "a9cad639-5775-4f8a-917b-2ae0f2d284d8",
"orderKeyType": "string",
"orderKey": ["string"]
} |
| Bloco de código |
|---|
| title | JSON Resposta |
|---|
| linenumbers | true |
|---|
|
{
"errors": [
{
"key": "orderKeyType",
"message": "body.orderKeyType must be one of [ORDER_ID, TABLE, CARD]"
}
]
} |
...
4.2 - JSON enviado com a ausência de um ou mais campos obrigatórios:
Se a requisição estiver faltando um ou mais campos obrigatórios, o servidor responderá com um erro 400. Cada campo requerido deve estar presente para que a operação seja processada corretamente.
| Bloco de código |
|---|
| title | JSON Inválido |
|---|
| linenumbers | true |
|---|
|
{
"integrationHubServiceId": "a5c4e135-aacd-49c1-b051-160a78a83b56"
} |
| Bloco de código |
|---|
| title | JSON Resposta |
|---|
| linenumbers | true |
|---|
|
{
"errors": [
{
"key": "orderKeyType",
"message": "body.orderKeyType is required"
},
{
"key": "orderKey",
"message": "body.orderKey is required"
}
]
} |
...
4.3 - GUID incorreto:
O GUID (Identificador Globalmente Único) enviado na requisição está incorreto ou malformado, o que pode resultar em um erro. Um GUID é uma sequência específica que deve seguir o padrão correto.
| Bloco de código |
|---|
| title | JSON com o GUID inválido |
|---|
| linenumbers | true |
|---|
|
{
"integrationHubServiceId": "9a1cf326-c962-456f-8c49-c1bb2f340fc6A",
"orderKeyType": "TABLE",
"orderKey": []
} |
| Bloco de código |
|---|
| title | JSON Inválido GUID incorreto |
|---|
| linenumbers | true |
|---|
|
{
"errors": [
{
"key": "integrationHubServiceId",
"message": "body.integrationHubServiceId must be a valid GUID"
}
]
} |
...
4.4 - Requisição enviada sem informar o orderKey corretamente:
Caso a requisição seja enviada sem o campo orderKey ou com o valor incorreto, o sistema não conseguirá identificar o pedido, resultando em um erro 400. O orderKey deve estar corretamente preenchido e de acordo com o orderKeyType informado.
| Bloco de código |
|---|
| title | JSON com sem informar o código da orderKey |
|---|
| linenumbers | true |
|---|
|
{
"integrationHubServiceId": "808c143d-d6d4-4b95-8c37-efa3a934f222",
"orderKeyType": "TABLE",
"orderKey": [""]
} |
| Bloco de código |
|---|
| title | JSON Response |
|---|
| linenumbers | true |
|---|
|
{
"errors": [
{
"key": 0,
"message": "body.orderKey[0] is not allowed to be empty"
}
]
} |
| Nota |
|---|
| title | Nota: HTTP Status Code = 400 Bad Request |
|---|
|
A solicitação é inválida e não pôde ser processada devido a erros na entrada fornecida. Verifique os dados enviados e tente novamente. |
...
- HTTP Status Code 401 - Unauthorized
| Âncora |
|---|
| status_code_401 |
|---|
| status_code_401 |
|---|
|
O código de status HTTP 401, conhecido como "Unauthorized" (Não Autorizado), indica que a requisição não foi aplicada porque carece de credenciais de autenticação válidas para o recurso alvo. Diferente do código 403 (Forbidden), que significa que o servidor entendeu a requisição, mas se recusa a autorizá-la, o 401 é usado especificamente quando a autenticação é necessária e falhou ou ainda não foi fornecida.
| Nota |
|---|
| title | Nota: HTTP Status Code = 401 Unauthorized |
|---|
|
A solicitação não pôde ser processada porque o usuário não possui as permissões necessárias. Verifique suas credenciais e tente novamente. |
...
- HTTP Status Code 403 - Forbidden
| Âncora |
|---|
| status_code_403 |
|---|
| status_code_403 |
|---|
|
O código de status HTTP 403, conhecido como "Forbidden" (Proibido), indica que o servidor entendeu a requisição do cliente, mas está se recusando a cumpri-la. Isso geralmente ocorre quando o cliente não possui permissões adequadas para acessar o recurso solicitado, mesmo que as credenciais de autenticação tenham sido fornecidas corretamente.
| Bloco de código |
|---|
| title | URL enviada incorreda |
|---|
|
https://api-barramento.meuelevestage.com/order/getConsumptions |
| Bloco de código |
|---|
| title | JSON Response para URL incorreta |
|---|
| linenumbers | true |
|---|
|
{
"message": "Missing Authentication Token"
} |
| Nota |
|---|
| title | Nota: HTTP Status Code = 403 - Forbidden |
|---|
|
O cliente enviou a URL incorreta para solicitação da requisição. |
...
- HTTP Status Code 404 - Not Found
| Âncora |
|---|
| status_code_404 |
|---|
| status_code_404 |
|---|
|
O código de status HTTP 404, conhecido como "Not Found" (Não Encontrado), indica que o servidor não encontrou o recurso solicitado. Isso pode ocorrer quando o URL fornecido está incorreto, o recurso foi removido permanentemente ou não está disponível no momento da requisição.
| Bloco de código |
|---|
| title | Integration Hub Code Inválido |
|---|
| linenumbers | true |
|---|
|
{
"integrationHubServiceId": "f1b874af-96ab-4535-aac3-25118fe586cc",
"orderKeyType": "TABLE",
"orderKey": ["5"]
} |
| Bloco de código |
|---|
| title | JSON Response |
|---|
| linenumbers | true |
|---|
|
{
"errors": [
{
"key": "integrationHubServiceId",
"message": "Provider Merchant for integrationHubServiceId \"f1b874af-96ab-4535-aac3-25118fe586cc\" not found or disabled"
}
]
} |
| Nota |
|---|
| title | Nota: HTTP Status Code = 404 - Not Found |
|---|
|
Uma ou mais informações enviadas não puderam ser encontradas. |
...
- HTTP Status Code 412 - Precondition Failed
| Âncora |
|---|
| status_code_412 |
|---|
| status_code_412 |
|---|
|
VERIFICAR COM O KENNEDY
O código de status HTTP 412, conhecido como "Precondition Failed" (Pré-condição Falhou), indica que o servidor não atendeu a uma das pré-condições que o cliente colocou no cabeçalho da requisição.
| Bloco de código |
|---|
| title | JSON |
|---|
| linenumbers | true |
|---|
|
{
"integrationHubServiceId": "8f7949c3-cdd6-4db0-8746-369e651026b4",
"orderKeyType": "TABLE",
"orderKey": []
} |
| Bloco de código |
|---|
| title | HTTP Status Code 412 = Precpndition Failed |
|---|
| linenumbers | true |
|---|
|
{
"message": "NOT_FOUND",
"code": 412
} |
| Nota |
|---|
| title | Nota: HTTP Status Code = 412 Precondition Failed |
|---|
|
Alguma regra necessária para a execução da solicitação não foi atendida. É necessário analisar o conteúdo da resposta retornada para identificar os motivos. |
...
- HTTP Status Code 429 - Too Many Requests
| Âncora |
|---|
| status_code_429 |
|---|
| status_code_429 |
|---|
|
O código de status HTTP 429, conhecido como "Too Many Requests" (Muitas Requisições), indica que o cliente excedeu o limite de requisições permitido para um determinado período de tempo. Esse limite é definido pelo servidor e pode variar de acordo com a política de limitação de taxa implementada.
| Bloco de código |
|---|
| title | JSON da requisição |
|---|
| linenumbers | true |
|---|
|
{
"integrationHubServiceId": "7d7d205b-83ba-47c5-91ba-e4f32a2bbd9e",
"orderKeyType": "TABLE",
"orderKey": ["20", "40"]
} |
| Bloco de código |
|---|
| title | Resposta da última execução |
|---|
| linenumbers | true |
|---|
|
{
"success": true,
"error": null,
"integrationHubServiceId": "7d7d205b-83ba-47c5-91ba-e4f32a2bbd9e",
"orderKeyType": "TABLE",
"orderKey": [
"20",
"40"
],
"consumption": [
{
"orderId": "f5fee4b4-c13f-482d-8e98-0dd840629e02",
"type": "TABLE",
"createdAt": "2024-06-28 17:27:20",
"customerName": "TOTVS",
"items": [
{
"id": "39735945",
"index": "4",
"name": "MARACUJA",
"externalCode": "58",
"unit": "UNIT",
"ean": "",
"quantity": 1,
"specialInstructions": "TESTE",
"unitPrice": {
"value": 61,
"currency": "R$"
},
"optionsPrice": {
"value": 0,
"currency": "R$"
},
"totalPrice": {
"value": 61,
"currency": "R$"
},
"options": null,
"productionPoint": [
{
"name": "NENHUM"
}
]
}
],
"otherFees": [
{
"name": "Taxa de Serviço",
"type": "SERVICE_FEE",
"receivedBy": "MERCHANT",
"receiverDocument": "",
"price": {
"value": 6.1,
"currency": "R$"
},
"observation": ""
}
],
"discounts": [],
"total": {
"items": 61,
"otherFees": 6.1,
"discount": 0,
"orderAmount": 67.1
},
"delivery": null,
"takeout": null,
"indoor": null,
"table": {
"waiterCode": 9999,
"tableNumber": 20,
"chairNumber": 0
},
"card": null
}
]
} |
| Nota |
|---|
| title | Nota: HTTP Status Code = 429 - Too Many Requests |
|---|
|
Alguma regra para atender ao seu pedido não foi cumprida; analise o corpo da resposta para descobrir as razões. |
...
05. LINKS
CONTEÚDO
01. VISÃO GERAL
Esse endpoint serve para retornar a consumação dos pedidos.
...
