Skip to main content
A documentação pública da API da Koolisys tem duas camadas, e elas nunca se misturam.

​
Referência

A referência vem da especificação OpenAPI, gerada a partir do código a cada publicação. Ela descreve cada rota, cada campo de entrada e saída, e cada erro que um endpoint pode devolver — sempre igual ao que o servidor realmente faz, porque ninguém edita esse arquivo à mão. Use a referência quando já souber o que procura: o formato exato de um campo, os parâmetros de uma rota, o schema de um corpo de requisição.

​
Guias

Os guias abaixo são escritos por gente e cobrem o que a referência não cobre — o “por onde eu começo”:
  • Primeiros passos — obter a chave, trocar por token, fazer a primeira chamada.
  • Autenticação — o modelo de chave e token, validade, renovação e revogação.
  • Abrir um atendimento — o fluxo completo, da elegibilidade ao acompanhamento.
  • Idempotência — por que existe, como usar, o que acontece ao repetir.
  • Erros e limites — os códigos estáveis, o que fazer com cada um, e como respeitar o rate limit.
Comece pelos primeiros passos se esta é sua primeira integração.

​
Convenções usadas nos exemplos

Todo exemplo desta documentação é executável e completo — cabeçalhos, corpo e resposta esperada — e roda sem adaptação além de trocar a credencial pela sua. Nenhum exemplo usa chave, token ou dado real:
  • A URL base é sempre https://api-koolisys.eixoassistencia.com.br, um placeholder.
  • A chave de API é sempre kls_EXEMPLO000000000000000000000000000000000000000000000000000000000, claramente fictícia — a sua tem o mesmo formato (kls_ seguido de caracteres aleatórios), mas nunca este valor.
  • Documentos (CPF/CNPJ) e outros dados pessoais são sintéticos nas respostas de exemplo — nunca uma amostra de produção —, mas aparecem em claro, no mesmo formato que a API real devolve.
Toda resposta segue o envelope { "data": ..., "meta": {...}, "errors": [...] }. Uma chamada com sucesso traz errors: [] e meta com o que for específico daquele endpoint (ex.: nextCursor numa listagem, {} quando não há nada a acrescentar); uma chamada recusada traz data: null e ao menos um item em errors, cada um com code, message e, quando fizer sentido, field ou details — ver Erros e limites.