A documentação contida no Developers possui uma variedade de informações relacionadas a API da SULTS. A integração com o sistema da SULTS é feita em sua maioria através dos endpoints da API.
Além de detalhes sobre os endpoints, há também algumas informações sobre tópicos relevantes, como por exemplo informações sobre a integração por meio de Landing Pages produzidas pela SULTS.
A API é sem estado – todas as solicitações são validadas em um token da API.
Autenticação
Todas as chamadas de serviços devem ser autenticadas por um token, garantindo a segurança e confidencialidade no tráfego dos dados de cada parceiro.
O API KEY (token) consiste apenas em um único valor que deve ser enviado em um cabeçalho HTTP “Authorization”. Esse token pode ser gerado através do sistema da SULTS.
Vídeo explicativo sobre a geração de token
Exemplo de como fazer uma requisição após obter o token de autenticação:
fetch("https://api.sults.com.br/v1/empresas", {
method: "GET",
headers: {
"Authorization": "<token_de_acesso>"
}
})No exemplo da requisição acima o código javascript esta fazendo uma requisição no endpoint de listar unidades. Note que dentro do bloco headers deve-se adicionar a chave Authorization com o valor sendo o token gerado no passo anterior substituindo o valor <token_de_acesso>.
Formatação de datas
Todas os campos de datas na API são padronizados nos seguintes formatos:
- Data e Hora: yyyy-MM-ddTHH:mm:ssZ
Todas as datas e horas são apresentados no formato UTC ISO 8601.
Máscaras
Informações que possuem máscaras (formatações de dígitos) como CNPJ, telefone, CEP, etc., são retornados sem máscaras, por exemplo:
- Celular: 11987654321
- CEP: 38026000
Paginação
Alguns endpoints de listagem da API são paginados e para navegar entre as paginas é preciso apenas adicionar na url os seguintes parâmetros:
- start: Inteiro que refere-se a página.
- limit: Inteiro que refere-se a quantidade de registros por página.
A resposta da paginação retorna as seguintes informações:
- data: Lista com os dados
- start: Inteiro referente a página desejada
- limit: Inteiro referente a quantidade de registros desejados
- totalPage: Inteiro referente a quantidade de páginas disponíveis.
- size: Inteiro referente quantidade de registros disponíveis para página.
Exemplo:
fetch("https://api.sults.com.br/api/v1/endpoint-paginado?start=0&limit=3", {
method: "GET",
headers: {
"Authorization":"<token_de_acesso>",
"Content-Type":"application/json;charset=UTF-8"
}
})Resposta:
{
"data":[
{
"id":1,
"titulo":"Teste 1"
},
{
"id":2,
"titulo":"Teste 2"
}
,
{
"id":3,
"titulo":"Teste 3"
}
],
"start":0,
"limit":3,
"totalPage":5,
"size":3
}