Pular para o conteúdo
Central de Ajuda / Integrações / Chave de API: conectar um sistema ao Hub
Guia da ferramenta

Chave de API: conectar um sistema ao Hub

Crie uma chave com o acesso do tamanho certo, guarde o segredo, consulte a documentação de cada app e revogue quando a integração sair do ar.

Disponível em: Disponível a partir do plano Colaborador Atualizado em 2026-10-16
Guias do Conta e plataforma 2

Etapa 1 de 4

Primeiro uso: crie a chave

Dê um nome que diga onde a chave é usada e o acesso do tamanho certo.

  1. Em Configurações, no grupo Desenvolvimento, clique em API.

  2. Clique em Criar chave de API. Abre a janela Nova chave de API.

  3. Em Nome da chave, diga onde ela é usada, no estilo Integração do ERP.

  4. Em Acesso, escolha Somente leitura, Operação ou Personalizado. No Personalizado, marque o nível app por app: Sem, Leitura, Operar ou Total.

  5. Em Expira em, deixe 90 dias (recomendado) ou escolha outra validade.

  6. Clique em Criar chave.

Etapa 2 de 4

Primeiro uso: copie a chave secreta agora

O segredo aparece uma vez só. Copie e guarde no cofre da empresa.

  1. Criar chave é ação sensível: se o Hub pedir, confirme na janela Confirme sua identidade, aqui com a passkey.

  2. A janela Chave criada mostra a chave secreta uma única vez. Copie agora.

  3. Em Configure seu cliente, o exemplo já leva a chave e a organização.

  4. Clique em Ver conexão. A chave aparece na lista com o nome e o acesso escolhidos.

Etapa 3 de 4

Consulte a documentação de cada app

A documentação mostra só o que uma chave alcança, app por app.

  1. Na barra da lista, clique em Documentação. Abre a janela Documentação das APIs.

  2. Em Buscar API, digite o nome do app.

  3. Clique em Docs para abrir a documentação daquele app.

  4. A documentação lista só as operações que uma chave alcança, com o método e o caminho de cada uma.

Etapa 4 de 4

Administre o que existe

Acompanhe as chaves e revogue o que não está mais em uso.

  1. Quem administra a organização filtra entre Todas as chaves e Só minhas.

  2. Clique na chave para ver Atividade, Visão geral e Acessos.

  3. A Visão geral mostra o responsável, quando a chave foi criada, quando expira e o último uso.

  4. Revogar derruba o acesso na hora, mantendo o histórico. Aqui o aviso aparece e a chave segue ativa.

Precisa de mais? Abra um chamado dentro do Hub.

Ler este passo a passo em texto

Quando um sistema da sua empresa precisa ler ou escrever no Hub sem uma pessoa na frente, ele não usa login: usa uma chave de API. A chave carrega um acesso que você define app por app, tem validade, e pode ser revogada a qualquer momento sem mexer na conta de ninguém.

O que é e quando usar

Use uma chave de API paraUse outra coisa para
Um sistema seu ler ou gravar dados no HubUma pessoa acessar o Hub: isso é conta e senha
Uma integração rodar sem ninguém logadoUm assistente de IA operar o Hub por você: isso é a conexão MCP
Dar acesso limitado a um fornecedor de tecnologiaAutomatizar entre apps do próprio Hub: isso são as Automações

O que as chaves de API entregam hoje:

TrabalhoO que dá para fazer
Liberar com recorteNível geral de acesso, ou escolha app por app entre Sem, Leitura, Operar e Total
IdentificarNome próprio por chave, para saber onde ela é usada sem abrir a integração
Limitar no tempoValidade de 7 dias a 1 ano, ou sem expiração
AcompanharLista com o responsável, os apps alcançados, a situação e o último uso
Cortar o acessoRevogar na hora, mantendo o histórico, ou excluir o registro de uma chave já revogada
Consultar o contratoBotão Documentação, com os apps que aceitam chamada por chave e a documentação de cada um

Conceitos e acesso

TermoO que éOnde aparece
Chave de APIA credencial que um sistema usa no lugar de loginLista Chaves de API, em Configurações > Desenvolvimento > API
AcessosOs apps que a chave alcança e o nível em cada umColuna Acessos, na lista
NívelO quanto a chave pode fazer: Sem, Leitura, Operar ou TotalMatriz app por app, na criação
Expira emA validade da chave. Depois dela, a chave para de funcionarNa criação e na Visão geral da chave
SituaçãoSe a chave está Ativa, Expirada ou RevogadaColuna Situação, na lista
Documentação das APIsA lista dos apps que aceitam chamada por chaveBotão Documentação, na barra da lista

Onde fica. Em Configurações > Desenvolvimento > API. A barra da lista tem a busca, o filtro, o botão Documentação e o botão Criar chave de API. As conexões de assistente de IA ficam ao lado, em Configurações > Desenvolvimento > MCP.

Não confunda com a chave do MDC. A chave desta tela dá acesso aos apps do Hub. O Marvee Data Connection tem chaves próprias, que servem para consumir os endpoints publicados sobre os seus bancos e APIs, pelo gateway dele. São duas coisas separadas, com telas separadas: veja Limitar o alcance de uma chave de API do MDC quando o assunto for endpoint de dados.

