Pular para o conteúdo principal

Introdução

Entenda rapidamente os conceitos gerais, códigos de resposta e estratégias de autenticação para integrar com a gzappy em 3 minutos.

Instalação no Node.js​

Para instalar o GZAPPY, execute o seguinte comando:

npm install gzappy-js

Uso no Node.js​

Este é um exemplo simples de como configurar e usar o cliente Gzappy para enviar mensagens.

// Importação do módulo gzappy-js
import gzappy from "gzappy-js";

// Definição das variáveis de ambiente
const GZAPPY_API_TOKEN = process.env.GZAPPY_API_TOKEN;
const GZAPPY_INSTANCE_ID = process.env.GZAPPY_INSTANCE_ID;

// Criação de uma instância do gzappy client
const gClient = new gzappy({
  token: GZAPPY_API_TOKEN,
  instanceId: GZAPPY_INSTANCE_ID,
});

// Enviando mensagens
const messages = [
  "Olá, tudo bem?",
  "Você tem um novo agendamento marcado, Sr Cliente",
];
const phones = ["5511999999999", "5511333333333"];

gClient
  .sendMessage(messages, phones)
  .then((response) => console.log(response))
  .catch((error) => console.error(error));

Exemplo CommonJS​

// Importação do módulo gzappy-js
const gzappy = require("gzappy-js").default;

// Definição das variáveis de ambiente
const token = process.env.GZAPPY_API_TOKEN;
const instanceId = process.env.GZAPPY_INSTANCE_ID;

// Criação de uma instância do gzappy client
const gClient = new gzappy({ token, instanceId });

RESTful API​

A API Gzappy é construída com base nos princípios REST. Nós impomos o uso de HTTPS em todas as solicitações para melhorar a segurança, integridade e privacidade dos dados. A API não oferece suporte a HTTP.

Todas as solicitações contêm a seguinte URL base:

https://api.gzappy.com/v1

Autenticação​

Para autenticar com sucesso você precisará adicionar o Header "Authorization" contendo o seu token de api que pode ser gerado no seu painel gzappy. API Tokens.

"Authorization": `Bearer ${GZAPPY_API_TOKEN}`

A Gzappy fornece suporte a multi instâncias de WhatsApp, isso quer dizer que você poderá manipular mais de um número de WhatsApp ao mesmo tempo, e para isso você também irá precisar fornece informações sobre sua instância em cada operação.

Status das respostas​

A Gzappy utiliza códigos HTTP padrão para indicar o sucesso ou falha de suas solicitações.

Em geral, os códigos HTTP 2xx correspondem ao sucesso, os códigos 4xx indicam falhas relacionadas ao usuário, e os códigos 5xx referem-se a problemas de infraestrutura.

Status Descrição​

  • [200] - Solicitação bem-sucedida.
  • [400] - Verifique se os parâmetros estão corretos.
  • [401] - A chave da API utilizada está ausente.
  • [403] - A chave da API utilizada é inválida.
  • [404] - O recurso não foi encontrado.
  • [429] - O limite de taxa foi excedido.
  • [5xx] - Indica um erro nos servidores da Resend.