Docs Entrar na plataforma

Referência

OpenAPI

A especificação OpenAPI 3.1 da API de Integração, gerada dos mesmos contratos que a API usa para validar.

openapi.json

OpenAPI 3.1.0 · versão 1.0.0 · 4 operações + webhooks

Baixar

O que tem dentro

OperaçãoRota
Listar pré-autorizações GET /integration/v1/pre-authorizations
Criar pré-autorização POST /integration/v1/pre-authorizations
Consultar pré-autorização GET /integration/v1/pre-authorizations/{id}
Cancelar pré-autorização POST /integration/v1/pre-authorizations/{id}/cancel
Evento da Oneos (webhook)seção webhooks

Tipos, obrigatoriedade e limites dos campos saem direto dos contratos da plataforma. Quando um campo muda na API, a especificação publicada muda junto.

Usar no Postman ou Insomnia

Importe pela URL e configure a variável de autenticação Bearer com a sua chave:

URL 
https://docs.oneos.com.br/api/openapi.json

Gerar um cliente

npx openapi-typescript https://docs.oneos.com.br/api/openapi.json -o oneos-api.d.ts
Esc