Entendendo a Comunicação com a API
As APIs do Delivery Direto foram desenvolvidas 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.
Cada operação é representada por um único endpoint, e o nome de cada endpoint encontra-se nas Referências das APIs.
Cada operação deve ser acessada através de uma requisição seguindo o seguinte formato:
https://deliverydireto.com.br/{moduloAPI}/{versaoAPI}/{nomeEntidade}
Padrão das URLs da API
As chamadas ao serviço são realizadas utilizando-se do endereço https://deliverydireto.com.br, seguidos por:
/admin-api/v1/para operações sobre o painel de administrador./store-api/v1/para operações sobre a loja.
https://deliverydireto.com.br/admin-api/v1/...
https://deliverydireto.com.br/store-api/v1/...
Verbos HTTP
Para cada endpoint, detalharemos as especificações dos parâmetros da requisição e do retorno, além dos métodos de requisição disponíveis (GET, PUT, POST e/ou DELETE). Parâmetros que exigem explicações mais detalhadas serão destacados após as informações de requisição e retorno de cada endpoint.
Respostas da API
O retorno das requisições é realizado apenas no formato JSON, sempre acompanhado do código HTTP apropriado:
| Código | Nome | Descrição |
|---|---|---|
| 200 | OK | O recurso solicitado foi processado e retornado com sucesso. |
| 201 | Created | O recurso informado foi criado com sucesso. |
| 401 | Unauthorized | A chave da API está desativada, incorreta ou não foi informada corretamente. Consulte a seção sobre autenticação da documentação. |
| 403 | Forbidden | O acesso ao recurso não foi autorizado. Isso pode acontecer quando a loja não tem permissão para acessar o recurso |
| 404 | Not Found | O recurso solicitado ou o endpoint não foi encontrado. |
| 422 | Unprocessable Entity | A requisição foi recebida com sucesso, porém contém parâmetros inválidos. |
| 429 | Too Many Requests | O limite de requisições (Rate Limit) foi atingido. |
| 400 | Bad Request | Não foi possível interpretar a requisição. Verifique as informações enviadas. |
| 500 | Internal Server Error | Ocorreu uma falha na plataforma do Delivery Direto. Por favor, entre em contato com o suporte. |
Autenticação
Todos os endpoints requerem a identificação da integração por meio do token de autenticação.
Esse token é obtida pelo endpoint:
https://deliverydireto.com.br/{moduloAPI}/token
Para sua validação neste endpoint, é necessário o uso dos parâmetros CLIENT_ID e CLIENT_SECRET no corpo da requisição.
tip
Leia a Sessão sobre Autenticação para mais detalhes e exemplos de como realizar a autenticação na API do Delivery Direto.
Identificação da Loja
Todos os endpoints requerem o uso de um ID do Delivery Direto, que identifica unicamente uma loja ou marca, e deve ser passado via headers, com o nome X-DeliveryDireto-ID.
Adicionalmente, deve ser passado o parâmetro Content-Type com o valor application/json por meio dos headers.