Documentação Rest API PostZap

POSTZAP REST API

Documentação Completa da REST API do PostZap

Token de acesso

Token de Exemplo: 647e5952a3862. Mantenha seu token de produção em segurança.

API de Instância — Criar Instância

## Criar Instância
GET https://apps.postzap.com.br/api/create_instance?access_token=647e5952a3862

fetch("https://apps.postzap.com.br/api/create_instance?access_token=647e5952a3862")
.then(res => res.json())
.then(console.log)
.catch(console.error);

axios.get("https://apps.postzap.com.br/api/create_instance", {
params: { access_token: "647e5952a3862" }
}).then(res => console.log(res.data)).catch(console.error);

Obter QR Code

## Obter código QR
GET https://apps.postzap.com.br/api/get_qrcode?instance_id=609ACF283XXXX&access_token=647e5952a3862

fetch("https://apps.postzap.com.br/api/get_qrcode?instance_id=609ACF283XXXX&access_token=647e5952a3862")
.then(res => res.json())
.then(console.log);

axios.get("https://apps.postzap.com.br/api/get_qrcode", {
params: { instance_id: "609ACF283XXXX", access_token: "647e5952a3862" }
}).then(res => console.log(res.data));

Definir Webhook

Você pode habilitar um webhook para receber eventos (mensagens, status, etc.).

GET https://apps.postzap.com.br/api/set_webhook?webhook_url=https%3A%2F%2Fwebhook.site%2FSEU_TOKEN&enable=true&instance_id=609ACF283XXXX&access_token=647e5952a3862

// URL já encodada
fetch("https://apps.postzap.com.br/api/set_webhook?webhook_url=https%3A%2F%2Fwebhook.site%2FSEU_TOKEN&enable=true&instance_id=609ACF283XXXX&access_token=647e5952a3862")
.then(res => res.json()).then(console.log);

axios.get("https://apps.postzap.com.br/api/set_webhook", {
params: {
webhook_url: "https://webhook.site/SEU_TOKEN",
enable: true,
instance_id: "609ACF283XXXX",
access_token: "647e5952a3862"
}
}).then(res => console.log(res.data));

O que o webhook retorna

Eventos retornados: status de conexão, mensagens recebidas, mensagens enviadas, desconexões, nível de bateria, etc.

Enviar mensagem

POST https://apps.postzap.com.br/api/send
Content-Type: application/json
{
"number": "5511999999999",
"type": "text",
"message": "Olá! Esta é uma mensagem de teste",
"instance_id": "609ACF283XXXX",
"access_token": "647e5952a3862"
}

fetch("https://apps.postzap.com.br/api/send", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
number: "5511999999999",
type: "text",
message: "Olá! Esta é uma mensagem de teste",
instance_id: "609ACF283XXXX",
access_token: "647e5952a3862"
})
}).then(res => res.json()).then(console.log);

axios.post("https://apps.postzap.com.br/api/send", {
number: "5511999999999",
type: "text",
message: "Olá! Esta é uma mensagem de teste",
instance_id: "609ACF283XXXX",
access_token: "647e5952a3862"
}).then(res => console.log(res.data));

Utilize /api/send OU /api/send_message.

Enviar mídia e arquivo

POST https://apps.postzap.com.br/api/send
{
"number": "5511999999999",
"type": "media",
"message": "Descrição opcional",
"media_url": "https://seusite.com/arquivo.jpg",
"instance_id": "609ACF283XXXX",
"access_token": "647e5952a3862"
}

fetch("https://apps.postzap.com.br/api/send", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
number: "5511999999999",
type: "media",
message: "Descrição opcional",
media_url: "https://seusite.com/arquivo.jpg",
instance_id: "609ACF283XXXX",
access_token: "647e5952a3862"
})
}).then(res => res.json()).then(console.log);

axios.post("https://apps.postzap.com.br/api/send", {
number: "5511999999999",
type: "media",
message: "Descrição opcional",
media_url: "https://seusite.com/arquivo.jpg",
instance_id: "609ACF283XXXX",
access_token: "647e5952a3862"
}).then(res => console.log(res.data));

Enviar para grupo (send_group)

POST https://apps.postzap.com.br/api/send_group
{
"group_id": "[email protected]",
"type": "text",
"message": "Olá grupo!",
"instance_id": "609ACF283XXXX",
"access_token": "647e5952a3862"
}

fetch("https://apps.postzap.com.br/api/send_group", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ group_id: "[email protected]", type: "text", message: "Olá grupo!", instance_id: "609ACF283XXXX", access_token: "647e5952a3862" })
}).then(r => r.json()).then(console.log);

axios.post("https://apps.postzap.com.br/api/send_group", { group_id: "[email protected]", type: "text", message: "Olá grupo!", instance_id: "609ACF283XXXX", access_token: "647e5952a3862" }).then(res => console.log(res.data));

Reiniciar / Reconnect / Reset

Endpoints úteis para manutenção da instância (do arquivo).

Função	Endpoint
Reiniciar instância	GET https://apps.postzap.com.br/api/reboot?instance_id=609ACF283XXXX&access_token=647e5952a3862
Reconnect	GET https://apps.postzap.com.br/api/reconnect?instance_id=609ACF283XXXX&access_token=647e5952a3862
Reset instance (logout + limpa dados)	GET https://apps.postzap.com.br/api/reset_instance?instance_id=609ACF283XXXX&access_token=647e5952a3862

Parâmetros e observações

Siginificado dos parâmetros utilizados.

Exemplo de tabela resumida

Parâmetro	Descrição
access_token	Token de acesso (mantenha em segredo)
instance_id	ID da instância gerada
webhook_url	URL pública para receber eventos
number / group_id	Alvo da mensagem (número no formato E.164 ou ID do grupo)