Pular para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://developer.zapsterapi.com/llms.txt

Use this file to discover all available pages before exploring further.

A CLI foi desenhada para ser configurada por agentes. Cole o bloco abaixo no Claude Code, Codex, OpenClaw ou qualquer agente que execute comandos shell, e ele cuida do resto: 
Você vai configurar a CLI da Zapster (`@zapsterapi/cli`). Siga rigorosamente, e pare imediatamente se qualquer passo falhar.

1. Verifique se o Node.js 22+ está instalado: `node --version`. Se < 22, peça ao usuário para atualizar e pare.
2. Instale a CLI globalmente: `npm i -g @zapsterapi/cli`. Se falhar com EACCES, sugira `sudo npm i -g @zapsterapi/cli` ou um Node gerenciado pelo nvm.
3. Confirme com `zapsterapi --version`.
4. Pergunte ao usuário pelo token da Zapster API (ele pode gerar em https://app.zapsterapi.com/tokens). NÃO assuma nenhum valor.
5. Autentique: `zapsterapi auth login --token <token-fornecido>`.
6. Valide com `zapsterapi auth whoami`. Se falhar, peça um token novo e repita.
7. Liste as instâncias: `zapsterapi instance list --json`. Se a lista vier vazia, oriente o usuário a criar uma instância no dashboard antes de continuar.
8. Confirme: "CLI configurada. Pronto para enviar mensagens."

Após configurada, use a CLI assim:

```bash
zapsterapi message send --recipient 5511999999999 --text "olá"
zapsterapi recipient fetch --recipient 5511999999999 --json
zapsterapi instance list --json
```

Se o usuário tiver múltiplas contas, use `--profile <nome>` em todos os comandos.

​
Por que isso funciona bem com agentes

  • Saída JSON em todos os comandos (--json). Agentes preferem JSON estruturado a parse de texto.
  • Códigos de erro estáveis no envelope JSON (error.code). Permite o agente tomar decisões sem heurística textual.
  • Multi-profile via ~/.zapsterapi/credentials. O agente não precisa carregar tokens em variáveis ou flags.
  • Telemetria privacy-safe que ajuda a melhorar a CLI sem expor dados do usuário.

​
Atalhos copy-paste para agentes

  • llms.txt (download): índice de toda a documentação no formato llmstxt.org, pronto pra colar como contexto inicial num agente.
  • SKILL.md (copy-paste na doc): skill no formato Claude Code que você cola em ~/.claude/skills/zapsterapi-cli/SKILL.md pra que o agente saiba usar a CLI sem prompts adicionais.

​
Próximos passos