Acesso à API: obtendo sua chave e o que você pode fazer com ela
O Teamopipe tem uma REST API para ler e gravar seus dados — crie negócios a partir de fontes externas, sincronize contatos com outras ferramentas ou extraia dados para relatórios. O acesso à API está incluído em todos os planos.
Criar uma chave de API
- Vá para Configurações → Integrações.
- Em API keys, clique em Create new key.
- Dê um nome que identifique a integração e revise o escopo e o aviso exibidos pelo Teamopipe.
- Copie a chave e guarde-a em um cofre de segredos ou gerenciador de senhas.
Apenas administradores do espaço de trabalho podem gerenciar chaves de API. Nunca cole uma chave em e-mails, chats, tickets, código-fonte ou capturas de tela, e use uma chave por integração.
Use a chave
Envie a chave no cabeçalho Authorization: Authorization: Bearer SUA_CHAVE_DE_API. A URL base é api.teamopipe.com/api/v2. A documentação interativa completa está em api.teamopipe.com/api/v2/docs.
Teste com segurança
- Faça primeiro uma chamada de leitura, como listar pipelines.
- Se ela retornar seus dados, a chave funciona.
- Só então tente uma gravação com um registro claramente fictício e exclua-o depois.
O que a API cobre
- Negócios — criar, ler, atualizar, excluir; criação em massa, movimentação entre etapas, atualização de campos personalizados e exportação CSV.
- Contatos — CRUD completo, criação em massa e upsert por endereço de e-mail.
- Organizações — CRUD completo com operações em massa e exportação CSV.
- Pipelines e etapas — ler pipelines; criar, reordenar e renomear etapas.
- Campos personalizados — criar e gerenciar campos (chamados de campos dinâmicos na API) e definir seus valores.
- Tarefas — CRUD completo com operações em massa e exportação CSV.
- Equipes e membros — ler dados de equipes e membros e gerenciar convites.
Problemas comuns
- Requisições rejeitadas: a chave foi copiada de forma incompleta ou foi excluída.
- Nada é criado: confira os campos obrigatórios e os ids na documentação interativa.
Revogar uma chave
Vá para Configurações → Integrações → API keys e exclua a chave. Tudo que usa essa chave perde o acesso imediatamente.
Prefere sem código? Use o Zapier. Quer trabalhar com seu CRM pelo Claude ou pelo ChatGPT? Veja o Teamopipe MCP — ele não precisa de chave de API; usa o login e a aprovação do espaço de trabalho.
Artigos relacionados: endpoints da API disponíveis, como manter suas chaves de API seguras.
Se você tem perguntas sobre a API, use o chat no canto inferior direito ou o formulário de contato — normalmente respondemos dentro de 4 horas em dias úteis.