Skip to main content

​
Base URL

A API de Integração Gestio disponibiliza dois ambientes: Os endpoints de Cliente descritos nesta referência estão disponíveis sob o prefixo /v2, por exemplo /v2/cliente.
Utilize o ambiente de desenvolvimento (https://devapi.gestio.com.br) durante a implementação e testes da sua integração para evitar impacto nos dados de produção. No playground desta documentação, é possível alternar entre os ambientes pelo seletor de servidor.
Os ambientes de produção e desenvolvimento são independentes: credenciais, tokens e dados não são compartilhados entre eles. Gere um usuário de integração específico para cada ambiente.

​
Autenticação

Toda requisição (exceto a de autenticação) deve incluir o token de acesso no header Authorization:

Gere um token em /v2/autenticar

Envie email e password do usuário de integração cadastrado no Gestio para receber o accessToken.
A rota /v2/autenticar sempre responde com HTTP 200, mesmo quando email/password estão incorretos. Verifique o campo authenticated no corpo da resposta para saber se a autenticação foi bem-sucedida.
Tokens expiram após um período determinado. Se receber 401 em qualquer rota de Cliente, gere um novo token antes de repetir a chamada.
Nunca exponha email/password de integração em código client-side (frontend, apps mobile). A autenticação deve ser feita apenas pelo seu backend.

​
Formato de resposta

Os endpoints de Cliente retornam JSON com um envelope simples baseado no campo success:
Em endpoints de listagem sem filtro de registro único (como GET /v2/cliente sem cnpjcpf/idws), data é um array de clientes. Quando um filtro de registro único é informado, data é um único objeto (ou null, se nada for encontrado). Em caso de erro de validação ou de regra de negócio (HTTP 400), o envelope muda de formato:
Sempre verifique success antes de acessar data. Em respostas de erro, use o array errors para identificar o campo (key) e a mensagem (value) de cada notificação.

​
Códigos de status HTTP

​
Limites

Consultas de listagem (GET /v2/cliente sem cnpjcpf/idws) são limitadas a 500 registros por chamada. Use os parâmetros dataInferior/dataSuperior para filtrar por período de atualização e paginar a consulta manualmente.
Use dataInferior/dataSuperior para limitar a janela consultada. Sem filtro, a resposta pode ser volumosa.

​
Precisa de ajuda?

Portal de sugestões

Sugira melhorias e novos recursos para a API.

Suporte

Abra um chamado com nossa equipe de suporte.