> ## Documentation Index
> Fetch the complete documentation index at: https://developers.sults.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# API v1 do SULTS

> O que a API v1 do SULTS cobre: os 7 módulos da plataforma, o token da gestão v1 e por onde começar a integrar

export const Modulo = ({nome, href, icone, texto, situacao, metodos = []}) => <a className={"modulo-card" + (situacao === "Em migração" ? " modulo-card-migracao" : "")} href={href}>
    <span className="modulo-demo">
      <span className="modulo-icone" style={{
  backgroundImage: "url(/images/modulos/" + icone + ".svg)"
}} />
      {metodos.length > 0 && <span className="modulo-metodos">
          {metodos.map(([metodo, total]) => <span key={metodo} className={"modulo-metodo modulo-metodo-" + metodo.toLowerCase()}>
              {metodo} <b>{total}</b>
            </span>)}
        </span>}
    </span>
    <span className="modulo-corpo">
      <span className="modulo-nome">
        {nome}
        {situacao && <span className="modulo-situacao">{situacao}</span>}
      </span>
      <span className="modulo-texto">{texto}</span>
    </span>
  </a>;

export const Modulos = ({children}) => <div className="modulos-grade not-prose">{children}</div>;

<span className="badge-v1">API v1</span>

A v1 é a API completa em produção do SULTS, com os 7 módulos da plataforma. É onde está quem já integra hoje.

<Note>
  Você está na documentação da **v1**. A [v2](/v2/introducao) é 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?](/geral/qual-versao-eu-uso).
</Note>

## O que a API v1 do SULTS cobre?

<Modulos>
  <Modulo nome="Unidades" icone="unidades" href="/v1/api-reference/unidades/listar-unidades" metodos={[["GET", 2]]} texto="Listar as unidades da rede e os colaboradores ativos" />

  <Modulo nome="Chamados" icone="chamados" href="/v1/api-reference/chamados/listar-chamados" metodos={[["GET", 2], ["POST", 1], ["PUT", 1]]} texto="Listar chamados e a timeline, criar e concluir chamado" />

  <Modulo nome="Checklist" icone="checklist" href="/v1/api-reference/checklist/listar-avaliacoes-de-checklist" metodos={[["GET", 6]]} texto="Listar avaliações, respostas, check-ins, check-outs e planos de ação" />

  <Modulo nome="Compras" icone="compras" href="/v1/api-reference/compras/listar-produtos" metodos={[["GET", 4], ["POST", 1], ["PUT", 3]]} texto="Listar pedidos e produtos, cadastrar e editar produto, editar pedido" />

  <Modulo nome="Implantação" icone="implantacao" href="/v1/api-reference/implantacao/listar-projetos-em-implantacao" metodos={[["GET", 2]]} texto="Listar projetos de implantação e as tarefas deles" />

  <Modulo nome="Projetos" icone="projetos" href="/v1/api-reference/projetos/listar-projetos" metodos={[["GET", 2]]} texto="Listar projetos e as tarefas deles" />

  <Modulo nome="Expansão" icone="expansao" href="/v1/api-reference/expansao/listar-negocios" metodos={[["GET", 2], ["POST", 1]]} texto="Listar negócios e a timeline, criar negócio" />
</Modulos>

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](/v2/introducao).

## Sua jornada até a produção

<Steps>
  <Step title="Faça a primeira chamada">
    Gere o token e liste as unidades da sua rede em 5 minutos no [quickstart](/v1/quickstart).
  </Step>

  <Step title="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](/v1/convencoes).
  </Step>

  <Step title="Prepare a integração para falhas">
    Trate os erros desde o início, com o catálogo em [Erros](/v1/erros).
  </Step>

  <Step title="Monte a sua sincronização">
    Mantenha o seu sistema atualizado com o padrão descrito em [Como manter os dados atualizados](/v1/convencoes#como-manter-os-dados-atualizados).
  </Step>

  <Step title="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](/v1/api-reference/unidades/listar-unidades).
  </Step>
</Steps>

## Próximos passos

<CardGroup cols={2}>
  <Card title="Comece em 5 minutos" icon="rocket" href="/v1/quickstart">
    Do token à primeira resposta, com exemplos em cinco linguagens.
  </Card>

  <Card title="Referência da API" icon="code" href="/v1/api-reference/unidades/listar-unidades">
    Os endpoints dos 7 módulos, com playground para testar do navegador.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.