Skip to main content
Todas as requisições para a API RelaxPay v1 precisam ser autenticadas. Utilizamos um sistema baseado em credenciais Client ID e Client Secret para garantir a segurança das suas transações.

Client ID (ci)

Identificador público da sua aplicação

Client Secret (cs)

Chave secreta para autenticação (nunca compartilhe!)

Obtendo Credenciais

1

Acesse seu Dashboard

Entre no Dashboard RelaxPay e faça login
2

Navegue até Integrações

No menu lateral, clique em Integrações > API
3

Gere suas credenciais

Clique em Gerar novas credenciais e dê um nome para identificá-las
4

Armazene com segurança

Salve o Client ID (ci) e Client Secret (cs) gerados em um local seguro
O Client Secret só é exibido uma vez. Se você perdê-lo, precisará gerar um novo.

Credenciais de Sandbox

Para testes no ambiente sandbox, você pode utilizar as seguintes credenciais:
// Credenciais de Sandbox
const CLIENT_ID = 'sandbox_client_123456';
const CLIENT_SECRET = 'sandbox_secret_789012';
Estas credenciais são apenas para testes no ambiente sandbox. Não funcionarão em produção.

Autenticação via Cabeçalhos HTTP

Para autenticar suas requisições, inclua seus identificadores nos cabeçalhos HTTP:

Ciclo de Vida das Credenciais

As credenciais não possuem data de expiração definida e permanecem válidas até serem revogadas.
Para invalidar credenciais comprometidas, acesse o Dashboard e clique em Revogar ao lado da credencial desejada.
Recomendamos a rotação periódica de suas credenciais como boa prática de segurança.

Boas Práticas de Segurança

Variáveis de Ambiente: Armazene as credenciais em variáveis de ambiente, nunca no código-fonte
IPs Restritos: Configure IPs autorizados no Dashboard para limitar o acesso
Monitoramento: Acompanhe os acessos para identificar padrões suspeitos
HTTPS: Sempre utilize HTTPS em suas requisições
Credenciais Distintas: Use credenciais diferentes para ambientes de desenvolvimento e produção

Solução de Problemas

401 - Unauthorized
error
Suas credenciais estão inválidas ou não foram informadas corretamente.
403 - Forbidden
error
Suas credenciais são válidas, mas não têm permissão para acessar este recurso.
429 - Too Many Requests
warning
Limite de requisições excedido. Aguarde e tente novamente.
Em caso de falha na autenticação, verifique se os valores de Client ID e Client Secret estão corretos e se as credenciais não foram revogadas.