Introdução

A referência da API é a chave para uma compreensão abrangente da API da Zapster.

As integrações usam a API para enviar mensagens, criar instâncias, gerenciar webhooks e usuários. Você pode conectar serviços a Zapster e construir uma experiência interativa e personalizada para os seus usuários. Usando a navegação à esquerda, você encontrará detalhes para objetos e endpoints da nossa API.

📘

Você precisa de um token de integração para interagir com a API da Zapster. No momento o token de integração é fornecido quando preenchido o formulário de interesse.

Convensão

A URL base para enviar toda e qualquer requisição é https://new-api.zapsterapi.com. O uso de HTTPS é obrigatório para todas as requisições.

A Zapster API segue a convensão RESTFul sempre que possível, a maioria das operações são feitas através de requisições GET, POST, PATCH, e DELETE para os endpoints disponíveis. O corpo (body) das requisições e respostas estão sempre que possíveis estarão no formato JSON.

Convensão JSON

• Nome das propriedades estão em snake_case (não em camelCase ou kebab-case).
• Valores temporais (datas e horas) sempre estarão usando strings no formato ISO-8601. Data e horas irá incluir a horas (2024-03-21T00:30:00.000Z) enquanto datas irá incluir apenas a data (2024-03-21).

Paginação

Endpoints que retornam listas de objetos suportam requisições de paginadas. Por padrão, a Zapster retorna dez itens por chamada de API. Se o número de itens em uma resposta de um endpoint de suporte exceder o padrão, então uma integração pode usar paginação para solicitar um conjunto específico dos resultados e/ou limitar o número de itens retornados.

Parâmetros para requisições paginadas

🚧

Os parâmetros abaixo devem ser enviados através das query string na URL do endpoint que está sendo usado.

Exemplo: Recuperando segunda página das instâncias

curl --request GET \
  --url 'https://new-api.zapsterapi.com/v1/wa/instances?page=2' \
  --header 'Authorization: Bearer <token>'