Acesso à API: como obter a chave e o que pode fazer

O Teamopipe disponibiliza uma API REST para ler e escrever dados por código: criar negócios a partir de fontes externas, sincronizar contactos, exportar dados para relatórios e criar automações personalizadas.

Como obter a chave de API

1. Abra o painel do Teamopipe no Gmail e aceda a Definições → Definições do espaço de trabalho → Chaves de API.
2. Clique em Gerar chave, copie-a e guarde-a em segurança: ela só é apresentada uma vez.

A gestão de chaves está disponível apenas para administradores. Se não vir a opção, contacte o administrador do espaço de trabalho.

Como usar a chave

Inclua a chave no cabeçalho Authorization de cada pedido: Authorization: Bearer A_SUA_CHAVE_API. O URL base é api.teamopipe.com/api/v2 e a documentação interativa está em api.teamopipe.com/api/v2/docs.

O que a API abrange

• Negócios, contactos e organizações: criar, consultar, atualizar e eliminar; operações em massa, exportação CSV e sincronização.
• Funis e etapas: consultar funis e criar, reordenar ou mudar o nome das etapas.
• Campos personalizados: gerir definições, opções e valores de negócios, contactos e organizações.
• Tarefas, equipas e membros: gerir tarefas, consultar membros e convites e automatizar seguimentos.

Casos de uso comuns

Pode criar negócios a partir de formulários web, sincronizar contactos por e-mail, enviar dados para o Google Sheets ou uma ferramenta de BI e criar tarefas a partir de eventos como um contrato assinado ou um pagamento recebido.

Revogar uma chave

Aceda a Definições → Definições do espaço de trabalho → Chaves de API e elimine a chave. As integrações que a utilizam perdem o acesso de imediato.