🔌 Central de APIs da Empresa

Tutorial da Central de APIs — Compartilhe seus dados com segurança

Guia passo a passo, com telas reais, para ligar a API do seu ERP e dar acesso controlado aos seus dados — como para a sua contabilidade — sem mandar planilha e sem entregar a sua senha.

★Comece por aqui

A Central de APIs é o lugar onde você abre uma "porta" segura para outro sistema conversar com o seu ERP — o caso mais comum é dar acesso à sua contabilidade, para o contador buscar as notas e os lançamentos direto, sem você precisar exportar planilha toda hora. Você fica no controle de tudo: liga e desliga esse acesso quando quiser, escolhe quais áreas ficam visíveis, e pode deixar tudo como somente consulta (ninguém altera nada, só lê). O caminho natural é: primeiro ligar a API, depois escolher o que liberar, então criar uma chave para quem vai usar, guardar as credenciais, entregar a documentação pronta e, por fim, acompanhar o uso. Como chegar: menu Configurações → Central de APIs (endereço /configuracoes/api-keys/).

📌 O que é uma "API" e uma "chave"? API é só um jeito de dois programas trocarem informação automaticamente. A chave é como um cartão de acesso: quem tem a chave certa entra e vê o que você liberou — e você pode cancelar esse cartão a qualquer momento.
💡 Recomendação de ouro: deixe a trava Somente consultas ligada. Assim quem recebe a chave só consegue LER seus dados (notas, contas, produtos), nunca alterar nem apagar nada.
🔀 Veio parar aqui sem querer? Este é o tutorial da Central de APIs da Empresa — para você abrir os SEUS dados do ERP a um terceiro (ex.: sua contabilidade). Se o que você quer é consumir dados da DotCompany (catálogo, CEP, CNPJ, placa/FIPE) ou emitir notas por API no seu sistema, isso é a Plataforma de APIs → ver a Plataforma de APIs.
1Ligar a API (visão geral)

Esta é a tela principal da Central de APIs. No topo você tem a chave-mestra API ligada, que liga ou desliga de uma vez todo o acesso externo, e a trava Somente consultas, que garante que ninguém altera seus dados. Mais abaixo aparecem os números (quantas chaves você tem, quantas estão ativas, quantas áreas liberadas) e os botões para criar a primeira chave.

Visão geral da Central de APIs
📸 Visão geral da Central de APIs
  1. A chave-mestra API ligada liga ou desliga, de uma só vez, todo o acesso externo ao seu sistema.
  2. A trava Somente consultas deixa o acesso apenas de leitura (recomendado) — ninguém altera seus dados.
  3. O botão Criar chave para a contabilidade já vem pronto com o perfil ideal para o seu contador.
↗ Abrir esta tela no sistema
🔊 Ouvir esta seção

Passo a passo

  1. No menu lateral, abra Configurações e clique em Central de APIs.
  2. Confira a chave-mestra no topo: quando está API ligada (verde), o acesso externo está permitido; clicando nela você desliga tudo de uma vez.
  3. Deixe a trava Somente consultas ligada — é o modo seguro, em que quem tem a chave só lê seus dados.
  4. Observe os números: Chaves, Ativas, Módulos liberados e o Status (deve estar "Operacional").
💡 Enquanto a chave-mestra estiver desligada, nenhuma chave funciona — é o seu "botão de pânico". Se um dia quiser cortar todo o acesso externo na hora, é só desligar aqui.
2Escolher o que liberar

Antes de criar a chave, você decide QUAIS áreas do seu sistema ficam visíveis pela API. Cada cartão é uma área — Contas e PIX, Notas fiscais, Vendas, Produtos, Pessoas e assim por diante — com um resumo do que ela compartilha. Você libera só o que faz sentido (para o contador, por exemplo, bastam Notas fiscais e Contas/financeiro), ou usa o botão Liberar todos para abrir todas de uma vez. O selo verde liberado confirma que aquela área está disponível.

Escolher o que liberar (cartões de área)
📸 Escolher quais áreas ficam acessíveis
  1. Cada cartão é uma área do sistema (aqui, Notas fiscais) com o resumo do que ela compartilha pela API.
  2. O selo verde liberado mostra que a área está disponível; use o botão Liberar todos para abrir tudo de uma vez.
↗ Abrir esta tela no sistema
🔊 Ouvir esta seção

