Arena Upya Arena Upya
← Voltar à landing

Desenvolvedores · Documentação técnica

Arena Upya

Autenticação

Como obter e usar a API Key estática por empresa (tenant).

Visão geral

A API Arena usa API Key estática por empresa (tenant). O perfil é integração CRM → Ranking: não há OAuth2 nem certificado mTLS.

Envie a chave em um destes headers:

  • Authorization: Bearer <api_key>
  • ou X-API-Key: <api_key>

Obtendo a chave

  1. Entre no App com um usuário gestor.
  2. Abra API no menu do App.
  3. Informe um nome (ex.: “CRM produção”) e clique em Gerar chave.
  4. Copie o token completo na hora — ele não será exibido de novo.

No banco fica apenas o hash (SHA-256). Na listagem aparece só o prefixo (ex.: arena_live_ab12…) para identificar a chave.

Segurança: trate a chave como senha. Não versionar em repositório público. Revogue em App → API se houver vazamento e gere outra.

Escopos

Cada chave tem escopos (CSV). Na v1 o padrão é:

EscopoPermissão
ranking.entries.write Criar lançamentos em POST /api/v1/ranking/entries

Sem o escopo necessário a API responde 403 FORBIDDEN.

Exemplo de autorização

Bearer

curl -X POST "https://arenaupya.com.br/api/v1/ranking/entries" \
  -H "Authorization: Bearer arena_live_SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"seller_email":"ana@empresa.com","amount":2500}'

X-API-Key

curl -X POST "https://arenaupya.com.br/api/v1/ranking/entries" \
  -H "X-API-Key: arena_live_SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"seller_email":"ana@empresa.com","amount":2500}'