O SULTS tem API?
Cada chamada carrega o seu token no headerAuthorization. A API valida o token, executa a operação e devolve JSON.
A API é stateless
Não existe login, sessão ou refresh token. O token é validado a cada requisição, e é a única coisa que identifica a sua integração. Isso simplifica o seu código: basta montar o header e chamar.Como autenticar na API do SULTS?
O token nasce dentro do SULTS, criado por um usuário administrador em Segurança > API > Gestão de Tokens. Essa tela tem duas gestões separadas, uma para cada versão da API, e os tokens não são intercambiáveis. Um detalhe custa muitos 401 para quem vem de outras APIs: o valor do header é o token puro. Não escrevaBearer antes dele.
Os detalhes estão em Autenticação.
Como paginar as listagens?
Nenhum endpoint de listagem devolve a base inteira de uma vez. Você percorre os registros página a página até chegar ao fim. Os nomes dos parâmetros mudam conforme a versão, e o formato exato de cada uma está nas convenções da versão que você usa: v1 ou v2.Qual é o limite de requisições?
A API aplica um limite de 2 requisições por segundo, por IP. Ao exceder, a resposta é429. Em varreduras grandes isso importa mais do que parece, e o tratamento correto está em Limites de requisição.
O que a API do SULTS não faz?
Vale saber antes de desenhar a sua integração:- Sem sandbox: não existe ambiente de testes separado. As chamadas atingem os dados reais da sua operação.
- Sem webhooks: a API não avisa quando algo muda. Para reagir a mudanças, use polling.
- Sem escrita de unidades e colaboradores: esses dados são lidos pela API, nunca gravados por ela.
Próximos passos
Qual versão eu uso?
A comparação lado a lado antes de escolher.
Autenticação
Como o token funciona e onde gerar o seu.