Para começar a usar a API da Papo Global (https://papo.global/), você precisa gerar uma chave secreta no painel, autenticar as requisições com o cabeçalho Authorization e fazer chamadas REST para a base https://app.papo.global/api/v1. O primeiro teste prático é listar contatos do Extrator com um simples comando cURL.
A API da Papo é REST, usa JSON e aceita requisições de qualquer origem (CORS liberado). Com ela você conecta CRMs, plataformas de automação (como n8n), ERPs ou seu próprio backend ao ecossistema de atendimento, vendas e IA da Papo.
Resumo dos elementos essenciais
| Elemento | Descrição |
|---|---|
Chave pública (pk_live_…) |
Identificador fixo da sua conta, pode ser exposta no front-end |
Chave secreta (sk_live_…) |
Token de autenticação, deve ser mantido em segredo e usado apenas no servidor |
| Autenticação | Header Authorization: Bearer sk_live_... (ou X-Papo-Secret-Key) em todas as chamadas exceto GET /api/v1 |
| Base URL | https://app.papo.global/api/v1 |
| Endpoint de exemplo | GET /api/v1/contacts — lista contatos extraídos (Extrator), com paginação |
Passo a passo para a primeira chamada
1. Crie suas chaves de API
Acesse a página de desenvolvedores no painel da Papo (disponível em app.papo.global/developers). Lá você pode gerar uma chave secreta nomeada — por exemplo, “primeiro-teste” — e copiá-la imediatamente. A chave é exibida uma única vez; depois disso você só poderá revogá-la e criar outra.
A chave pública (pk_live_…) é fixa por conta e fica visível nessa mesma página a qualquer momento. Embora opcional nas requisições, se você a enviar, ela precisa estar associada à mesma conta da chave secreta.
2. Escolha o endpoint
Para este guia, usaremos GET /api/v1/contacts, que lista os leads extraídos pelo módulo Extrator. Você pode paginar os resultados com os parâmetros page (padrão 1) e per_page (1 a 100, padrão 20). Uma consulta de texto com q também é aceita para buscar por empresa, telefone ou e-mail.
3. Faça a chamada com cURL
Com a chave secreta em mãos, monte a requisição. O exemplo a seguir lista até 20 contatos:
curl "https://app.papo.global/api/v1/contacts?page=1&per_page=20" \
-H "Authorization: Bearer sk_live_…"
Substitua sk_live_… pela sua chave secreta. Se quiser usar o cabeçalho alternativo, faça:
curl "https://app.papo.global/api/v1/contacts" \
-H "X-Papo-Secret-Key: sk_live_…"
A resposta é um JSON com success: true e os dados dentro do objeto data. Se houver erro, o JSON trará success: false e um objeto error com código e mensagem explicativos.
A partir daqui, você pode explorar outros endpoints documentados na página da API, como envio de mensagens (POST /api/v1/messages), detalhes da conta (GET /api/v1/me) ou completar textos com a IA (POST /api/ai/v1/complete).
Para quem é este guia
Este conteúdo é voltado para desenvolvedores que desejam integrar a Papo com sistemas externos — CRMs, ferramentas de automação (n8n, por exemplo) ou aplicações próprias. Se você é usuário final que quer apenas conectar canais e atender, a Central de Ajuda oferece outros artigos mais adequados.
Perguntas frequentes
Preciso enviar a chave pública em todas as chamadas?
Não. A chave pública é opcional. Se você optar por enviá-la, ela deve combinar com a conta da chave secreta usada.
A chave secreta expira?
Não expira automaticamente. Você pode revogá-la a qualquer momento pelo painel e criar uma nova, caso suspeite de vazamento.
Posso testar a API com uma conta gratuita?
Sim. O primeiro usuário da Papo é gratuito e você pode gerar chaves para explorar a API. Acessos a módulos como Extrator podem consumir saldo conforme o uso, mas a criação das chaves e chamadas básicas de leitura são testáveis sem custo adicional.
O que fazer se eu perder a chave secreta?
Crie uma nova chave nomeada no painel de desenvolvedores. A chave anterior não poderá ser recuperada; apenas revogada para segurança.
Posso usar a API para enviar mensagens em massa?
Sim, o endpoint POST /api/v1/messages permite enviar mensagens de texto. No entanto, respeite as políticas de consentimento e os termos de uso da plataforma.
A API lista apenas contatos do Extrator?
O endpoint GET /api/v1/contacts retorna os contatos extraídos. Para gerenciar a base unificada do CRM (buscar, criar e atualizar qualquer contato), você pode consultar a documentação completa da API.
Leia também: Como usar a API da Papo para criar um formulário de cadastro e popular o CRM automaticamente · Como usar a API da Papo para monitorar consumo de créditos e faturas da revenda white label
Comece grátis no Papo Global →
Primeiro usuário R$ 0, sem cartão. Saiba mais em papo.global.