Passo a passo

  1. Na mesma tela da Central de APIs, role até O que você libera.
  2. Leia os cartões: cada um explica o que aquela área deixa o outro sistema consultar.
  3. Para dar acesso à contabilidade, clique em Liberar todos (libera todas as áreas de uma vez) — a chave que você criar no próximo passo já vem limitada ao que o contador precisa.
  4. Confirme que as áreas ficaram com o selo verde liberado.
  5. Mantenha a trava Somente consultas ligada, para que tudo continue sendo apenas leitura.
📌 "Liberar" uma área só a deixa DISPONÍVEL. Quem realmente enxerga cada área é a chave — e no próximo passo você cria uma chave já limitada ao que o contador precisa. Liberar tudo aqui não significa que a chave verá tudo.
💡 Prefere liberar pouco? Sem problema: com a contabilidade, o essencial são as Notas fiscais e o financeiro (Contas, PIX e boletos). O resto pode ficar de fora.
3Criar a chave da contabilidade

Agora você cria a chave que o contador vai usar. O sistema já traz um modelo pronto — Contabilidade (recomendado) — que deixa a chave só de leitura, ideal para o contador. Você dá um nome para lembrar de quem é a chave, confere o que ela pode fazer (por área, escolhendo entre "Sem acesso", "Só consultar" e "Consultar e alterar") e define limites e validade.

Formulário de nova chave, modelo Contabilidade
📸 Nova chave — modelo Contabilidade
  1. Escolha o modelo Contabilidade (recomendado): já configura a chave como somente leitura, ideal para o contador.
  2. Dê um nome para a chave (ex.: "Escritório Contábil Silva") — serve só para você lembrar de quem é.
  3. Confira o acesso por área: Só consultar deixa a chave apenas ler aquela área (aqui, Notas fiscais).
↗ Abrir esta tela no sistema
🔊 Ouvir esta seção

Passo a passo

  1. Na Central de APIs, clique no botão Criar chave para a contabilidade.
  2. No topo, deixe selecionado o modelo Contabilidade (recomendado).
  3. Preencha o Nome da chave com algo que ajude a lembrar para quem é (o nome do escritório, por exemplo).
  4. Em O que esta chave pode fazer, confira que cada área está em Só consultar (apenas leitura).
  5. Se quiser, ajuste em Limites e validade o número de consultas por mês e a data em que a chave expira.
  6. Clique em Criar chave (o botão de confirmar, no alto à direita).
💡 Definir uma validade (por exemplo, 1 ano) é uma boa prática: passado o prazo, a chave para sozinha e você renova só se ainda precisar.
4Guardar as credenciais

Assim que a chave é criada, o sistema mostra as duas credenciais dela: a Chave (X-API-Key) e o Segredo (X-API-Secret). Muita atenção: o segredo aparece uma única vez. Copie ou baixe o arquivo agora e guarde em local seguro. Por segurança, o segredo NÃO deve ser enviado por e-mail nem WhatsApp — o jeito certo de entregar o acesso vem no próximo passo.

Tela do segredo da chave (aparece uma única vez)
📸 Chave criada — guarde o segredo
  1. Aqui ficam a Chave e o Segredo. O segredo (em vermelho) aparece uma única vez — depois some para sempre.
  2. Use Baixar credenciais (.txt) para salvar tudo num arquivo, ou o ícone de copiar ao lado de cada campo.
  3. Depois de salvar, clique em Gerar link da documentação para preparar o acesso do contador (próximo passo).
↗ Abrir esta tela no sistema
🔊 Ouvir esta seção

Passo a passo

  1. Na tela "Chave criada", clique em Baixar credenciais (.txt) e guarde o arquivo num lugar seguro (não em pasta compartilhada aberta).
  2. Se preferir, use o ícone de copiar ao lado da Chave e do Segredo e cole num gerenciador de senhas.
  3. Confira que você salvou o Segredo — ele é o único que não pode ser recuperado depois.
  4. Só então siga para gerar a documentação (próximo passo) — é assim que o contador recebe o acesso com segurança.
⚠️ Nunca mande o Segredo por e-mail, WhatsApp ou chat. Se ele vazar, qualquer um com o segredo pode consultar seus dados. Guarde-o como você guarda a senha do banco.
📌 Perdeu o segredo? Não tem problema grave: na lista de chaves você pode gerar um novo segredo a qualquer momento (o antigo deixa de valer na hora).
5Entregar a documentação ao contador