Acesso. O recurso está disponível a partir do plano Colaborador, e a área de Desenvolvimento só abre com o seu e-mail confirmado. Se ainda não estiver, a tela mostra “Confirme seu e-mail para liberar chaves de API e conexões MCP” e o botão Confirmar e-mail. Criar chave é uma ação sensível: o Hub pede uma confirmação a mais na hora, na janela Confirme sua identidade. Quem administra a organização enxerga as chaves de todo mundo e pode filtrar entre Todas as chaves e Só minhas.

Primeiro uso: crie a chave

  1. Abra Configurações e, no grupo Desenvolvimento, clique em API.
  2. Clique em Criar chave de API. Abre a janela Nova chave de API.
  3. Dê um Nome da chave que diga onde ela é usada, no estilo “Integração do ERP”. Quando existirem seis chaves, é esse nome que evita revogar a errada.
  4. Em Acesso, escolha o nível. Você pode aplicar um nível geral ou ajustar app por app:
NívelO que a chave pode
Somente leituraConsulta o que dá para liberar sem revisar. Não escreve nada
OperaçãoTodos os acessos que você pode conceder: leitura e escrita, incluindo as ações sensíveis
PersonalizadoVocê escolhe o nível app por app, entre Sem, Leitura, Operar e Total

Painel Nova chave de API, com o campo de nome, os três níveis de acesso e a matriz de permissão app por app

  1. Em Expira em, deixe 90 dias (recomendado) ou escolha outra validade: 7 dias, 30 dias, 1 ano ou Sem expiração. Prefira sempre uma validade: a chave que expira sozinha não fica esquecida ligada.
  2. Clique em Criar chave. Se o Hub pedir, confirme sua identidade na janela Confirme sua identidade, com a passkey, o app autenticador, a senha ou o código por e-mail, conforme o que a sua conta tiver.

Primeiro uso: copie a chave secreta agora

  1. A janela Chave criada mostra a chave secreta com o aviso “Esta é a única vez que você vai ver a chave secreta.” Clique no botão de copiar ao lado dela.
  2. Guarde a chave no cofre de senhas da empresa ou nos segredos do sistema que vai usá-la, nunca em conversa nem em planilha.
  3. Em Configure seu cliente, os trechos de exemplo já trazem a chave e a organização. Use Copiar exemplo REST para levar a configuração para a integração.
  4. Clique em Ver conexão. A chave aparece na lista com o nome e o acesso que você escolheu.

Consulte a documentação de cada app

Na barra da lista, clique em Documentação. Abre a janela Documentação das APIs, com os apps que aceitam chamada por chave. Em Buscar API, digite o nome do app e abra a documentação dele. Ela mostra apenas as operações que uma chave consegue alcançar, então o que aparece ali é o que dá para integrar de verdade.

A chamada é autenticada com a chave no cabeçalho de autorização, e o app precisa saber em qual organização trabalhar. Os campos exatos ficam na documentação de cada app, que é a fonte a seguir na hora de escrever a integração.

Administre o que existe

Na lista de chaves você acompanha nome, responsável, o acesso que cada uma carrega, a situação e o último uso. Quem administra a organização enxerga as chaves de todo mundo e pode filtrar entre Todas as chaves e Só minhas.

Clique numa chave para abrir a janela dela, com as abas Atividade, Visão geral e Acessos. A Visão geral mostra o responsável, quando a chave foi criada, quando expira e o último uso.

Duas ações importam:

  • Revogar derruba o acesso na hora. O Hub avisa: “A chave perderá o acesso imediatamente. O histórico continuará disponível por até 90 dias.” e pede a confirmação em Revogar chave.
  • Excluir aparece na chave que já não está ativa e remove o registro.

Revogue sempre que a integração sair do ar, que o fornecedor mudar, ou na menor suspeita de que a chave vazou. Não existe motivo para manter chave sem uso.

Como saber que deu certo

  • A chave aparece na lista com o nome e o acesso que você escolheu, na situação Ativa.
  • A primeira chamada do sistema externo responde com dado em vez de recusa, e a coluna Último uso passa a mostrar a data.
  • Depois de revogar, a mesma chamada passa a ser recusada.

Limites e erros comuns

ExpectativaRealidade hoje
Dá para ver a chave secreta depoisNão. Ela aparece uma vez, na janela Chave criada. Perdeu, crie outra
A chave alcança tudo o que eu alcançoNão. Ela alcança o que foi liberado nela, e nem todo app aceita chamada por chave
A chave parou de funcionar sozinhaEla expirou. A janela da chave mostra Expirada e “Esta chave expirou. Crie uma nova chave para retomar a integração.”
Dá para mudar o acesso de uma chave que já existeNão. Para mudar os acessos, revogue e crie outra
Uma chave serve para conectar o Claude ou o ChatGPTPara assistente de IA existe a conexão MCP, ao lado, em Desenvolvimento
Renomear a chave troca a chave secretaNão. A chave secreta continua a mesma
A chave continua valendo se a pessoa sair da empresaTrate cada chave como acesso da empresa e revise a lista quando alguém sair

Erros comuns de quem começa: criar uma chave com acesso total porque é mais rápido, escolher Sem expiração sem motivo, e nomear a chave de “teste”, o que garante que ninguém saiba se pode revogar.

Próximo passo