Visão geral

Corban API 0.8.0

Referência de todas as rotas que o seu sistema chama na API Corban.

Para entender o fluxo completo (link de contratação, jornada do cliente, propostas e webhooks), comece pelo guia Como funciona e siga os Primeiros passos.

Informações

• OpenAPI version: 3.1.0

Operações

POST

/v1/oauth/token

GET

/v1/ping

POST

/v1/links

GET

/v1/links/{id}

GET

/v1/webhooks

PUT

/v1/webhooks

DELETE

/v1/webhooks

POST

/v1/webhooks/segredo

POST

/v1/webhooks/teste

GET

/v1/webhooks/entregas

POST

/v1/webhooks/entregas/{id}/reenviar

POST

/v1/links/{id}/proposta/simular

PUT

/v1/sandbox/receptor

DELETE

/v1/sandbox/receptor/eventos

POST

/v1/sandbox/receptor/{token}

GET

/v1/sandbox/receptor/{token}/eventos

PUT

/v1/sandbox/receptor/{token}/modo

POST

Evento de proposta (enviado pelo Corban à sua URL) WEBHOOK

Autenticação

clientBasic

client_id como usuário e client_secret como senha.

Tipo de segurança: http

canalOAuth

Access token opaco obtido em POST /v1/oauth/token, enviado como Authorization: Bearer <access_token>. Validade de 1 hora.

Tipo de segurança: oauth2

Tipo de fluxo: clientCredentials

URL do token: /v1/oauth/token