Em vez de explicar tudo para o contador, o próprio sistema monta uma página de documentação pronta e sempre atualizada, só com as áreas que você liberou. Você gera um link e envia — e o melhor: essa página mostra a Chave, mas nunca o Segredo (aparece só o texto "SEU_SECRET" no lugar). Assim o contador tem tudo o que precisa para conectar as ferramentas dele (Excel, Power BI, Postman) sem risco de vazar o segredo.

Página pública de documentação para a contabilidade
📸 Página de documentação para a contabilidade
  1. O topo mostra para quem é a página e que ela é gerada automaticamente e sempre atualizada.
  2. Traz a Chave, o endereço base e como se identificar — com o Segredo escondido (só "SEU_SECRET"), seguro para compartilhar.
↗ Abrir esta tela no sistema
🔊 Ouvir esta seção

Passo a passo

  1. Na tela do segredo (passo 4) clique em Gerar link da documentação; ou, na Central de APIs, use o cartão Página pronta pra contabilidade → Copiar link.
  2. Copie o link gerado (ele abre uma página pública, sem login, só com o que você liberou).
  3. Envie esse link ao seu contador (pode ser por e-mail/WhatsApp — o link é seguro, não contém o segredo).
  4. Entregue o Segredo por um caminho separado e seguro (em pessoa, por telefone ou por um gerenciador de senhas).
  5. Pronto: o contador usa a página como manual para conectar as ferramentas dele aos seus dados.
💡 A documentação é "viva": se amanhã você liberar mais uma área, a mesma página passa a mostrá-la automaticamente. Não precisa gerar link novo.
6Acompanhar suas chaves

Toda chave que você cria aparece na lista Suas chaves, na própria Central de APIs. Ali você vê o ambiente, quanto ela já foi usada no mês, o último uso e o status (Ativa ou Revogada). Em cada linha há botões para ver a atividade (o que a chave andou consultando), testar, compartilhar a documentação, editar, gerar um novo segredo e revogar (cancelar) a chave.

Lista Suas chaves com uso e ações
📸 Suas chaves — uso e ações
  1. O cartão Página pronta pra contabilidade → Copiar link gera de novo o link da documentação quando você precisar.
  2. O ícone de atividade mostra o histórico de uso da chave — o que ela consultou e quando.
  3. O ícone de lixeira revoga (cancela) a chave: ela para de funcionar na hora.
↗ Abrir esta tela no sistema
🔊 Ouvir esta seção

Passo a passo

  1. Na Central de APIs, role até Suas chaves para ver todas as chaves criadas.
  2. Confira o uso do mês e o último uso de cada chave — bom para saber se o contador já começou a usar.
  3. Clique no ícone de atividade (o gráfico) para ver o histórico de consultas daquela chave.
  4. Precisa trocar o segredo? Use o ícone de gerar novo segredo — o antigo deixa de valer na hora.
  5. Quando um acesso não for mais necessário, use o ícone de lixeira para revogar a chave; ela para de funcionar imediatamente.
📌 Revogar é definitivo, mas não apaga nada dos seus dados: só desliga aquele "cartão de acesso". Se precisar de novo depois, é só criar outra chave.
📖Dicionário rápido

Alguns termos que aparecem na Central de APIs, em português simples:

API — um jeito de dois sistemas conversarem sozinhos, sem ninguém digitar. É por ela que o sistema do contador busca seus dados.
Chave (X-API-Key) — o "usuário" do acesso. Pode aparecer na documentação; identifica quem está consultando.
Segredo (X-API-Secret) — a "senha" do acesso. Aparece uma única vez, é secreto e nunca deve ser compartilhado.
Somente consultas — trava que deixa o acesso apenas de leitura: quem usa a chave só vê seus dados, nunca altera.
Liberar / Módulos liberados — as áreas do sistema (notas, financeiro, produtos...) que você deixou disponíveis para a API.
Revogar — cancelar uma chave. Ela para de funcionar na hora; seus dados continuam intactos.
Quota / Consultas por mês — o limite de vezes que a chave pode ser usada no mês. Serve para evitar uso excessivo.
💡 Ficou com dúvida em alguma tela? Toque no botão IA dentro do sistema: ele explica a tela em que você está e leva direto ao passo certo deste tutorial.