Skip to main content
API v1 A v1 é a API completa em produção do SULTS, com os 7 módulos da plataforma. É onde está quem já integra hoje.
Você está na documentação da v1. A v2 é a nova geração e hoje cobre os módulos de Compras, Comunicados, Chamados e Checklist. Em dúvida sobre qual usar, veja Qual versão eu uso?.

O que a API v1 do SULTS cobre?

A maior parte da v1 é de leitura. Existem 7 endpoints de escrita, em Chamados, Compras e Expansão, e eles estão marcados na referência com o método POST ou PUT. Unidades e colaboradores são apenas leitura: a API não grava esses dados. No módulo de Compras, as novidades chegam só na v2: mix de produtos, etapas de pedido e as próximas funcionalidades do módulo. A v1 de Compras segue funcionando, mas integração nova de Compras deve começar pela v2.

Sua jornada até a produção

1

Faça a primeira chamada

Gere o token e liste as unidades da sua rede em 5 minutos no quickstart.
2

Aprenda as convenções

Paginação com start e limit, datas em UTC e campos sem máscara: as regras que valem para a v1 inteira estão em Convenções.
3

Prepare a integração para falhas

Trate os erros desde o início, com o catálogo em Erros.
4

Monte a sua sincronização

Mantenha o seu sistema atualizado com o padrão descrito em Como manter os dados atualizados.
5

Explore a referência

Os endpoints dos 7 módulos, com parâmetros, exemplos em 5 linguagens e playground, estão na aba Referência da API.

Próximos passos

Comece em 5 minutos

Do token à primeira resposta, com exemplos em cinco linguagens.

Referência da API

Os endpoints dos 7 módulos, com playground para testar do navegador.