Skip to main content
A Oxenty API é uma API REST que permite enviar e receber mensagens do WhatsApp, gerenciar sessões, contatos e grupos de forma programática.

​
Base URL

Todas as requisições devem ser feitas para: 
https://api.oxenty.api.br/api

​
Formato de Requisições

A API aceita requisições em formato JSON. Sempre inclua o header: 
Content-Type: application/json

​
Autenticação

Todas as requisições precisam de autenticação via API Key.

API Key

Para integrações server-to-server. Crie no dashboard e use no header X-API-Key.

​
Exemplo com API Key

curl -X GET "https://api.oxenty.api.br/api/sessions" \
  -H "X-API-Key: ox_live_abc123..."

​
Formato de Respostas

Todas as respostas são em JSON. Uma resposta de sucesso típica: 
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Minha Sessão",
    "status": "connected"
  }
}
Uma resposta de erro: 
{
  "statusCode": 400,
  "message": "Sessão não encontrada",
  "error": "Bad Request"
}

​
Códigos de Status HTTP

CódigoDescrição
200Requisição bem-sucedida
201Recurso criado com sucesso
400Requisição inválida (verifique os parâmetros)
401Não autenticado (token inválido ou expirado)
403Sem permissão para este recurso
404Recurso não encontrado
429Rate limit excedido
500Erro interno do servidor

​
Paginação

Endpoints que retornam listas suportam paginação: 
GET /api/sessions?page=1&limit=20
A resposta inclui metadados de paginação: 
{
  "data": [...],
  "meta": {
    "total": 150,
    "page": 1,
    "limit": 20,
    "totalPages": 8
  }
}

​
Rate Limits

A API possui limites de requisições por minuto baseados no seu plano:
PlanoRequisições/min
Free60
Starter300
Professional1000
EnterpriseIlimitado
Quando exceder o limite, você receberá status 429 com o header: 
X-RateLimit-Reset: 1703952000

​
SDKs Disponíveis

Node.js/TypeScript

SDK oficial: oxenty-sdk

Repositório

Código-fonte e issues

​
Instalação do SDK

npm install oxenty-sdk

​
Uso Básico

import { OxentyClient } from 'oxenty-sdk'

const client = new OxentyClient({
  baseUrl: 'https://api.oxenty.api.br',
  apiKey: 'ox_live_abc123...',
});

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

// Enviar mensagem
await client.messages.sendText({
  sessionId: 'session-id',
  to: '5511999999999',
  text: 'Olá!',
});

​
Próximos Passos

Autenticação

Configure sua API Key

Criar Sessão

Conecte seu WhatsApp

Enviar Mensagens

Envie sua primeira mensagem

Webhooks

Receba eventos em tempo real