Quickstart da API v1 do SULTS

API v1 Em cinco minutos você gera o token, faz a primeira chamada e vê as unidades da sua rede em JSON.

Pré-requisitos

Conta no SULTS com permissão de administrador, necessária para gerar o token.
Um terminal com curl, ou o seu editor com a linguagem de preferência.

Passo 1: gere o token da v1

Na plataforma, vá em Segurança > API > Gestão de Tokens v1 e crie um token. Copie o valor gerado e guarde em local seguro.

Use a Gestão de Tokens v1. Um token criado na gestão v2 recebe 401 nos endpoints desta versão.

O passo a passo com prints está em Crie seu token.

Passo 2: liste as unidades da sua rede

GET /v1/empresas devolve as unidades cadastradas. É uma chamada leve e sem efeito colateral, boa para a primeira tentativa. Troque SEU_TOKEN pelo token que você acabou de gerar.

curl "https://api.sults.com.br/v1/empresas?start=0&limit=100" \
  -H "Authorization: SEU_TOKEN"

import requests

resposta = requests.get(
    "https://api.sults.com.br/v1/empresas",
    headers={"Authorization": "SEU_TOKEN"},
    params={"start": 0, "limit": 100},
)
resposta.raise_for_status()

for unidade in resposta.json():
    print(unidade["id"], unidade["nomeFantasia"])

const url = new URL("https://api.sults.com.br/v1/empresas");
url.searchParams.set("start", "0");
url.searchParams.set("limit", "100");

const resposta = await fetch(url, {
  headers: { Authorization: "SEU_TOKEN" },
});
if (!resposta.ok) throw new Error(`HTTP ${resposta.status}`);

const unidades = await resposta.json();
unidades.forEach((u) => console.log(u.id, u.nomeFantasia));

<?php
$url = "https://api.sults.com.br/v1/empresas?start=0&limit=100";

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: SEU_TOKEN"]);
$resposta = curl_exec($ch);
curl_close($ch);

foreach (json_decode($resposta, true) as $unidade) {
    echo $unidade["id"] . " " . $unidade["nomeFantasia"] . PHP_EOL;
}

using System.Net.Http;
using System.Text.Json;

var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "SEU_TOKEN");

var json = await http.GetStringAsync(
    "https://api.sults.com.br/v1/empresas?start=0&limit=100");

using var doc = JsonDocument.Parse(json);
foreach (var unidade in doc.RootElement.EnumerateArray())
{
    Console.WriteLine($"{unidade.GetProperty("id")} {unidade.GetProperty("nomeFantasia")}");
}

O token vai puro no header. Não escreva Bearer antes dele.

Passo 3: confira a resposta

Você deve receber 200 e um JSON com as unidades da sua rede:

[
  {
    "id": 1,
    "ativo": true,
    "razaoSocial": "SULTS Tecnologia LTDA",
    "nomeFantasia": "Sabor Mineiro Savassi",
    "cnpj": "12345678000190",
    "dtCadastro": "2026-07-15T14:32:08Z",
    "endereco": {
      "uf": "MG",
      "cidade": "Uberaba",
      "bairro": "Centro",
      "cep": "38026000"
    }
  }
]

Se apareceu o nomeFantasia de pelo menos uma unidade sua, a integração está autenticada e funcionando.

Se algo der errado

A causa mais comum de falha na primeira chamada é o token. Confira, nesta ordem:

O token foi copiado por inteiro, sem espaço sobrando.
O header tem o nome exato Authorization.
O valor não tem o prefixo Bearer.
O token nasceu na Gestão de Tokens v1, não na v2.

Persistindo a falha, o corpo da resposta traz a mensagem. O catálogo completo está em Erros.

Próximos passos

Convenções

Paginação, datas em UTC e campos sem máscara.

Mantenha os dados atualizados

O padrão de polling incremental, página a página.

Referência da API

Os endpoints dos 7 módulos, com playground.

​Pré-requisitos

​Passo 1: gere o token da v1

​Passo 2: liste as unidades da sua rede

​Passo 3: confira a resposta

​Se algo der errado

​Próximos passos

Convenções

Mantenha os dados atualizados

Referência da API

Pré-requisitos

Passo 1: gere o token da v1

Passo 2: liste as unidades da sua rede

Passo 3: confira a resposta

Se algo der errado

Próximos passos