COMPRAR

API ZPRO (Postman)

Disponível para o perfil: Administrador

Introdução e Conceitos Chave

A API do Z-PRO permite que você integre a plataforma com outros sistemas, como CRMs, ERPs ou plataformas de automação (ex: n8n), para realizar ações de forma programática.

Entendendo os Métodos (GET vs. POST)

Ao utilizar a coleção no Postman, é importante notar o método padrão para uma nova requisição. Para que a API do Z-PRO funcione corretamente, atente-se à regra:

  • A grande maioria dos endpoints utiliza o método POST para criar, atualizar, listar ou deletar informações.

  • A única exceção principal é o endpoint SendMessageParams, que utiliza GET para recuperar parâmetros.

Sempre verifique se o método correto está selecionado no Postman antes de executar a requisição.

Ferramenta Principal: Coleção Postman

A forma mais recomendada para explorar e testar a API do Z-PRO é através da nossa coleção oficial no Postman, um aplicativo que permite executar requisições de API em um ambiente visual. Nossa coleção contém todas as rotas, parâmetros e exemplos.

Link para a Coleção Oficial do Z-PRO no Postman

Como Usar a Coleção: Fazendo um "Fork"

No Postman, o termo "fork" tem um significado semelhante ao utilizado em plataformas como o GitHub. Fazer um "fork" de uma coleção significa criar uma cópia pessoal e vinculada da nossa coleção pública. Você poderá usar, testar e modificar esta cópia no seu próprio workspace (espaço de trabalho) sem afetar o original.

Principais Vantagens de Fazer um Fork:

  • Independência: Você pode alterar e personalizar a coleção no seu workspace, inserindo suas chaves de autenticação e salvando requisições próprias.

  • Sincronização: Você mantém uma referência à coleção original e pode receber notificações sobre nossas atualizações, com a opção de usar a função "pull" para sincronizar as novidades.

  • Segurança: Suas chaves de API e testes ficam salvos apenas no seu ambiente privado.

Passo a Passo para Fazer o Fork:

  • Acesse nossa coleção pública através do link fornecido.

  • Clique na opção "Fork" (geralmente representada por um ícone de ramificação).

  • Dê um nome para a sua cópia (label) e escolha em qual workspace você deseja salvá-la.

Como Navegar em um Endpoint no Postman

Ao clicar em uma requisição (endpoint) na sua cópia da coleção, você verá várias abas:

  • Overview: A documentação principal, com a descrição do que a rota faz.

  • Params: Usado em requisições GET para filtrar os resultados.

  • Authorization: Onde a autenticação Bearer Token é configurada.

  • Headers: Cabeçalhos da requisição.

  • Body: A "carga" de dados que você envia em requisições POST.

Autenticação e Primeiros Passos

Como Gerar seu Token (API Key)

  1. No painel Admin, acesse o menu "API".

  2. Crie uma nova chave de API para gerar seu token.

Como Usar o Token

Todas as requisições à API devem incluir este token no cabeçalho Authorization, no formato Bearer.

  • Exemplo: Authorization: Bearer SEU_TOKEN_AQUI

URL Base

Todas as rotas da API devem ser chamadas a partir da sua URL de back-end.

  • Exemplo: https://api.seudominio.com.br/

Referência de Endpoints

Abaixo está a lista dos principais endpoints disponíveis e suas funções.

Mensagens

  • GET SendMessageParams: Recupera os parâmetros básicos para poder enviar uma mensagem.

  • POST SendMessageAPIText: Envia uma mensagem de texto simples pelo WhatsApp.

  • POST SendMessageAPIFile: Envia uma mensagem com um arquivo (imagem, PDF, etc.).

  • POST SendMessageAPIFileURL: Envia uma mensagem com arquivo, pegando o arquivo de um link (URL).

  • POST SendMessageAPIVoice: Envia uma mensagem de voz no WhatsApp.

  • POST SendMessageAPITextBase64: Envia um arquivo 'dentro' da mensagem, em formato codificado (base64).

  • POST SendGroupMessageAPIText: Envia mensagem de texto para um grupo de WhatsApp.

  • POST SendGroupMessageAPIFile: Envia arquivo em grupo de WhatsApp.

  • POST SendMessageAPIFileURLGroup: Envia arquivo via link para um grupo de WhatsApp.

  • POST SendTemplateWaba: Envia uma mensagem pronta (template oficial) aprovada pelo WhatsApp.

Gerenciamento de Contatos e Oportunidades

  • POST CreateContact: Cria um novo contato (cliente) na base do sistema.

  • POST CreateOpportunity: Cria uma oportunidade de venda (ex: um possível cliente interessado).

  • POST DeleteOpportunity: Apaga uma oportunidade de venda.

  • POST UpdateOpportunity: Atualiza os dados de uma oportunidade existente.

  • POST ShowContact: Mostra as informações de um contato específico.

  • POST UpdateContact: Atualiza os dados de um contato.

Notas e Chamados (Tickets)

  • POST CreateNotes: Cria uma nota interna, como se fosse um comentário no atendimento.

  • POST CreateTicket: Cria um chamado de atendimento (um atendimento novo).

  • POST CreateTicketFile: Cria um chamado anexando um arquivo junto.

  • POST SetQueue: Move um chamado para uma fila de atendimento diferente.

Exemplo de Aplicação: Automação com n8n

(Live: https://youtu.be/0I-52eP61ng?t=469)

Na live de demonstração, foi apresentado um caso de uso prático conectando o Z-PRO ao n8n para automatizar o agendamento de uma consulta. O fluxo utilizou os seguintes endpoints em sequência para realizar a tarefa:

  • Enviar Mensagem: Para interagir com o cliente durante o agendamento.

  • Criar Oportunidade: Para registrar o agendamento no CRM interno.

  • Definir Etiqueta: Para organizar o ticket com a tag "Consulta Agendada".

  • Atualizar Ticket: Para atribuir o atendimento a um atendente humano e desativar a automação.

AnteriorAPI (admin)PróximoGuias Técnicos

Atualizado