Introdução
Seja bem-vindo a nossa documentação!Referência da API
A esquerda estão listados todos os recursos disponíveis e cada um de seus endpoints determinando o que será consumido pela API.Todas as chamadas precisam ser enviadas com um token de acesso para (fornecido por nós) cliente e encaminhado para o integrador.
Toda a comunicação desta API será representada por objetos JSON.
Chamando a API
Veja como funciona a estrura de URL desta API.{URL_BASE_API}/via/{RECURSO}/{ENDPOINT}/{TOKEN}
-
{RECURSO}
Nome do recurso que deseja consumir. Por exemplo: produto, pedido...
-
{ENDPOINT}
Ação em si que determinará o que será consumido. Por exemplo: atualizar, cadastrar, consultar...
-
{TOKEN}
Substituir {TOKEN} pelo token único do cliente.
Respostas (responses)
- 429 Too Many Requests: Seu token de acesso estourou o limite diário de chamadas. Consulte abaixo sobre os limites.
- 401 Unauthorized: O token utilizado é inválido ou ainda não esta ativo.
- 400 Bad Request: A solicitação não foi bem sucedida e o item msg_erro será retornado.
- 200 OK: A solicitação foi realizada, porém o item retorno dirá se deu tudo certo através de um true ou false.
Para todas as duas situações acima o item status será retornado o código da resposta e o msg_alerta poderá ser retornado alertando que a chamada pode ser otimizada de alguma forma.
Limites de Requisições
- 1 requisição por segundo;
- 2.500 requisições por dia;
- 20 registros por requisição para processamento em lote;
- 20 registros por página em cada consulta, consulte: Paginação de resultados.
Paginação de resultados
Quando uma consulta retornar mais de 20 resultados será criado o item total_registros dentro de cabecalho como no exemplo abaixo:
Este padrão se aplica para qualquer tipo de consulta.
Para acessar as demais páginas basta adicionar o parâmetro ?pagina, por exemplo pagina=2, no GET da requisição.
{
"cabecalho": {
"paginacao": {
"total_registros": 52,
"limite_paginas": 20,
"total_paginas": 3,
"pagina_atual": 1,
"ultima_pagina": false
}
},
"item_solicitado": [...],
}
-
total_registros
Informa o total de registros sua busca possui desconsiderando a paginação.
-
limtie_paginas
Limite de registros por página.
-
total_paginas
Quantas páginas sua busca obteve.
-
pagina_atual
Em qual página está sua consulta.
-
ultima_pagina
Informa se a página atual é a ultima página ou não através de um true ou false
Webhook
Webhook é um mecanismo que permite que um sistema envie informações automaticamente para outro sistema em tempo real quando um evento acontece.
Documentação Webhook
Acesse nossa documentação de webhook