Pular para o conteúdo principal

​
API Owem v4

Bem-vindo à documentação da API Owem. Nossa API permite integrar pagamentos PIX, transferências e serviços financeiros em sua aplicação.

​
Base URL

https://api.owem.com.br

​
Autenticação

Todas as requisições à API requerem autenticação via Basic Auth. 
Authorization: Basic {Base64(API_KEY:API_SECRET)}

​
Como gerar seu token

1

Obtenha suas credenciais

No dashboard da Owem, acesse Configurações > Credenciais:
  1. Clique em + Nova Credencial
  2. Escolha o ambiente: Sandbox ou Produção
  3. Defina os Escopos de permissão
  4. Informe um Nome para identificar a credencial
  5. Adicione os IPs Permitidos (obrigatório IP fixo)
  6. Clique em Continuar
Você receberá:
  • API_KEY - Sua chave de API
  • API_SECRET - Sua chave secreta
Guarde suas credenciais com segurança! O API_SECRET é exibido apenas uma vez e não pode ser recuperado.
2

Gere o token Base64

Concatene suas credenciais no formato API_KEY:API_SECRET e converta para Base64.
const API_KEY = "sua-api-key";
const API_SECRET = "seu-api-secret";

const token = btoa(`${API_KEY}:${API_SECRET}`);
console.log(token);
// Resultado: c3VhLWFwaS1rZXk6c2V1LWFwaS1zZWNyZXQ=
3

Use o token nas requisições

Adicione o header Authorization com o prefixo Basic:
curl -X GET "https://api.owem.com.br/v4/i/ping" \
  -H "Authorization: Basic c3VhLWFwaS1rZXk6c2V1LWFwaS1zZWNyZXQ="
Requisitos de segurança: - Em produção, seu IP FIXO deve estar na allowlist - Nunca exponha suas credenciais em código client-side - Entre em contato com o suporte para adicionar seu IP FIXO em produção
Usando o Playground: Insira a credencial Base64 (com prefixo Basic ) no campo de autenticação. ex: Basic c3VhLWFwaS1rZXk6c2V1LWFwaS1zZWNyZXQ=

​
Estrutura de Resposta

Todas as respostas seguem o padrão: 
{
  "requestId": "uuid-para-rastreio",
  "success": true,
  "size": 1,
  "data": { ... }
}
CampoTipoDescrição
requestIdstringUUID único para rastreio e auditoria
successbooleanIndica sucesso da operação
sizenumberQuantidade de itens retornados
dataobject/arrayDados da resposta

​
Rate Limits

LimiteValor
Requisições por minuto1000
Requisições por segundo100
Os headers x-ratelimit-limit, x-ratelimit-remaining e x-ratelimit-reset indicam o status do rate limit.

​
Ambientes

AmbienteURLObservações
Produçãohttps://api.owem.com.brEm produção, seu IP fixo deve estar na allowlist
Sandboxhttps://sandbox.api.owem.com.brAinda não disponível para uso de clientes

Começar

Teste sua conexão com o endpoint Ping