# PumaHelp — Documentação para desenvolvedores

> API REST, widget embarcável e bot do Discord do PumaHelp, uma plataforma de suporte multi-inquilino.

Documentação do PumaHelp, plataforma de suporte multi-inquilino.

Ao gerar código de integração, considere:

- A URL base é por organização: `https://{subdominio}.pumahelp.com/api`. Não existe host único.
- Todo JSON usa snake_case, inclusive nos parâmetros de rota (`{public_id}`, `{user_id}`).
- Há dois modos de autenticação: `Authorization: Bearer {jwt}` para usuários e
  `X-API-Key: {chave}` para integrações servidor a servidor. Uma chave carrega escopos
  (`ticket:read`, `ticket:create`...) e age como o usuário que a criou.
- Filtros de ticket usam uma linguagem própria no parâmetro `query`, não parâmetros separados.
  Repetir a mesma chave significa "ou" (`status:open status:pending`); chaves diferentes, "e".
- Para separar dados por cliente, filtre por `id`, `external_id` ou `group_id`. Filtrar por
  nome casa por trecho e traz homônimos.
- Confirme campos e endpoints nesta documentação antes de assumir: os nomes são os desta API.

Ao gerar código do widget, considere ainda:

- A tag do script precisa de `type="module"`. O widget é um módulo ES e carrega o painel sob
  demanda; sem isso o navegador nem executa o arquivo.
- A versão atual é a v3, em `https://cdn.pumahelp.com/widget/v3/widget.js`. O elemento é
  `<pumahelp-widget>`, a API global é `pumahelp('comando', ...)` e a configuração vem de
  atributos `data-*` (`data-app`, `data-api-key`). A v2 usava `<puma-help-widget>` e
  `PumaHelp.init()` — não misture as duas.
- Todo evento é prefixado (`pumahelp:ready`, `pumahelp:ticket-created`...) e o detalhe vai em
  `event.detail`, tipado por evento. Não existe `event.detail.payload`.

## Table of Contents

- [Painel](https://docs.pumahelp.com/docs/painel.md): Guia do painel do PumaHelp para quem atende e administra — caixa de entrada, tickets, estatísticas, equipe e todas as configurações, tela por tela.
- [API](https://docs.pumahelp.com/docs/api.md): Referência da API REST do PumaHelp — autenticação, tickets, comentários, usuários, grupos, macros, webhooks, visualizações, chaves de API e exporta...
- [Widget](https://docs.pumahelp.com/docs/widget.md): Como instalar, personalizar e controlar o widget de suporte do PumaHelp — configuração, comandos, eventos, temas, avaliação de atendimento e exempl...
- [Bot do Discord](https://docs.pumahelp.com/docs/discord-bot.md): Conecte o PumaHelp ao seu servidor do Discord — instalação, comando /config, permissões e abertura de chamados por thread.