# Zapster API

> SaaS for unofficial and official (WABA) WhatsApp connectivity to send/receive messages via REST, CLI, and webhooks.

Instances (paired numbers) over HTTPS; per-instance token auth. Canonical docs are pt-BR; this index is English.

## Quickstart

- [Introduction](https://developer.zapsterapi.com/pt-BR/v1/introduction): overview, base URL, auth.
- [CLI Agent Quickstart](https://developer.zapsterapi.com/pt-BR/v1/cli/agent-quickstart): minimal prompt.
- [JSON Output](https://developer.zapsterapi.com/pt-BR/v1/cli/json-output): structured `--json`.

## Common patterns

```bash
zapsterapi auth login --token <token>
zapsterapi message send --recipient <pn> --text "hi" --json
zapsterapi recipient fetch --recipient <pn> --json
```

CLI vs MCP: CLI for scripts and agents that exec subprocesses; MCP server inside Claude Desktop/Code for native tool calls.

## CLI

- [Installation](https://developer.zapsterapi.com/pt-BR/v1/cli/installation): npm/Homebrew/binary.
- [Introduction](https://developer.zapsterapi.com/pt-BR/v1/cli/introduction): commands, flags, exit codes.
- [SKILL](https://developer.zapsterapi.com/pt-BR/v1/cli/skill): copy-paste Claude Code skill so agents adopt the CLI conventions automatically.
- [Profiles](https://developer.zapsterapi.com/pt-BR/v1/cli/profiles): multi-instance config.
- [auth](https://developer.zapsterapi.com/pt-BR/v1/cli/reference/auth): login, logout, whoami.
- [instance](https://developer.zapsterapi.com/pt-BR/v1/cli/reference/instance): status, qrcode, power.
- [message](https://developer.zapsterapi.com/pt-BR/v1/cli/reference/message): send, list, cancel.
- [recipient](https://developer.zapsterapi.com/pt-BR/v1/cli/reference/recipient): fetch, batch.

## API Reference

- [OpenAPI](https://developer.zapsterapi.com/pt-BR/v1/openapi/openapi.json): full contract.
- [Create instance](https://developer.zapsterapi.com/pt-BR/v1/api-reference/instance/create-instance): provision.
- [Instance details](https://developer.zapsterapi.com/pt-BR/v1/api-reference/instance/instance-details): status, profile.
- [Pair via QR](https://developer.zapsterapi.com/pt-BR/v1/api-reference/instance/instance-qrcode) or [code](https://developer.zapsterapi.com/pt-BR/v1/api-reference/instance/pairing-code).
- [Send message](https://developer.zapsterapi.com/pt-BR/v1/api-reference/messages/sending): text, media, buttons, scheduled.
- [List](https://developer.zapsterapi.com/pt-BR/v1/api-reference/messages/list-messages) / [cancel](https://developer.zapsterapi.com/pt-BR/v1/api-reference/messages/cancel-message) messages.
- Webhooks CRUD: [list](https://developer.zapsterapi.com/pt-BR/v1/api-reference/webhooks/list-webhooks), [update](https://developer.zapsterapi.com/pt-BR/v1/api-reference/webhooks/update-webhook).
- [Fetch recipient](https://developer.zapsterapi.com/pt-BR/v1/api-reference/utils/fetch-recipient): WhatsApp presence (single + batch).

## Concepts

- [Instances](https://developer.zapsterapi.com/pt-BR/v1/concepts/instances): paired-number primitive.
- [Message lifecycle](https://developer.zapsterapi.com/pt-BR/v1/concepts/message-lifecycle): queued, sent, delivered, read.
- [Scheduled messages](https://developer.zapsterapi.com/pt-BR/v1/concepts/scheduled-messages): future-dated delivery.
- [Webhooks](https://developer.zapsterapi.com/pt-BR/v1/concepts/webhooks): event delivery model.
- [Tokens](https://developer.zapsterapi.com/pt-BR/v1/concepts/tokens): per-instance auth.

## Guides

- [Connect WABA](https://developer.zapsterapi.com/pt-BR/v1/guides/connect-waba-instance): official Meta path.
- [WABA vs unofficial](https://developer.zapsterapi.com/pt-BR/v1/guides/waba-vs-unofficial): trade-offs.
- [Best practices](https://developer.zapsterapi.com/pt-BR/v1/guides/best-practices): avoid bans, warm up.
- [Buttons](https://developer.zapsterapi.com/pt-BR/v1/guides/messages-with-buttons): interactive payloads.
## Webhooks

- [Intro](https://developer.zapsterapi.com/pt-BR/v1/webhooks/intro): signature, retries, ordering.
- [Setup](https://developer.zapsterapi.com/pt-BR/v1/webhooks/setting-up-webhook): register endpoint.
- [Events](https://developer.zapsterapi.com/pt-BR/v1/webhooks/available-events): full catalog.
- [Message schema](https://developer.zapsterapi.com/pt-BR/v1/webhooks/event-schemas/message): payload reference.