A API de Integração do Doqz foi construída com base em tecnologias atuais, visando principalmente padronização de acesso e segurança.
Restful
Utilizamos verbos do protocolo HTTP para identificar as operações que serão executadas, padronizamos a nomenclatura e as configurações de acesso dos recursos e retornamos HTTP Status Codes condizentes com a resposta gerada.
As respostas da API podem ser as seguintes
- 2xx: Sucesso
- 4xx: Erro do lado cliente
- 5xx: Erro do lado servidor
A seguir as descrições dos status:
| HTTP | Status | Descrição |
|---|---|---|
| 200 | Ok | Requisição OK, tudo ocorreu como esperado |
| 400 | Bad Request | Essa resposta significa que o servidor não entendeu a requisição pois foi enviado uma sintaxe inválida. |
| 401 | UnAuthorized | O cliente deve se autenticar para obter a resposta solicitada. |
| 404 | Not Found | O servidor não pode encontrar o recurso solicitado. |
| 500 | Internal Server Error | A requisição não foi atendida por algum erro ocorrido no servidor. |
| 501 | Service Unavailable | O servidor não está pronto para manipular a requisição. Causas comuns são servidor em manutenção ou sobrecarregado. |
API Key / Token
Utilizamos chaves para permitir acesso aos recursos da API, esta chave é um Token que deve ser informada no header das chamadas de API.
JSON & UTF8
Utilizamos um único padrão de codificação para as requisições e respostas.
Notificação de Eventos - Webhooks
Algumas APIs possuem opção de informar uma URL de vinculação para webhooks. Os webhooks permitem que sistemas externos recebam notificações de eventos gerados pelas APIs do Doqz, eles são conhecidos também de Callbacks ou Reverse API.
O que são Webhooks?
Para mais informações sobre o que são Webhooks clique aqui. E se quiser criar um endpoint de Webhook para testes gere uma URL e acompanhe as mensagens recebidas.