Começo
Qual API usar
O AWA expõe três interfaces com propósitos diferentes. Escolher a errada é o erro mais caro da integração: uma lista de convidados não tem preço, e uma API analítica não entrega tempo real. Comece por aqui.
As três interfaces
Partner Reports
apigw-partner-bffPainel de vendas, receita, ticket médio, mix de pagamento, cupom, conciliação de pedidos, catálogo de ingressos e lotes.
- Valores, descontos e totais
- Forma de pagamento, cupom, passkey
- Comprador e portadores
- Local, cidade, UF e sessões do evento
Access Control BFF
apigw-access-controlLista de acesso por sessão, consulta de códigos e registro de validações na portaria.
- Leitura incremental por cursor
- Filtros por titular, documento, e-mail, código
- Gravação de check-in em lote
Webhook de Acesso
awa-access-webhookReagir em tempo real ao ciclo de vida do ingresso, sem varredura.
- Emissão, alteração, transferência
- Cancelamento e reembolso
- Uso do código na portaria
Erro comum
Não monte um painel de vendas a partir do guestlist. Ele é um artefato de controle de acesso e não carrega preço, taxa, forma de pagamento nem pedido — registros vindos dele chegam com valor zero, o que leva painéis a classificá-los erroneamente como cortesia. Para dados de venda, use a Partner Reports.
Padrão recomendado para painel ao vivo
Assine o webhook para saber que algo mudou, e consulte a Partner Reports para saber o quê. O webhook entrega o order_id; o detalhe financeiro vem de GET /orders/{orderId}. Isso substitui a varredura completa da API a cada ciclo.
Comparativo
| Partner Reports | Access Control BFF | Webhook | |
|---|---|---|---|
| Modelo | pull, analítico | pull, operacional | push |
| Fonte do dado | data warehouse, cache ~1 min | transacional | transacional |
| Paginação | page / page_size ≤ 200 | cursor + size | — |
| Leitura incremental | updated_after, created_after (Pedidos e Catálogo) | updated_after, created_after | nativa |
| Timestamps | misto: Pedidos em horário local do evento + campo timezone; Catálogo (ingressos/lotes) em UTC com offset. Nos dois casos data e hora vêm separadas por espaço (2026-07-29 15:19:05.842260+00), não pelo T do RFC 3339 | RFC 3339 (UTC) | RFC 3339 (UTC) |
| Autenticação | OAuth2 + ACL events.reports | OAuth2 | segredo HMAC por assinatura |
| Ambientes | produção | dev e produção | dev e produção |
| Granularidade | pedido e linha de compra | código de acesso | código de acesso |
Já integrado com a API V1?
Além das três interfaces do AWA, a Ingresse mantém a API V1 legada (api.ingresse.com). Se sua integração já usa a V1 e você está avaliando migrar para o AWA, comece pelo Mapa de migração, que relaciona os campos de um modelo ao outro.
Ambientes e hosts
| Interface | Ambiente | Base URL |
|---|---|---|
| Partner Reports | produção | Fornecido com suas credenciais |
| Access Control | desenvolvimento | https://apigw-access-control.dev.ingresse.com |
| Access Control | produção | Fornecido com suas credenciais |
| Webhook | desenvolvimento | https://awa-access-webhook.dev.ingresse.com |
| Webhook | produção | Fornecido com suas credenciais |
| Auth (Keycloak) | produção | Fornecido com suas credenciais |
| Auth (Keycloak) | desenvolvimento | https://auth.dev.ingresse.com |
Hosts de produção sob demanda
A Partner Reports não possui sandbox — só existe produção. Os hosts de produção de todas as interfaces (Partner Reports, Access Control, Webhook e Auth) não são publicados aqui: são entregues junto com suas credenciais pelo seu account manager antes de ir ao ar.