Com a API REST da Papo, você pode listar as caixas de entrada existentes e criar novas conexões para canais como WhatsApp e Instagram — tudo por requisições autenticadas, sem abrir o painel. É a forma programática de provisionar canais de atendimento, integrar sistemas externos e manter a operação multicanal alinhada com a automação.
A API da Papo expõe recursos de caixas de entrada que permitem consultar a configuração atual e adicionar novos canais. Com isso, equipes de TI, integradores e revendedores white label conseguem gerenciar conexões em lote, replicar setups entre contas e automatizar a ativação de canais sem depender da interface.
Resumo das operações de caixa de entrada via API
| Operação | O que faz | Quando usar |
|---|---|---|
| Listar caixas | Retorna as caixas de entrada da conta, com o canal associado (WhatsApp, Instagram, e‑mail, etc.) e detalhes da configuração. | Auditar canais ativos, sincronizar com sistemas de monitoramento ou preparar migrações. |
| Criar caixa | Cria uma nova caixa de entrada, definindo o canal, nome e agentes que terão acesso. | Provisionar canais automaticamente ao integrar novos clientes, unidades ou marcas. |
Como funciona a autenticação da API
Todas as chamadas à API, inclusive a listagem de caixas, exigem a chave secreta da conta. Ela deve ser enviada como token Bearer no cabeçalho Authorization. A chave pública da conta é opcional, mas, se enviada, precisa corresponder à mesma conta da chave secreta.
A URL base da API é https://app.papo.global/api/v1. As chaves são geradas na área de desenvolvedor do painel da Papo. A chave secreta aparece uma única vez na criação; guarde‑a em local seguro e revogue se houver suspeita de vazamento.
Para validar a autenticação, você pode chamar o endpoint GET /api/v1/me, que retorna os dados da conta. O padrão de autenticação é o mesmo usado em todos os outros endpoints:
curl https://app.papo.global/api/v1/me \
-H "Authorization: Bearer sk_live_…" \
-H "X-Papo-Public-Key: pk_live_…"
Como gerenciar caixas de entrada na prática
- Acesse a área de desenvolvedor/API no painel da Papo e gere uma chave secreta. Copie também a chave pública da conta.
- Em cada requisição, autentique com a chave secreta como token Bearer. Se quiser reforçar a validação, envie a chave pública no cabeçalho
X-Papo-Public-Key. - Para listar as caixas de entrada, chame o endpoint de listagem de caixas. A resposta traz o identificador de cada caixa, o canal configurado e outras propriedades, permitindo mapear o que já existe antes de criar novas.
- Para criar uma nova caixa, envie um payload JSON com as informações do canal desejado — por exemplo, WhatsApp (API oficial da Meta), Instagram, e‑mail ou Telegram. Inclua o nome da caixa e os identificadores dos agentes que devem ter acesso. Consulte a documentação oficial para o formato exato dos campos e valores aceitos.
- Após a criação, a caixa fica disponível imediatamente no painel e começa a receber mensagens assim que a conexão do canal for concluída (no caso de canais que exigem pareamento, como WhatsApp, a API retorna as instruções necessárias).
Como a API é REST e utiliza JSON, qualquer linguagem com suporte a HTTP pode ser usada para integrar a gestão de caixas a scripts, ferramentas de automação (como n8n) ou sistemas de provisionamento. A documentação oficial em https://papo.global/pt/docs traz os detalhes de autenticação, parâmetros, respostas e exemplos de código.
Para quem essa integração faz sentido
- Equipes de TI que provisionam canais em lote para novas unidades, franquias ou marcas, sem precisar acessar o painel uma a uma.
- Revendedores white label que desejam automatizar a criação de caixas para cada novo cliente, mantendo a configuração padronizada.
- Operações que migram ou replicam configurações entre contas, usando a listagem para auditar e a criação para espelhar canais.
- Integradores que conectam a Papo a sistemas externos de gestão de canais, garantindo que o ambiente de atendimento reflita automaticamente as mudanças.
Perguntas frequentes
Preciso da chave secreta para listar as caixas de entrada?
Sim. A listagem de caixas exige autenticação com a chave secreta da conta, pois retorna informações sensíveis da configuração. O padrão é o mesmo das demais chamadas à API: envie o token Bearer no cabeçalho Authorization.
Posso criar uma caixa de entrada para WhatsApp via API?
Sim. Ao criar uma caixa, você informa o tipo de canal desejado — incluindo WhatsApp (API oficial da Meta) e outros canais suportados. O payload deve seguir o formato esperado para o canal escolhido, conforme a documentação oficial.
É possível atualizar uma caixa de entrada existente pela API?
A API atual permite listar e criar caixas de entrada. Para alterar configurações de uma caixa já existente (como trocar agentes ou renomear), você pode utilizar o painel da Papo ou, se necessário, recriar a caixa com os novos parâmetros.
Como associo agentes a uma caixa durante a criação?
No payload de criação, você pode informar os identificadores dos agentes que devem ter acesso à caixa. Esses IDs podem ser obtidos pela API de times e membros. Consulte a documentação para o formato exato.
A autenticação é a mesma usada em outros endpoints da Papo?
Sim. Todas as chamadas que acessam recursos da conta utilizam a chave secreta como token Bearer. A chave pública é opcional e, se enviada, precisa corresponder à mesma conta.
Onde encontro os caminhos exatos e o formato do payload?
Na documentação oficial da API, disponível em https://papo.global/pt/docs. Lá estão os detalhes de autenticação, parâmetros, respostas e exemplos de código para caixas de entrada e demais recursos.
Leia também
- Como usar a API da Papo para gerenciar times e membros
- Como usar a API da Papo para criar e gerenciar etiquetas (tags)
Comece a automatizar suas conexões agora mesmo →
Crie sua conta gratuita e integre canais via API sem abrir o painel.