Visão geral

Documentação técnica da API REST do Arena Upya — chave da empresa como gestor, escopos por módulo e integração CRM.

Versãov1.1

Base URLhttps://arenaupya.com.br

AuthAPI Key

A API é server-to-server. A chave autentica a empresa no papel de gestor. Escopos são por módulo (não por endpoint): *.read / *.write. Ações em nome do vendedor usam user_id ou external_code.

Abrir Swagger Autenticação Índice de módulos

Documentação por módulo

Health — GET /api/v1/health
Ranking — campanhas, times, sellers, prêmios, lançamentos
Users — CRUD + external_code
Missions — CRUD, board, complete
Shop — tiers e resgates
Links — CRUD e audiência
Meetings — reuniões company-wide
Followups — fila, done, settings
Withdrawals — aprovar / rejeitar
Commissions — relatório e regras
Notices — broadcast e inbox

Também neste portal

Webhooks — saída (POST para URLs da empresa)
Autenticação — headers e escopos com rotas cobertas
Domínios — empresa, user, código externo
Erros e anti-IDOR — envelope e regra do 404
Swagger UI — OpenAPI interativo (schemas + exemplos)
Postman — collection com bodies de exemplo