Ambientes
A API Owem opera atualmente apenas em ambiente de produção.
| Ambiente | URL Base | Status |
|---|
| Produção | https://api.owem.com.br | ✅ Disponível |
| Sandbox | - | 🚧 Em breve |
Atualmente não existe ambiente de sandbox separado. Para testes, use o
parâmetro test: true nos endpoints que suportam.
Modo de Teste
Alguns endpoints suportam o parâmetro test: true para simular operações sem efeito real.
| Endpoint | Suporta test |
|---|
POST /v4/i/pix/in/dynamic-qrcode | ✅ |
POST /v4/i/bank-accounts/{id}/transfer/external | ✅ |
Exemplo de Uso
{
"amount": 100.0,
"pixKey": "[email protected]",
"description": "Teste de integração",
"test": true
}
Transações com test: true não movimentam saldo real e não aparecem no Ledger
de produção.
Variáveis de Ambiente
Recomendamos configurar as seguintes variáveis no seu ambiente:
Variáveis Obrigatórias
| Variável | Descrição |
|---|
OWEM_API_KEY | API Key da sua credencial |
OWEM_API_SECRET | API Secret (nunca exponha) |
OWEM_ACCOUNT_ID | ID da sua conta bancária Owem |
Variáveis Opcionais
| Variável | Descrição | Padrão |
|---|
OWEM_BASE_URL | URL base da API | https://api.owem.com.br |
OWEM_TIMEOUT | Timeout em ms | 30000 |
OWEM_WEBHOOK_SECRET | Secret para validar webhooks | - |
Exemplo de Configuração
# Credenciais Owem
OWEM_API_KEY=01ade144-6970-47d0-989d-3d90beed0ed3
OWEM_API_SECRET=7a0bf60a025796674df3b81852ec2e96...
OWEM_ACCOUNT_ID=572471114780
# Configurações
OWEM_BASE_URL=https://api.owem.com.br
OWEM_TIMEOUT=30000
ENV OWEM_API_KEY=sua_api_key
ENV OWEM_API_SECRET=seu_api_secret
ENV OWEM_ACCOUNT_ID=seu_account_id
ENV OWEM_BASE_URL=https://api.owem.com.br
apiVersion: v1
kind: Secret
metadata:
name: owem-credentials
type: Opaque
stringData:
OWEM_API_KEY: sua_api_key
OWEM_API_SECRET: seu_api_secret
OWEM_ACCOUNT_ID: seu_account_id
| Header | Valor | Descrição |
|---|
Authorization | Basic {token} | Token Base64 de autenticação |
Content-Type | application/json | Tipo de conteúdo |
| Header | Valor | Descrição |
|---|
X-Idempotency-Key | UUID | Chave de idempotência |
X-Request-Id | UUID | ID de rastreio customizado |
A API retorna headers úteis para monitoramento:
| Header | Descrição |
|---|
X-RateLimit-Limit | Limite de requisições por período |
X-RateLimit-Remaining | Requisições restantes |
X-RateLimit-Reset | Timestamp de reset (epoch) |
X-Request-Id | ID único da requisição |
Use o X-Request-Id ao abrir tickets de suporte para agilizar a investigação.
Timeouts Recomendados
| Operação | Timeout Sugerido |
|---|
| Ping / Health check | 5s |
| Consultas (GET) | 15s |
| Geração de QR Code | 30s |
| Transferências PIX | 60s |
| Webhooks (resposta) | 3s |
Webhooks que não respondem em 3 segundos são considerados falhos e entram
em retry.
