Referência da API

Além da interface, o TKDASH expõe uma API. Ela é o caminho para levar o dado para fora — para um BI próprio, um data warehouse ou qualquer sistema que precise consumir a operação.

A referência

A documentação técnica completa, com todos os endpoints, parâmetros e formatos de resposta, fica em:

api.sync.tkdash.com.br/reference

É uma referência interativa: dá para ver cada endpoint e o formato exato da resposta sem escrever código antes.

Autenticação

O acesso é por chave de API, criada em Configurações. Como criar, guardar e revogar está em Chaves de API.

Dois pontos que costumam pegar quem está integrando pela primeira vez:

• A chave aparece uma única vez, na tela de resultado da criação. Guarde naquele momento.
• Uma chave por integração. Compartilhar entre sistemas impede revogar um sem derrubar os outros.

Isto não é o sincronizador

Vale separar duas coisas que às vezes se confundem:

• O sincronizador leva o dado do seu ERP para o TKDASH. Ele já roda na sua operação e você não precisa programar nada para isso — veja De onde vem o dado.
• A API leva o dado do TKDASH para outro sistema. É o caminho de saída, e é o que esta página trata.

Se o que você quer é conectar um ERP novo ao TKDASH, o assunto é o sincronizador e o caminho é falar com o suporte, não integrar por conta própria.

Um lembrete de escopo

O que a API devolve respeita o mesmo recorte da interface: empresa e período. Uma integração que puxa "tudo" sem informar a empresa recebe a rede inteira consolidada — o mesmo comportamento do "Todas as empresas" do seletor. Veja Empresas e lojas.