Visão geral

Documentação técnica da API REST do Arena Upya — como autenticar, entender os domínios e integrar o CRM do cliente ao Ranking.

Versão v1

Base URL https://arenaupya.com.br

Auth API Key

A API é server-to-server (CRM → Arena), autenticada por API Key estática por empresa. Use este portal para o guia narrativo e o Swagger para testar os endpoints ao vivo.

Abrir Swagger (Try it out) Começar pela autenticação

O que você encontra aqui

Autenticação — gerar chave, headers Bearer / X-API-Key, escopos
Domínios e entidades — empresa, campanha, vendedor, lançamento
API Ranking — POST /api/v1/ranking/entries, payload e exemplos
Erros e respostas — envelope JSON e códigos HTTP
Swagger UI — documentação viva OpenAPI com teste interativo

Fluxo típico de integração

Gestor gera uma API Key em App → API (segredo exibido uma vez).
O CRM do cliente autentica cada request com Authorization: Bearer ou X-API-Key.
A cada venda fechada, o CRM chama POST /api/v1/ranking/entries.
O lançamento aparece no Ranking e no Monitor Telão da campanha.

Dica: use idempotency_key (ou header Idempotency-Key) para não duplicar a mesma venda se o CRM reenviar o evento.

Endpoints disponíveis (v1)

Método	Rota	Auth	Descrição
`GET`	`/api/v1/health`	Não	Health check
`POST`	`/api/v1/ranking/entries`	Sim	Registrar venda / lançamento no ranking
`GET`	`/api/openapi.json`	Não	Spec OpenAPI 3