Conceito

Informações comuns a todas as requisições

Headers

Todas as requisições possuem os seguintes Headers:

Chave

Valor

Content-Type

application/json

Session

Token recebido na requisição de login

Domínio

circle-info

Durante a documentação o domínio das requisições será exibido como {{url}}

URL do servidor da requisição. Pode possuir os seguintes valores:

Ambiente

URL

Desenvolvimento

https://core.engaged-development.com

Produção

https://core.engaged.com.br

Versão da API

circle-info

Durante a documentação a versão da API das requisições será exibida como {{v}}

A versão atual da API é v2.

Identificador da conta

circle-info

Durante a documentação o identificador da conta será exibido como {{account}}

Por padrão é utilizado o subdomínio (subdomains)presente na collection account.

Coleções

A API está estruturada conforme as seguintes coleções:

Nome

Descrição

account

class

company

contract

course

document_blueprint

funnel

invoice

invoice_anticipation

invoice_withdrawal

lead

partner

step_contract

step_data_filling

step_onboarding

step_payment

student

tag

voucher

user

Last updated