Developer Platform API

📘 Documentação da API – Sistema Zapiio

A API do Sistema Zapiio permite realizar integrações completas com os canais de atendimento da sua empresa, possibilitando o envio e recebimento de mensagens, gerenciamento de tickets, contatos, CRM e diversas funções avançadas de automação.

Ela foi projetada para ser simples, segura e compatível com qualquer linguagem de programação (Node.js, PHP, Python, Java, C#, etc.), permitindo que sistemas externos, bots, CRMs e automações se conectem diretamente ao fluxo operacional da sua plataforma.

🚀 Visão Geral da API

A API utiliza comunicação baseada em HTTP REST, aceitando requisições nos formatos JSON e FormData (para envio de arquivos). A autenticação é realizada por meio de um token do tipo Bearer, fornecido no painel de integrações do Zapiio.

Principais funcionalidades:

• ✔️ Envio de mensagens de texto
• ✔️ Envio de mídias (imagem, áudio, vídeo, documentos, base64 ou URL)
• ✔️ Envio de localização
• ✔️ Envio de botões, listas e elementos interativos
• ✔️ Criação e gerenciamento de Tickets
• ✔️ Consulta de informações do atendimento
• ✔️ Criação e atualização de Contatos
• ✔️ Aplicação de CRM, Follow-Up e Tags
• ✔️ Recursos avançados da API Oficial e API Plus (botões dinâmicos, carrossel, CTA, templates etc.)

Uma coleção completa para uso no Postman acompanha a API com exemplos funcionais, facilitando testes e aprendizado.

🧪 Coleção Postman Oficial

A coleção para Postman contém:

• Todos os endpoints organizados
• Exemplos prontos de requisições reais
• Estrutura dos parâmetros
• Exemplos de retorno
• Variáveis de ambiente (token, number, ticketId, base_url)

Ela deve ser utilizada para testes e validações antes de implementar sua integração.

✉️ Envio de Mensagens

A API permite o envio de mensagens comuns ou multimídia utilizando três formatos:

1. FormData (upload de arquivo)

Para envio direto de imagens, PDFs, áudios, vídeos etc.

2. Base64

Para quando o arquivo estiver armazenado localmente e precisar ser serializado.

3. URL

Para enviar mídias hospedadas na internet.

A coleção do Postman contém exemplos completos de cada tipo de envio (arquivo, base64 e URL) utilizando o arquivo API_modelo_postman.json.

🎟 Tickets

A API oferece controle total sobre tickets, incluindo:

• Criar ticket
• Mudar fila (queueId)
• Atribuir atendente (userId)
• Atualizar status (open, pending, closed etc.)
• Listar mensagens de um ticket
• Consultar ticket pelo número, pelo chatbot ou lista completa

Esses endpoints são essenciais para integrações com CRMs e sistemas internos.

👤 Contatos

Você pode criar, atualizar ou consultar contatos utilizando:

• Número
• contactId
• ticketId

Também é possível aplicar automações, como:

• Tags
• CRM
• Follow-Up
• Carteiras (wallets)
• Campos personalizados (extraInfo)

🤖 API Oficial & API Plus

A API inclui recursos avançados suportados pela plataforma oficial Meta WhatsApp, como:

• Botões interativos
• Listas
• CTA com link (call-to-action)
• Solicitação de localização
• Templates com parâmetros
• Carrossel
• Botões dinâmicos (reply, copiar, ligar, abrir URL)

Esses recursos são ideais para bots, menus automatizados e fluxos de atendimento.

📌 Boas Práticas de Uso

• Mantenha seu token seguro.
• Não exponha o token em front-end.
• Utilize sempre HTTPS.
• Em alta demanda, implemente filas (queues) e retries.
• Trate webhooks de forma assíncrona.
• Monitore logs de envio e resposta do servidor.

💬 Suporte e Atualizações

A API pode evoluir com o tempo. Consulte sempre:

• A documentação oficial interna
• A coleção Postman atualizada
• Os comunicados do sistema Zapiio

Em caso de dúvidas: ➡️ Entre em contato com o suporte técnico do Zapiio.