Skip to content
open-apimePublic

About

A WhatsApp REST API gateway built in Go, powered by the whatsmeow library.

Topics

Resources

Stars

16 stars

Watchers

0 watching

Forks

Repository files navigation

🇺🇸 Read in English

Api em Go para orquestrar múltiplas instâncias.

Baseada na biblioteca WhatsMeow com dashboard e eventos via Webhooks.

  1. Configurar o ambiente:

    cp .env.example .env

    (Edite o .env conforme necessário).

  2. Iniciar os containers:

    docker compose up -d

    Importante: As migrations e o usuário administrador inicial são criados automaticamente no primeiro boot.

Acesso

  • Dashboard: http://localhost:8080/dashboard

  • Email: admin@apime.local

  • Senha: admin123

  • API Specification: openapi.yaml

SDK oficial (Node/TypeScript)

Cliente tipado para quem integra em Node, com retry, verificação de webhook e as 66 operações da API: @open-apime/sdk.

npm install @open-apime/sdk
import { Apime } from "@open-apime/sdk";

const conexao = Apime.withInstanceToken(
  { token: process.env.INSTANCE_TOKEN!, instanceId: "abc-123" },
  { baseUrl: "https://apime.example.com" },
);

await conexao.messages.sendText(
  { to: "5511999999999", text: "Olá" },
  { idempotencyKey: mensagem.id },
);

Sem Node, a API é HTTP comum: o openapi.yaml descreve tudo.

Documentação

Doc Assunto
docs/dashboard.md interface web, autenticação e rotas de admin
docs/webhook-payloads.md envelope, assinatura HMAC e os tipos de evento
docs/idempotency.md repetir envio sem duplicar mensagem
docs/users.md usuários e tokens
docs/media.md mídia
docs/phone-numbers.md números e JIDs
docs/whatsapp-advanced.md grupos, newsletters e privacidade
docs/health-check.md health check

About

A WhatsApp REST API gateway built in Go, powered by the whatsmeow library.

Topics

Resources

Stars

16 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages