Docs
API

Autenticação

Chaves de API por loja, com permissão por recurso.

Toda chamada leva a chave da loja no header:

Authorization: Bearer rk_...

Criar a chave

Em Integrações › Chaves de API, clique em Criar chave. Escolha, para cada recurso (pedidos, catálogo, clientes, entregas, webhooks…), se a chave pode ler, escrever ou nada.

O segredo aparece uma vez só, na criação. Guarde num cofre ou variável de ambiente (RIVOO_API_KEY), nunca no código nem no navegador. Se vazar, revogue na mesma tela: a chave para de funcionar na hora.
  • Uma chave vale para uma loja. Ela não alcança o saldo, os saques nem a equipe da conta: isso fica só no painel.
  • Chaves começam com rk_. As que começam com rck_ são de servidor de jogo (plugin) e não servem para a API.
  • Chaves criadas no painel não vencem: valem até você revogar. Se uma chave tiver validade, a data aparece na coluna Validade da lista, e depois dela a API responde 401 invalid_api_key.

Permissões

Cada recurso tem um nível: nada, ler ou escrever. Escrever inclui ler: uma chave com pedidos em "escrever" também lista e consulta pedidos.

RecursoSeções da referência
PedidosPedidos, Pagamentos, Links de pagamento, Assinaturas, Disputas (ler)
Reembolsos (só escrever)Reembolsos, Disputas, Devolver em gift card
CatálogoProdutos, Preços, Categorias, Arquivos, Imagens, Chaves de licença, Cupons e promoções, Gift cards, Criadores, Meta da comunidade
ClientesClientes, Bloqueios, Benefícios
EntregasEntregas, Comandos, Ações de entrega, Servidores, Discord
WebhooksWebhooks, Eventos
Relatórios (só ler)Relatórios
ConfiguraçõesConfigurações, Vitrine, Domínio próprio, Recuperação de carrinho
Chaves de APIChaves de API

Nas seções, GET pede ler e as demais operações pedem escrever. A exceção é gerar link de pré-visualização da vitrine, que pede só ler em Configurações. Cada operação da referência diz a permissão que exige, em Permissão da chave. Sem a permissão, a resposta é 403 permission_denied.

Erros de autenticação

StatuscodeO que fazer
401unauthenticatedMande o header Authorization.
401invalid_api_keyA chave está errada, revogada ou vencida.
403permission_deniedA chave não tem a permissão daquele recurso. Edite as permissões ou crie outra.

OAuth (assistentes de IA)

Assistentes como o Claude e o ChatGPT entram pelo MCP, com login OAuth do dono da loja. Esse acesso é só leitura e vale só para as lojas que você autorizar. Para integrar um sistema seu, use a chave de API.

Nesta página