> For the complete documentation index, see [llms.txt](https://edu.sittax.com.br/sittax-base-conhecimento/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://edu.sittax.com.br/sittax-base-conhecimento/base-tecnica/integracoes/api-de-integracao.md).

# API de Integração

Permite que um sistema externo, do escritório ou de um parceiro, consulte automaticamente os dados de apuração do Simples Nacional das empresas ativas deste escritório. Não é necessário exportar planilhas manualmente.

### Quando utilizar

Utilize esta integração quando o escritório, ou alguém contratado por ele, conectar um sistema próprio, ERP ou ferramenta de terceiros aos dados de apuração do Sittax.

{% hint style="info" %}
Esta é a primeira etapa da integração. Ela cobre apenas a consulta de apuração. O Relatório de Conferência em Excel e o cadastro de empresa por integração ainda não fazem parte deste fluxo.
{% endhint %}

### Como gerar a chave

{% stepper %}
{% step %}

#### Acesse a aba de integração

<figure><img src="https://2688983956-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOLejyHkoluGzXQSWUsNa%2Fuploads%2Fu40VmJ2PqBJV35u1hnV2%2Fapi-integracao-01-onde-encontrar.png?alt=media&amp;token=0c32430f-1020-479d-9577-0d12535c56a1" alt=""><figcaption></figcaption></figure>

No cadastro do escritório, acesse **Dados do Escritório → API de integração**.
{% endstep %}

{% step %}

#### Crie a chave de acesso

Clique em **Criar chave de integração**. O sistema gera a chave e a exibe uma única vez.
{% endstep %}

{% step %}

#### Guarde a chave

<figure><img src="https://2688983956-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOLejyHkoluGzXQSWUsNa%2Fuploads%2F3OxeQ6ZIZCWZPo4dtElq%2Fapi-integracao-02-chave-criada.png?alt=media&amp;token=9384f9bf-a4d4-4bf4-bd18-ba397533e37c" alt=""><figcaption></figcaption></figure>

Copie a chave exibida. Ela não volta a ser mostrada automaticamente depois disso. Use **Copiar chave** para recuperá-la mais tarde.
{% endstep %}

{% step %}

#### Repasse para quem fará a integração

Entregue a chave à equipe de TI ou ao fornecedor que consumirá os dados.
{% endstep %}
{% endstepper %}

### O que a chave entrega

Por CNPJ e competência, a API devolve:

* Receita líquida e faturamento do período.
* RBT12, receita bruta acumulada dos últimos 12 meses, e Fator R, quando aplicável.
* Valor do DAS, alíquota efetiva aplicada e economia Sittax do período.
* Cada imposto do cálculo: ICMS, PIS e COFINS, IRPJ, CPP, CSLL, IPI e ISS.
* Para ICMS e PIS/COFINS, os valores do Sittax e do XML aparecem lado a lado. Para os demais impostos, a API retorna apenas o valor final.
* Quando a empresa possui filiais, a resposta separa os resultados da matriz e de cada filial.
* Se a competência não tiver apuração transmitida, a resposta informa essa condição. Nenhum valor é retornado.

Nenhum outro dado do escritório, de outros clientes ou de outras telas do sistema fica acessível com esta chave.

### Gerenciando a chave

* **Copiar chave:** exibe novamente a chave completa a qualquer momento.
* **Desativar / Reativar:** pausa ou retoma o uso sem invalidar a chave.

<div><figure><img src="https://2688983956-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOLejyHkoluGzXQSWUsNa%2Fuploads%2FmF8NIMvE6aw19JvMViwG%2Fapi-integracao-03-chave-desativada.png?alt=media&amp;token=8ce0105f-7e4b-4183-b6d2-e8929c1c81c4" alt=""><figcaption></figcaption></figure> <figure><img src="https://2688983956-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOLejyHkoluGzXQSWUsNa%2Fuploads%2Fqi93mrhjdaBrj3MONqdv%2Fapi-integracao-04-chave-reativada.png?alt=media&amp;token=341b9f76-c27e-4215-9781-73e36a99b57c" alt=""><figcaption></figcaption></figure></div>

* **Revogar chave:** encerra o acesso imediatamente e de forma definitiva. Para integrar novamente, gere uma nova chave e atualize-a no sistema do parceiro.

<div><figure><img src="https://2688983956-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOLejyHkoluGzXQSWUsNa%2Fuploads%2FEtS11BphSOncxyvcCP1m%2Fapi-integracao-05-tela-revogar.png?alt=media&amp;token=31fbd48a-a904-4f65-9e30-a5647f9425cf" alt=""><figcaption></figcaption></figure> <figure><img src="https://2688983956-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOLejyHkoluGzXQSWUsNa%2Fuploads%2FUBKvMTtX2bCgZfrpHuzQ%2Fapi-integracao-06-chave-revogada.png?alt=media&amp;token=631a96a5-932c-4c67-83c6-0963fbf6b3ef" alt=""><figcaption></figcaption></figure></div>

### O que esta integração não faz

* Não substitui o Relatório de Conferência em Excel.
* Não cadastra empresas nem envia certificados digitais.
* Não busca várias empresas de uma vez. Cada consulta usa uma empresa e uma competência.
* Não possui validade automática. A chave permanece válida até ser revogada.

### Observações importantes

* Cada escritório pode ter apenas uma chave ativa por vez.
* A chave acessa empresas ativas do escritório e dos escritórios vinculados a ele, os filhos.
* Trocar a chave interrompe a integração até o sistema de destino receber a nova chave.

### Suporte sobre integrações de terceiros

Dúvidas sobre a configuração ou o uso dos dados no sistema de destino devem ser tratadas com o fornecedor desse sistema. A Sittax não realiza suporte sobre sistemas de terceiros.

O suporte Sittax garante o funcionamento da chave e a correção dos dados entregues.