Com a API REST da Papo, você pode automatizar a administração de equipes sem abrir o painel: listar times, criar times, listar membros de um time, adicionar usuários a um time e listar ou criar caixas de entrada. É a forma programática de manter a estrutura de atendimento sincronizada com sistemas externos, grandes operações e revendas white label.
A API da Papo expõe recursos de times e caixas com a mesma autenticação dos demais endpoints da plataforma. Com eles, sua equipe consegue provisionar novas estruturas, auditar quem faz parte de cada grupo e preparar o roteamento de conversas sem intervenção manual no painel.
Resumo das operações de times e membros via API
| Operação | O que faz | Quando usar |
|---|---|---|
| Listar times | Retorna os times cadastrados na conta. | Auditar a estrutura antes de criar um novo time. |
| Criar time | Cria um time com nome e descrição opcional. | Provisionar uma nova equipe via script, ERP ou CRM. |
| Listar membros de um time | Retorna os usuários que fazem parte daquele time. | Conferir quem está incluído e evitar acessos incorretos. |
| Adicionar usuários ao time | Inclui um ou mais usuários informando os IDs separados por vírgula. | Sincronizar o time com o quadro atual de agentes. |
| Listar caixas | Retorna as caixas com o canal, na visão de administrador. | Conferir canais disponíveis e como estão organizados. |
| Criar caixa de entrada | Cria uma nova caixa de entrada. | Provisionar novos canais junto com a estrutura de times. |
Como funciona a autenticação da API
As operações de escrita, incluindo as de times e membros, exigem a chave secreta da conta. Ela deve ser enviada como token Bearer no cabeçalho de autorização. 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.
Passo a passo para gerenciar times e membros via API
- Acesse a área de desenvolvedor/API no painel da Papo e gere uma chave secreta. Copie também a chave pública da conta se quiser validação adicional.
- Em cada requisição, autentique com a chave secreta como token Bearer. Se reforçar a validação, envie a chave pública no cabeçalho indicado na documentação.
- Liste os times existentes para mapear a estrutura atual antes de criar novos.
- Crie um time enviando um payload JSON com nome e, se necessário, descrição. Consulte a documentação oficial para o formato exato.
- Liste os membros do time para auditar quem já está incluído e evitar duplicidade.
- Adicione usuários ao time informando os IDs separados por vírgula. Esse passo sincroniza o time com o quadro atual de agentes.
- Liste as caixas de entrada com a visão de administrador para conferir os canais existentes e usar a API também para criar caixas quando for necessário.
Como a API é REST e utiliza JSON, qualquer linguagem com suporte a HTTP pode ser usada para integrar times e membros a scripts, ERPs, CRMs ou ferramentas de automação. 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
- Operações grandes que precisam criar e ajustar times com frequência sem abrir o painel manualmente.
- Equipes de TI e automação que sincronizam a estrutura de agentes com diretórios, RH ou sistemas internos.
- Revendas white label que provisionam contas de clientes de forma padronizada, reutilizando a mesma lógica de times e caixas.
- Empresas que já usam a API da Papo para contatos e conversas e desejam completar o fluxo com a administração de equipes.
A API gerencia a estrutura de times e a inclusão de membros. As funções de usuário, como Agente ou Administrador, e as permissões granulares continuam sendo definidas no painel. Ao adicionar um usuário a um time e conectá-lo às caixas de entrada relevantes, você controla o acesso operacional às conversas.
Perguntas frequentes
A API da Papo define a função do usuário, como Agente ou Administrador?
Não. A API de times e membros concentra a criação de times, a listagem de membros e a inclusão de usuários. A definição de função e permissões de cada usuário é feita no painel. Ao incluir um usuário em um time e nas caixas corretas, você restringe o acesso às conversas operacionais.
Posso criar um time sem adicionar membros no mesmo passo?
Sim. A API permite criar um time com nome e descrição opcional, sem incluir usuários imediatamente. Depois, você pode adicionar membros usando a operação de inclusão em lote.
Como a API identifica a conta nas requisições?
Pela chave secreta enviada como token Bearer. A chave pública é opcional e, se enviada, precisa corresponder à mesma conta da chave secreta.
Essa API funciona para revenda white label?
Sim. Revendedores podem usar a API para provisionar times e membros nas contas dos clientes de forma padronizada, reduzindo configuração manual e mantendo consistência entre as operações.
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 times, membros e demais recursos.
Leia também
- Como usar a API da Papo para criar e gerenciar etiquetas (tags)
- Como gerenciar os usuários e permissões dentro da sua plataforma white label
Comece grátis e automatize times e membros via API →
O primeiro usuário é grátis para sempre, então você pode validar a integração antes de estruturar sua operação.