Desenvolvedores · Documentação técnica
Arena Upya
Módulos da API
Índice dos controllers — cada módulo tem página própria com endpoints, escopos e exemplos.
Convenções
- Tenant =
company_idda API key. - Escopos por módulo — um checkbox libera várias rotas (não por endpoint).
*.writeimplica*.readno mesmo módulo.- Ações de vendedor:
user_idouexternal_code. - Cross-tenant →
404 NOT_FOUND.
Mapa
| Módulo | Escopos | Rotas | |
|---|---|---|---|
| Health | — |
GET /health | Docs → |
| Ranking | ranking.read · write · entries.write |
campaigns, teams, sellers, entries | Docs → |
| Users | users.read · users.write |
GET/POST /users, PATCH /users/{id} | Docs → |
| Missions | missions.read · write |
CRUD, board, complete | Docs → |
| Shop | shop.read · shop.write |
tiers, redeems | Docs → |
| Links | links.read · links.write |
CRUD + for_user_id | Docs → |
| Meetings | meetings.read · write |
list, create, status | Docs → |
| Followups | followups.read · write |
fila, done, settings | Docs → |
| Withdrawals | withdrawals.read · write |
list, approve, reject | Docs → |
| Commissions | commissions.read · write |
report, rules, settings | Docs → |
| Notices | notices.read · write |
broadcast, inbox, read | Docs → |