Começar · Visão geral

API de Integração

Conecte o ERP da sua construtora à Oneos: crie pré-autorizações de antecipação para os seus fornecedores e acompanhe cada operação por webhooks assinados.

O que a API faz

A API de Integração deixa o seu ERP fazer, sozinho, o que hoje a construtora faz na tela de pré-autorização. São quatro endpoints e um canal de eventos:

Recurso	O que faz
POST Criar pré-autorização	Oferece ao fornecedor a antecipação de uma nota que a sua empresa vai pagar. Ele é avisado pela plataforma.
POST Cancelar pré-autorização	Retira a oferta enquanto o fornecedor ainda não pediu a antecipação.
GET Consultar pré-autorizações	Lê uma operação pelo `id`, ou lista pelo seu `externalReference`, com o status atual.
Webhooks	A Oneos avisa o seu sistema a cada passo: solicitação, aprovação, pagamento, boleto, conclusão.

O estado das operações chega por webhook: guarde o id que a criação devolve e atualize o seu ERP com os eventos. A consulta serve para reconciliar — depois de uma indisponibilidade do seu endpoint, por exemplo — e não precisa ser feita em ciclo.

Antes de começar

Sua empresa é uma construtora com conta ativa na Oneos. A integração pertence à matriz.
Quem vai configurar tem acesso a Minha empresa › Integração e Minha empresa › Webhooks na plataforma.
Cada chave tem um usuário responsável: as operações saem em nome dele, e ele precisa ter a permissão de solicitar e pré-autorizar antecipações.

Base URL

https://app.oneos.com.br/api/integration/v1

Toda requisição usa HTTPS, JSON (ou multipart/form-data para enviar a nota) e a chave no header Authorization.

Em números

120requisições por minuto, por chave e por endpoint

7 diasde memória para a Idempotency-Key

23tipos de evento no catálogo de webhooks

7tentativas de entrega em ~34 h