Skip to main content
A Oxenty API utiliza API Key para autenticação em integrações. Todas as requisições devem incluir a chave no header X-API-Key.

​
API Key

API Keys são chaves de longa duração (até serem revogadas) ideais para integrações backend-to-backend.

​
Gerando uma API Key

  1. Acesse o Dashboard da Oxenty
  2. Navegue até**→ API Keys**
  3. Clique em “Criar Nova Key”
  4. Defina um nome identificador e as permissões
  5. Copie e armazene a key em local seguro
A API Key completa é exibida apenas uma vez. Armazene-a em um local seguro (como variáveis de ambiente ou secrets manager).

​
Usando API Key

curl -X GET "https://api.oxenty.api.br/api/sessions" \
  -H "X-API-Key: oxt_sk_1234567890abcdef..."
API Keys começam com o prefixo oxt_sk_ para fácil identificação.

​
Exemplo Completo

import { OxentyClient } from 'oxenty-sdk';

// Com API Key (recomendado para backend)
const client = new OxentyClient({
  baseUrl: 'https://api.oxenty.api.br',
  apiKey: process.env.OXENTY_API_KEY,
});

// Listar sessões
const sessions = await client.sessions.list();

​
Boas Práticas

API Keys devem ser usadas apenas no backend. Para aplicações frontend, implemente um proxy no seu servidor.
Crie novas API Keys periodicamente e revogue as antigas. Isso minimiza riscos caso uma key seja comprometida.
Nunca commit tokens no código. Use .env files, secrets managers ou variáveis de ambiente do seu provedor cloud.
Ao criar API Keys, conceda apenas as permissões necessárias para a integração específica.

​
Erros de Autenticação

CódigoMensagemDescrição
401UNAUTHORIZEDToken ausente ou inválido
403FORBIDDENAPI Key válida mas sem permissão para o recurso
403API_KEY_REVOKEDAPI Key foi revogada
Veja a página de Erros para mais detalhes sobre tratamento de erros.