# 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: a API muda e nomes parecidos
  de outros produtos de suporte não se aplicam aqui.

## Table of Contents

- [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 e chaves de API.
- [Widget](https://docs.pumahelp.com/docs/widget.md): Como instalar, personalizar e controlar o widget de suporte do PumaHelp — métodos, eventos, identificação de usuários e exemplos em React, Vue e HTML.
- [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.