Introdução#
Bem-vindo ao site de documentação da API Sismotel.#
Utilizamos o padrão RESTful para comunicação entre os sistemas e o padrão de mensagens JSON para enviar e receber os dados.
Warning
Limite de frequência#
Para garantir o bom desempenho da API, as integrações serão submetidas a um limite de requisições (throttling).
O limite é de 100 requisições por minuto para cada dispositivo. Limitamos também os endpoints seguindo modelo abaixo:
| Endpoint | Request limit | Method |
|---|---|---|
| conta | 1 a cada 5 segundos | GET |
| pedido | 1 a cada 5 segundos | POST |
| Outros Endpoints | 1 por segundo | GET |
Caso seja ultrapassado o limite a requisição retornará o status 429 (too many requests) e a mensagem O limite de requisicoes foi atingido, Aguarde (X) segundos e tente novamente.
Todos os recursos disponíveis retornarão o seguinte JSON:#
| Field | Type |
|---|---|
| success | boolean |
| message | text |
| data | array of objects |
Info
Todas as respostas das requisições da API possuirão um indicador de sucesso chamado success. Caso o valor seja false um campo chamado message será enviado com a mensagem que indica a falha ocorrida na requisição. Consulte o arquivo de log para ver detalhes técnicos.
Usamos respostas HTTP convencionais para indicar o sucesso ou a falha de uma solicitação da API. Em geral: os códigos no intervalo 2xx indicam sucesso. Os códigos 4xx indicam um erro que falhou. Códigos 5xx indicam um erro com nossos servidores (raros de acontecer).
Todos os recursos disponíveis retornarão o seguinte JSON:#
| Field | Type |
|---|---|
| success | boolean |
| message | text |
| data | array of objects |