Skip to main content
A chave de API é sua credencial de acesso à Upay. Ela identifica sua conta e autoriza cada requisição enviada para a nossa API. Sem uma chave válida, nenhum pedido será aceito.

​
O que você pode fazer com suas chaves

As chaves de API são gerenciadas diretamente pelo Dashboard. Com elas, você pode:
  • Ver todas as chaves ativas
  • Criar novas chaves para diferentes projetos ou integrações
  • Revogar chaves comprometidas ou que não são mais usadas

Desenvolvimento x Produção

Todas as requisições usam o mesmo endpoint https://upay-sistema-api.onrender.com. O ambiente é definido pela chave utilizada:
  • Chaves criadas em Desenvolvimento → transações simuladas
  • Chaves criadas em Produção → transações reais

Erro de Autenticação (401)

Você receberá um HTTP 401 quando:
  • A chave não for enviada no header
  • A chave estiver incorreta ou mal formatada
  • A chave tiver sido revogada

​
Permissões da chave de API

A chave define quais recursos você pode acessar. Endpoints sem a permissão correspondente retornam 403 Forbidden.

​
Permissões disponíveis

RecursoPermissões
Links de PagamentopaymentLinks:read, paymentLinks:write
Transaçõestransactions:read, transactions:write
Produtosproducts:read, products:write
Clientescustomers:read, customers:write
Cuponscoupons:read, coupons:write
Webhookswebhooks:read, webhooks:write
Saqueswithdrawals:read, withdrawals:write

​
Boas práticas de segurança

  • Armazene suas chaves em variáveis de ambiente — nunca no código-fonte
  • Nunca publique sua chave em repositórios públicos ou grupos
  • A Upay nunca solicitará sua chave por e-mail ou chat
  • Revogue imediatamente qualquer chave que possa ter vazado
  • Use chaves diferentes para desenvolvimento e produção

​
Como criar uma chave de API

1

Acesse o Dashboard

Faça login em app.upaybr.com e navegue até Configurações → Credenciais de API.
2

Crie uma nova chave

Clique em “Criar Nova API Key”, dê um nome descritivo (ex: “Integração Produção”) e selecione as permissões necessárias.
3

Copie a chave gerada

Copie a chave imediatamente e salve em um local seguro ou gerenciador de segredos. Ela não será exibida novamente.

​
Usando sua chave

Inclua a chave no header Authorization de todas as requisições: 
curl -X GET "https://upay-sistema-api.onrender.com/api/v1/payment-links" \
  -H "Authorization: Bearer SUA_API_KEY" \
  -H "Content-Type: application/json"

const response = await fetch('https://upay-sistema-api.onrender.com/api/v1/payment-links', {
  headers: {
    'Authorization': `Bearer ${process.env.UPAY_API_KEY}`,
    'Content-Type': 'application/json',
  },
});

Nota importante

O mesmo endpoint é usado para desenvolvimento e produção. O ambiente é determinado automaticamente pela chave de API utilizada na requisição.

​
Próximos passos

Início rápido

Faça sua primeira requisição em minutos.

Criar link de pagamento

Gere seu primeiro link de checkout.

Webhooks

Configure notificações automáticas de eventos.

SDKs

Use nossas bibliotecas oficiais para integrar mais rápido.