> ## Documentation Index
> Fetch the complete documentation index at: https://developers.qsmarthub.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API de Integrações do QSmartHub

> A API de Integrações do QSmartHub expõe em leitura suas unidades, filas, senhas, chamadas e agendamentos, e envia webhooks quando algo muda na operação.

O QSmartHub é a plataforma de gestão de filas e atendimento: senhas, pontos de atendimento, estações, operadores e agendamentos. A **API de Integrações** dá ao seu sistema acesso de leitura a esses dados e envia **webhooks** quando algo acontece, para você refletir a operação em CRMs, ERPs, automações e agentes de IA.

> [!NOTE]
>
> Esta é a **versão 1**, de **leitura somente**. Você consulta dados e recebe eventos; ainda não há endpoints para criar ou alterar registros. Veja abaixo o que isso significa na prática.

## O que a API faz hoje

> [card] Lê os dados da operação
>
> Consulte unidades, pontos de atendimento, estações, senhas, chamadas e agendamentos por requisições `GET` autenticadas por token.

> [card] Avisa quando algo muda
>
> Receba webhooks dos eventos de senha, chamada e agendamento, assinados por HMAC, assim que acontecem.

## O que ela ainda não faz

> [!WARNING]
>
> A v1 **não escreve**: não há `POST`, `PUT`, `PATCH` nem `DELETE`. Você não cria senhas nem aciona atendimento pela API nesta versão. As operações de escrita estão reservadas para uma rodada futura.

Para reagir a mudanças na operação, use **webhooks** em vez de ficar consultando a API em intervalos (polling): o QSmartHub avisa seu sistema quando uma senha nasce, é chamada ou finalizada, e quando um agendamento muda de estado.

## Comece por aqui

> [card] [Conceitos](https://developers.qsmarthub.com/conceitos.md)
>
> O modelo de domínio: Empresa, Unidade, Ponto de Atendimento, Estação, Senha e Chamada, e como a senha percorre a operação.

> [card] [Começando](https://developers.qsmarthub.com/comecando.md)
>
> Gere sua chave `qsh_live_`, faça a primeira requisição de leitura e entenda os limites por plano.

> [card] [Visão geral da API](https://developers.qsmarthub.com/visao-geral-api.md)
>
> Escopo da v1, paginação, formato de erro e limites de requisição por minuto.

> [card] [Webhooks](https://developers.qsmarthub.com/webhooks.md)
>
> Os eventos que o QSmartHub emite, como validar a assinatura e como funciona a retentativa.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.