Autenticação
Chaves de API, ambientes, base URL, revogação e erros de autenticação.
Base URL
https://of.openi.com.br/v1Sandbox e produção usam o mesmo host. Quem decide o ambiente é a chave.
Chaves e ambientes
Cada aplicação do console tem um ambiente fixo, e as chaves herdam esse ambiente:
| Prefixo | Ambiente | Conectores |
|---|---|---|
of_test_ | Sandbox (test) | Apenas os conectores de teste; veja Sandbox |
of_live_ | Produção (live) | Instituições reais |
Uma chave só acessa os itens, webhooks e sessões da própria aplicação. Para separar sistemas ou clientes, crie aplicações diferentes.
Criando uma chave
- Acesse o console em of-console.openi.com.br. Contas novas já vêm com uma aplicação Sandbox.
- Abra Aplicações, escolha a aplicação e vá em Chaves.
- Crie a chave. O valor completo é exibido uma única vez: copie e guarde em um cofre de segredos. Só o hash é armazenado; não é possível recuperar o valor depois.
Usando a chave
Envie a chave no header Authorization com o esquema Bearer:
curl https://of.openi.com.br/v1/connectors \
-H "Authorization: Bearer of_test_..."Só no backend
A chave dá acesso a todos os dados da aplicação. Nunca a coloque em código de frontend, app mobile, repositório ou log. Para o navegador do usuário final, crie uma sessão do Connect: a key da sessão (of_connect_) é temporária e só serve para o fluxo de conexão.
Revogação
Revogue a chave no console, em Chaves. A revogação é imediata e permanente: as requisições seguintes recebem 401. Para trocar uma chave sem indisponibilidade, crie a nova, publique-a no seu backend e só então revogue a antiga.
Erros comuns
Erros seguem o formato { "status": "error", "message": "..." }.
| Status | Causa |
|---|---|
401 | Header ausente ou malformado, chave inexistente, incompleta ou revogada |
404 | Recurso inexistente ou de outra aplicação (por exemplo, um itemId criado com outra chave) |
422 | Parâmetros inválidos para o conector (no sandbox, um CPF fora da lista) |

