NAV
bash javascript

Info

Welcome to the generated API reference. Get Postman Collection

Afiliados

Class AfiliacaoController

Enviar comissão para o Affiliate

Verifica pré-matrículas confirmadas que possuem o código do afiliado (iDevAffiliate) e que pertençam a entidades cujo tipo de curso da entidade seja pós-graduação e envia os dados para a plataforma iDevAffiliate.

Esse método e uma rotina que vai ser executado de tempos em tempos via cron job e não é necessário passar nenhum parâmetro

Example request:

curl -X POST "https://api-comercial.unyleya.com.br/api/afiliacao/idevaffiliate/atualizar-afiliado" 
const url = new URL("https://api-comercial.unyleya.com.br/api/afiliacao/idevaffiliate/atualizar-afiliado");

let headers = {
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "POST",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "tipo": 1,
    "titulo": "Resultado do robô em [data de execução]",
    "mensagem": "[Array com os id das pré-vendas que foram enviadas]"
}

Example response (400):

{
    "tipo": 3,
    "titulo": "Não foi possível atualizar os afiliados",
    "mensagem": "[Exception error]"
}

HTTP Request

POST api/afiliacao/idevaffiliate/atualizar-afiliado

Insere novos afiliados

Metodo responsável por inserir no banco do g1 seguindo o padrão da Affiliate

Example request:

curl -X POST "https://api-comercial.unyleya.com.br/api/afiliacao/idevaffiliate/criar-afiliado?codafiliacao=fugiat&codafiliada=cumque&codidevaffiliate=qui&codpessoaresponsavel=qui&desurl=earum&flasituacao=doloremque&nomsite=expedita" 
const url = new URL("https://api-comercial.unyleya.com.br/api/afiliacao/idevaffiliate/criar-afiliado");

    let params = {
            "codafiliacao": "fugiat",
            "codafiliada": "cumque",
            "codidevaffiliate": "qui",
            "codpessoaresponsavel": "qui",
            "desurl": "earum",
            "flasituacao": "doloremque",
            "nomsite": "expedita",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "POST",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

null

Example response (400):

null

HTTP Request

POST api/afiliacao/idevaffiliate/criar-afiliado

Query Parameters

Parameter Status Description
codafiliacao required
codafiliada required
codidevaffiliate required
codpessoaresponsavel required
desurl required
flasituacao required
nomsite required

Confirmar Comissão

Método responsável por confirmar que a comissão chegou a plataforma do IdevAffiliate e que a mesma foi criada lá ele deve ser chamado através de um webhook apenas quando o iDevAffiliate dispara a trigger commision.created

Example request:

curl -X POST "https://api-comercial.unyleya.com.br/api/afiliacao/idevaffiliate/enviar-comissao" 
const url = new URL("https://api-comercial.unyleya.com.br/api/afiliacao/idevaffiliate/enviar-comissao");

let headers = {
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "POST",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "tipo": 1,
    "titulo": "Operação concluída em [data de execução]",
    "mensagem": "[Array com os id das pré-vendas que foram enviadas]"
}

Example response (400):

{
    "tipo": 3,
    "titulo": "Não foi possível confirmar a comissão em [data de execução]",
    "mensagem": "[Exception error]"
}

HTTP Request

POST api/afiliacao/idevaffiliate/enviar-comissao

Contrato de Afiliação


Requires authentication Lista com todos os dados do Contrato de Afiliação.

Example request:

curl -X GET -G "https://api-comercial.unyleya.com.br/api/g1/afiliacao/listar-contrato-afiliacao?codentidadeafiliadora=2&desafiliacao=GANHE%2BMAIS&situacao=Ativo" 
const url = new URL("https://api-comercial.unyleya.com.br/api/g1/afiliacao/listar-contrato-afiliacao");

    let params = {
            "codentidadeafiliadora": "2",
            "desafiliacao": "GANHE+MAIS",
            "situacao": "Ativo",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "codentidadeafiliadora": "2",
    "afiliadora": "POSEAD\/GAMA FILHO",
    "codcontratoafiliacao": "27",
    "codafiliacao": "1",
    "codafiliada": "94",
    "codidevaffiliate": null,
    "codigoafiliada": "94",
    "nomeafiliada": "BRUNAN COMUNICAÇÃO E REPRESENTAÇÀO LTDA",
    "tipoafiliada": "PJ",
    "desurl": "http:\/\/www.brunancursos.com.br",
    "...": "..."
}

Example response (400):

{
    "tipo": 2,
    "titulo": "Parâmetros inválidos",
    "mensagem": "O campo codentidadeafiliadora deve ser um número.",
    "dados": null
}

Example response (500):

{
    "tipo": 0,
    "titulo": "Erro",
    "mensagem": "Não foi possível listar o contrato de afiliação",
    "dados": "Undefined index: codentidadeafiliadora"
}

Example response (403):

{
    "tipo": 0,
    "titulo": "Erro ao validar o Token",
    "mensagem": "Wrong number of segments",
    "dados": null
}

HTTP Request

GET api/g1/afiliacao/listar-contrato-afiliacao

Query Parameters

Parameter Status Description
codentidadeafiliadora optional int Código de entidade da classe de afiliação. Quando o parâmetro for informado sem valor, retornará os afiliados vinculados a uma classe de afiliação que não está vinculada a uma entidade.
desafiliacao optional string Descrição da classe de afiliação.
situacao optional string Situação do contrato do afiliado. Opções: Pendente, Inativo, Ativo, Cancelado e Recusado.

Convenio

Class Convenio

Função responsavel buscar convenios do G1.

Example request:

curl -X GET -G "https://api-comercial.unyleya.com.br/api/g1/convenios" \
    -H "Content-Type: application/json" \
    -d '{"codconvenio":"100","nomconvenio":"saepe","codentidade":"accusamus","codconvenioparceiro":"est","codtipoconvenio":"consequatur","datcadastro":"ipsa","datcadastro_ini":"quis","datcadastro_fim":"beatae","flasituacao":"voluptas","valpercentualcomissao":"mollitia","codtipoconvenioentidade":"repellendus"}'

const url = new URL("https://api-comercial.unyleya.com.br/api/g1/convenios");

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
}

let body = {
    "codconvenio": "100",
    "nomconvenio": "saepe",
    "codentidade": "accusamus",
    "codconvenioparceiro": "est",
    "codtipoconvenio": "consequatur",
    "datcadastro": "ipsa",
    "datcadastro_ini": "quis",
    "datcadastro_fim": "beatae",
    "flasituacao": "voluptas",
    "valpercentualcomissao": "mollitia",
    "codtipoconvenioentidade": "repellendus"
}

fetch(url, {
    method: "GET",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (403):

{
    "tipo": 0,
    "titulo": "Erro ao validar o Token",
    "mensagem": "Wrong number of segments",
    "dados": null
}

HTTP Request

GET api/g1/convenios

Body Parameters

Parameter Type Status Description
codconvenio nullable optional numeric - ID do convenio.
nomconvenio nullable optional string - Nome do Convenio. Exemple: AGANP
codentidade nullable optional numeric - Código da entidade Exemple: 2
codconvenioparceiro nullable optional numeric - Código do convênio parceiro Exemple: 2
codtipoconvenio nullable optional numeric - Código do tipo de convênio Exemple: 3
datcadastro nullable optional date - Data de cadastro do convênio Exemple: 2009-12-10
datcadastro_ini nullable optional date - Data Inicial de cadastro do convênio (A partir de) Exemple: 2009-12-10
datcadastro_fim nullable optional date - Data Fim de cadastro do convênio (Até) Exemple: 2009-12-10
flasituacao nullable optional string - Situação do convênio Exemple: A
valpercentualcomissao nullable optional numeric - Valor do percentual da comissão Exemple: 200
codtipoconvenioentidade nullable optional numeric - Código do tipo de convenio Entidade Exemple: 3

Localidades

Class LocalidadeController

Localidades sites Unyleya


Requires authentication Lista de localidades para os sites Unyleya.

Example request:

curl -X GET -G "https://api-comercial.unyleya.com.br/api/g1/localidade/get-localidades-sites?uf=DF&situacao=A" 
const url = new URL("https://api-comercial.unyleya.com.br/api/g1/localidade/get-localidades-sites");

    let params = {
            "uf": "DF",
            "situacao": "A",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "tipo": 1,
    "titulo": "Sucesso",
    "mensagem": "Dados retornados com sucesso",
    "dados": [
        {
            "id": "000",
            "localidade": "MACEIÓ",
            "uf": "AL",
            "idemunicipio": "3106400",
            "situacao": "A"
        }
    ]
}

Example response (400):

{
    "tipo": 2,
    "titulo": "Aviso",
    "mensagem": "API Comercial | Parâmetros inválidos",
    "dados": "O campo uf deve ser 2 caracteres."
}

Example response (500):

{
    "tipo": 0,
    "titulo": "Erro",
    "mensagem": "API Comercial | Não foi possível obter as localidades",
    "dados": "Undefined index: ufs"
}

Example response (403):

{
    "tipo": 0,
    "titulo": "Erro ao validar o Token",
    "mensagem": "Wrong number of segments",
    "dados": null
}

HTTP Request

GET api/g1/localidade/get-localidades-sites

Query Parameters

Parameter Status Description
uf optional Sigla UF. Quando fornecido, deve ter obrigatoriamente 2 caracteres.
situacao optional Situação da localidade. Legenda: A = ativa, I = inativa e T = todas. Quando fornecido, deve ter obrigatoriamente 1 caractere.

Atualizar último lote sincronizado com o G2.


Requires authentication Insere nas localidades G1 o número do último lote sincronizado com o G2.

Example request:

curl -X POST "https://api-comercial.unyleya.com.br/api/g1/localidade/atualizar-ultimo-lote-sincronizado" \
    -H "Content-Type: application/json" \
    -d '{"numultlotesincronizado":2,"localidadesG1Sincronizadas":"[1, 2, 3]","sincronizarUnicaLocalidade":true}'

const url = new URL("https://api-comercial.unyleya.com.br/api/g1/localidade/atualizar-ultimo-lote-sincronizado");

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
}

let body = {
    "numultlotesincronizado": 2,
    "localidadesG1Sincronizadas": "[1, 2, 3]",
    "sincronizarUnicaLocalidade": true
}

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "tipo": 1,
    "titulo": "Sucesso",
    "mensagem": "Operação realizada com sucesso",
    "dados": "null"
}

Example response (400):

{
    "tipo": 2,
    "titulo": "Aviso",
    "mensagem": "API Comercial | As localidades não foram encontradas no G1!",
    "dados": "null"
}

Example response (500):

{
    "tipo": 0,
    "titulo": "Erro",
    "mensagem": "API Comercial | Não foi possível atualizar o último lote sincronizado com o G2 na localidade G1.",
    "dados": "Undefined index: localidadesG1Sincronizadas_"
}

HTTP Request

POST api/g1/localidade/atualizar-ultimo-lote-sincronizado

Body Parameters

Parameter Type Status Description
numultlotesincronizado integer required Nº. do último lote sincronizado com o G2.
localidadesG1Sincronizadas array required IDs das localidades G1 que foram sincronizadas com o G2.
sincronizarUnicaLocalidade boolean optional Quando valor = 1, indica que a sincronização é específica de uma localidade. Valores permitidos: 1 ou 0.

Matrícula

Class MatriculaController

Pré-matrícula básica.

Realiza o cadastro da pré-matrícula básica no G1.

Importante: este método foi reescrito com base na funcionalidade existente no Actor. Lógicas e peculiaridades mantidas. Para mais informações sobre o método original, confira no repositório do Actor o método inserirPreMatricula da classe ServiceMatriculaDAO.class.php.

Example request:

curl -X POST "https://api-comercial.unyleya.com.br/api/g1/matricula/criar-pre-matricula-basica" \
    -H "Content-Type: application/json" \
    -d '{"codcurso":3212,"codentidadeorigem":112,"codformulario":1,"codhorariopreferencial":2,"coduf":31,"desemail":"aluno@gmail.com","id_produto":987,"idemunicipioendereco":3147105,"nompessoa":"Jo\u00e3o Mendes Carvalho","numcelular":123456789,"numddd":37,"numtelefone":123456789}'

const url = new URL("https://api-comercial.unyleya.com.br/api/g1/matricula/criar-pre-matricula-basica");

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
}

let body = {
    "codcurso": 3212,
    "codentidadeorigem": 112,
    "codformulario": 1,
    "codhorariopreferencial": 2,
    "coduf": 31,
    "desemail": "aluno@gmail.com",
    "id_produto": 987,
    "idemunicipioendereco": 3147105,
    "nompessoa": "Jo\u00e3o Mendes Carvalho",
    "numcelular": 123456789,
    "numddd": 37,
    "numtelefone": 123456789
}

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

"Pré-matrícula(s) 1558928 salva(s) com sucesso."

Example response (503):

{
    "tipo": 0,
    "titulo": "Parâmetros inválidos",
    "mensagem": "O campo numtelefone é obrigatório."
}

HTTP Request

POST api/g1/matricula/criar-pre-matricula-basica

Body Parameters

Parameter Type Status Description
codcurso integer optional Código do curso. É necessário informá-lo caso o parâmetro id_produto não seja informado.
codentidadeorigem integer required Código da entidade de origem.
codformulario integer required Código do formulário (com base na tabela formulario).
codhorariopreferencial integer required Código do horário preferencial (com base na gt_horariopreferencial).
coduf integer required ID da Unidade da Federação [UF] (estado) com base no código do IGBE (https://www.ibge.gov.br/explica/codigos-dos-municipios.php).
desemail string required E-mail válido do aluno.
id_produto integer optional ID do produto. É necessário informá-lo caso o parâmetro codcurso não seja informado.
idemunicipioendereco integer required ID do município com base no código do IBGE. (https://www.ibge.gov.br/explica/codigos-dos-municipios.php).
nompessoa string required Nome da pessoa, com tamanho máximo de 80 caracteres.
numcelular integer required Número do celular com 8 ou 9 dígitos.
numddd integer required DDD com 2 dígitos.
numtelefone integer required Número do telefone fixo com 8 ou 9 dígitos.

Pré-matrícula de afiliados.

Example request:

curl -X POST "https://api-comercial.unyleya.com.br/api/g1/matricula/criar-pre-matricula-afiliado" \
    -H "Content-Type: application/json" \
    -d '{"pessoa":{"numcpf":"25618056038","nompessoa":"Mateus Mendes Carvalho","nommae":"Maria Joana","nompai":"Jonas Alves Pereira","flasexo":"M","numidentidade":"27.641.703-3","dessiglaorgaoemissor":"SSP-MG","datemissao":"2003-08-19","datnascimento":"2003-08-19","tiposanguineo":"1","fatorrh":"N","codufnaturalidade":"MG","idemunicipionaturalidade":3147105,"desendereco":"Rua Castelo Branco","numendereco":"16","nombairro":"Nossa Senhora das Gra\u00e7as","descompendereco":"Apartamento 103","coduf":"MG","idemunicipioendereco":"3147105","numcep":"35660000","desenderecocorrespondencia":"Rua Castelo Branco","numenderecococorrespondencia":"16","nombairrococorrespondencia":"Nossa Senhora das Gra\u00e7as","descompenderecocorrespondencia":"Apartamento 103","codufcocorrespondencia":"MG","idemunicipiococorrespondencia":"3147105","numcepcorrespondencia":"35660000","numdddcelular":"37","numcelular":123456789,"numdddtelefone":"37","numtelefone":"123456789","numdddtelefonecomercial":"37","numtelefonecomercial":"123456789","numdddfax":"37","numfax":"123456789","desemail":"aluno@gmail.com","desemailalternativo":"emailalternativo@gmail.com","codnivel":4,"descursoconclusao":"Geografia","desfaculdadeconclusao":"Faculdade Unyleya","deslocaltrabalho":"Correios"},"atendimento":{"datrecebimentodoc":"2020-08-19","bl_docanalisado":true},"negociacaocurso":{"codcurso":25426,"codpromocao":1270,"vlrnegociado":"1704.50"},"planopgto":{"qtdparcelas":5,"vlrparcela":"340.90"}}'

const url = new URL("https://api-comercial.unyleya.com.br/api/g1/matricula/criar-pre-matricula-afiliado");

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
}

let body = {
    "pessoa": {
        "numcpf": "25618056038",
        "nompessoa": "Mateus Mendes Carvalho",
        "nommae": "Maria Joana",
        "nompai": "Jonas Alves Pereira",
        "flasexo": "M",
        "numidentidade": "27.641.703-3",
        "dessiglaorgaoemissor": "SSP-MG",
        "datemissao": "2003-08-19",
        "datnascimento": "2003-08-19",
        "tiposanguineo": "1",
        "fatorrh": "N",
        "codufnaturalidade": "MG",
        "idemunicipionaturalidade": 3147105,
        "desendereco": "Rua Castelo Branco",
        "numendereco": "16",
        "nombairro": "Nossa Senhora das Gra\u00e7as",
        "descompendereco": "Apartamento 103",
        "coduf": "MG",
        "idemunicipioendereco": "3147105",
        "numcep": "35660000",
        "desenderecocorrespondencia": "Rua Castelo Branco",
        "numenderecococorrespondencia": "16",
        "nombairrococorrespondencia": "Nossa Senhora das Gra\u00e7as",
        "descompenderecocorrespondencia": "Apartamento 103",
        "codufcocorrespondencia": "MG",
        "idemunicipiococorrespondencia": "3147105",
        "numcepcorrespondencia": "35660000",
        "numdddcelular": "37",
        "numcelular": 123456789,
        "numdddtelefone": "37",
        "numtelefone": "123456789",
        "numdddtelefonecomercial": "37",
        "numtelefonecomercial": "123456789",
        "numdddfax": "37",
        "numfax": "123456789",
        "desemail": "aluno@gmail.com",
        "desemailalternativo": "emailalternativo@gmail.com",
        "codnivel": 4,
        "descursoconclusao": "Geografia",
        "desfaculdadeconclusao": "Faculdade Unyleya",
        "deslocaltrabalho": "Correios"
    },
    "atendimento": {
        "datrecebimentodoc": "2020-08-19",
        "bl_docanalisado": true
    },
    "negociacaocurso": {
        "codcurso": 25426,
        "codpromocao": 1270,
        "vlrnegociado": "1704.50"
    },
    "planopgto": {
        "qtdparcelas": 5,
        "vlrparcela": "340.90"
    }
}

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "tipo": 1,
    "titulo": "Sucesso",
    "mensagem": "Pré-matrícula completa 12347852 salva com sucesso.",
    "dados": null
}

Example response (400):

{
    "tipo": 0,
    "titulo": "Erro",
    "mensagem": "Não foi possível continuar a pré-matrícula.",
    "dados": "Detalhes: O valor negociado não condiz com a soma das parcelas informadas."
}

Example response (500):

{
    "tipo": 0,
    "titulo": "Erro",
    "mensagem": "Não foi possível realizar a pré-matrícula.",
    "dados": "Detalhes: Undefined index: tiposanguineo"
}

HTTP Request

POST api/g1/matricula/criar-pre-matricula-afiliado

Body Parameters

Parameter Type Status Description
pessoa.numcpf string required Número do CPF da pessoa, sem pontuação e hifens. 11 caracteres.
pessoa.nompessoa string required Nome da pessoa, com tamanho máximo de 80 caracteres.
pessoa.nommae string required Nome completo da mãe do aluno.
pessoa.nompai string optional Nome completo do pai do aluno.
pessoa.flasexo string required Sexo do aluno. Apenas 1 caractere (M/F).
pessoa.numidentidade string required Número da identidade do aluno. Não há padrão (se é inserido com pontuação ou hifens - ou não) ou limite de caracteres.
pessoa.dessiglaorgaoemissor string required Órgão emissor da identidade do aluno.
pessoa.datemissao string required Data de emissão da identidade do aluno no formato YYYY-MM-DD.
pessoa.datnascimento string required Data de nascimento do aluno no formato YYYY-MM-DD.
pessoa.tiposanguineo string optional Tipo Sanguíneo do aluno. Informe 1 para tipo A, 2 para tipo B, 3 para tipo AB e 4 para tipo O.
pessoa.fatorrh string optional Fator RH do aluno. Informe N para Negativo, P para Positivo ou X para Não Informado.
pessoa.codufnaturalidade string required Sigla da Unidade da Federação [UF] (Estado) de nascimento do aluno.
pessoa.idemunicipionaturalidade integer required Código do município de nascimento do aluno (Baseado no IBGE: https://www.ibge.gov.br/explica/codigos-dos-municipios.php).
pessoa.desendereco string required Endereço de residência do aluno. Máximo de 80 caracteres.
pessoa.numendereco string required Número do endereço de residência do aluno. Máximo de 5 caracteres numéricos.
pessoa.nombairro string required Nome do bairro de residência do aluno. Máximo de 50 caracteres.
pessoa.descompendereco string required Complemento do endereço de residência do aluno. Máximo de 50 caracteres.
pessoa.coduf string required Sigla da Unidade da Federação [UF] (Estado) de residência do aluno.
pessoa.idemunicipioendereco string required Código do município de residência do aluno (Baseado no IBGE: https://www.ibge.gov.br/explica/codigos-dos-municipios.php).
pessoa.numcep string required Número do CEP do endereço de residencia do aluno. Tamanho máximo de 8 caracteres numéricos.
pessoa.desenderecocorrespondencia string required Endereço de correspondência do aluno. Máximo de 80 caracteres.
pessoa.numenderecococorrespondencia string required Número do endereço de correspondência do aluno. Máximo de 5 caracteres numéricos.
pessoa.nombairrococorrespondencia string required Nome do bairro do endereço de correspondência do aluno. Máximo de 50 caracteres.
pessoa.descompenderecocorrespondencia string required Complemento do endereço de correspondência do aluno. Máximo de 50 caracteres.
pessoa.codufcocorrespondencia string required Sigla da Unidade da Federação [UF] (Estado) do endereço de correspondência do aluno.
pessoa.idemunicipiococorrespondencia string required Código do município de correspondência do aluno, fornecido pelo IBGE (https://www.ibge.gov.br/explica/codigos-dos-municipios.php).
pessoa.numcepcorrespondencia string required Número do CEP do endereço de correspondência do aluno. Tamanho máximo de 8 caracteres numéricos.
pessoa.numdddcelular string required DDD do celular do aluno.
pessoa.numcelular integer required Número do celular do aluno com 8 ou 9 dígitos.
pessoa.numdddtelefone string optional DDD do telefone residencial do aluno.
pessoa.numtelefone string optional Número do telefone residencial do aluno com 8 ou 9 dígitos.
pessoa.numdddtelefonecomercial string optional DDD do número do telefone comercial do aluno.
pessoa.numtelefonecomercial string optional Número do telefone comercial do aluno com 8 ou 9 dígitos.
pessoa.numdddfax string optional DDD do número do FAX do aluno.
pessoa.numfax string optional Número do FAX do aluno com 8 ou 9 dígitos.
pessoa.desemail string required Endereço de e-mail válido do aluno.
pessoa.desemailalternativo string optional Endereço de e-mail alternativo do aluno.
pessoa.codnivel integer optional Código do grau de instrução do aluno (3: Ensino Médio, 4: Ensino Superior (Graduado) etc., com base na tabela nivel do G1) .
pessoa.descursoconclusao string optional Descrição do último curso superior concluído pelo aluno.
pessoa.desfaculdadeconclusao string optional Nome da Instituição que o aluno concluiu o último curso superior.
pessoa.deslocaltrabalho string optional Nome da empresa que o aluno trabalha.
atendimento.datrecebimentodoc string required Data de recebimento dos documentos do aluno no formato YYYY-MM-DD.
atendimento.bl_docanalisado boolean required Marcação de status da documentação do aluno. Se os documentos estiverem analisados e conferidos, envie 1 como parâmetro, caso contrário, envie 0.
negociacaocurso.codcurso integer required Código do curso do aluno.
negociacaocurso.codpromocao integer required Código da campanha (no banco do G1, a nomenclatura é "promocao").
negociacaocurso.vlrnegociado string required Valor negociado (total) da pré-matrícula, com os centavos separados por um ponto. Valor negociado = valor total das parcelas (qtdparcelas * vlrparcela).
planopgto.qtdparcelas integer required Quantidade de parcelas do plano de pagamento.
planopgto.vlrparcela string required Valor das parcelas do plano de pagamento, com os centavos separados por um ponto.

Registrar Mensagens de Atendimento

Registra mensagens trocadas por serviços de atendimento externos (como o BlipChat), criando uma nova interação na pré-matrícula - que pode ser visualizada no G1.

Example request:

curl -X POST "https://api-comercial.unyleya.com.br/api/g1/matricula/registrar-mensagens-atendimento" \
    -H "Content-Type: application/json" \
    -d '{"codprematricula":54588999,"mensagens":{"data":"15\/01\/20","hora":"21:30","mensagem":"Por gentileza, gostaria que voc\u00eas me informassem o valor integral do curso de Administra\u00e7\u00e3o.","numtelefone":11999998888,"remetente":"Maria Joana"}}'

const url = new URL("https://api-comercial.unyleya.com.br/api/g1/matricula/registrar-mensagens-atendimento");

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
}

let body = {
    "codprematricula": 54588999,
    "mensagens": {
        "data": "15\/01\/20",
        "hora": "21:30",
        "mensagem": "Por gentileza, gostaria que voc\u00eas me informassem o valor integral do curso de Administra\u00e7\u00e3o.",
        "numtelefone": 11999998888,
        "remetente": "Maria Joana"
    }
}

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

POST api/g1/matricula/registrar-mensagens-atendimento

Body Parameters

Parameter Type Status Description
codprematricula integer required Código da pré-matrícula (codboleto no banco do G1).
mensagens.data string optional Data do envio da mensagem.
mensagens.hora string optional Hora de envio da mensagem.
mensagens.mensagem string optional Corpo da mensagem.
mensagens.numtelefone integer optional Telefone do remetente (com DDD).
mensagens.remetente string optional Nome do remetente.

Consultar situação da pré-matrícula

Permite que os afiliados consultem a situação em que se encontram as pré-matrículas cadastradas por eles.

Observação: O nomsituacaocadastro no retorno, se refere ao campo onde a situação da pré-matrícula é armazenada, na tabela situacaocadastro no banco G1.

Example request:

curl -X GET -G "https://api-comercial.unyleya.com.br/api/g1/matricula/consultar-situacao-pre-matricula" \
    -H "Content-Type: application/json" \
    -d '{"codPreMatricula":54588999}'

const url = new URL("https://api-comercial.unyleya.com.br/api/g1/matricula/consultar-situacao-pre-matricula");

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
}

let body = {
    "codPreMatricula": 54588999
}

fetch(url, {
    method: "GET",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "nomsituacaocadastro": "Finalizada"
}

Example response (503):

{
    "tipo": 0,
    "titulo": "Erro",
    "mensagem": "Não foi possível consultar a situação da pré-matrícula informada!"
}

Example response (500):

{
    "message": "Server Error"
}

HTTP Request

GET api/g1/matricula/consultar-situacao-pre-matricula

Body Parameters

Parameter Type Status Description
codPreMatricula integer required Código da pré-matrícula (codboleto no banco do G1).

Cadastrar documentação do aluno

Possibilita o cadastro dos documentos requeridos ao aluno através da integração com o sistema CloudDocs.

Example request:

curl -X POST "https://api-comercial.unyleya.com.br/api/g1/matricula/cadastrar-documentos-clouddocs" \
    -H "Content-Type: application/json" \
    -d '{"numcontrato":"09978","nompessoa":"Matheus Vitor","numcpf":"13962678674","observacao":"Documento de identidade antigo.","documento":"ratione","classificacao":"020572","complemento":"tenetur"}'

const url = new URL("https://api-comercial.unyleya.com.br/api/g1/matricula/cadastrar-documentos-clouddocs");

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
}

let body = {
    "numcontrato": "09978",
    "nompessoa": "Matheus Vitor",
    "numcpf": "13962678674",
    "observacao": "Documento de identidade antigo.",
    "documento": "ratione",
    "classificacao": "020572",
    "complemento": "tenetur"
}

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "Resultado": "OK",
    "URL": "http:\/\/ww2.clouddocs.com.br\/DownloadArquivo.aspx?CLIENTE=3743464537484677536a733d&ID=74484269315967644173413d"
}

Example response (503):

{
    "tipo": 0,
    "titulo": "Erro",
    "mensagem": "Não foi possível cadastrar o documento."
}

HTTP Request

POST api/g1/matricula/cadastrar-documentos-clouddocs

Body Parameters

Parameter Type Status Description
numcontrato string optional Número do contrato.
nompessoa string required Nome do aluno.
numcpf string required CPF do aluno, sem pontos e sem hífen.
observacao string optional Observações sobre o documento cadastrado.
documento string required Documento a ser cadastrado na base ClouDocs. (É necessário que o arquivo tenha a extensão .PDF e que seja enviado em formato base64)
classificacao numeric required Classificação do documento através da sua categoria.
complemento string optional Complemento para a descrição do documento.

Verificar duplicidade.

Verifica a existência dos dados passados na requisição, em pré-marículas já cadastradas no banco do G1.

Example request:

curl -X GET -G "https://api-comercial.unyleya.com.br/api/g1/matricula/verificar-duplicidade" \
    -H "Content-Type: application/json" \
    -d '{"nompessoa":"Welinton Junior","numtelefone":"37999648722","desemail":"291222380@homologa.com"}'

const url = new URL("https://api-comercial.unyleya.com.br/api/g1/matricula/verificar-duplicidade");

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
}

let body = {
    "nompessoa": "Welinton Junior",
    "numtelefone": "37999648722",
    "desemail": "291222380@homologa.com"
}

fetch(url, {
    method: "GET",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "codaluno": "291222380",
    "codboleto": "55348325",
    "codentidade": "112",
    "datatualizacao": "2019-09-24 16:20:58.450",
    "desemail": "291222380@homologa.com",
    "desemailalternativo": null,
    "nomatendente": "SILVANIA MARIA SILVA",
    "nomentidade": "FACULDADE UNYLEYA",
    "nomnucleotelemarketing": "Núcleo de Telemarketing - RH",
    "nompessoa": "MATHEUS DA SILVA",
    "numcelular": "999999999",
    "numcpf": "79911447677",
    "numdddcelular": "",
    "numdddtelefone": "37",
    "numtelefone": "999999999",
    "situacao": "Confirmado",
    "cursos": [
        {
            "codcurso": "24446",
            "destitulo": "2018 - Big Data (Ciência de Dados)"
        }
    ],
    "dadoscoincidentes": {
        "nompessoa": "MATHEUS DA SILVA",
        "numtelefone": "999999999",
        "numcelular": "999999999",
        "desemail": null,
        "desemailalternativo": null
    }
}

Example response (503):

{
    "tipo": 0,
    "titulo": "Erro",
    "mensagem": "Não foi possível consultar a duplicidade dos dados."
}

Example response (500):

{
    "message": "Server Error"
}

HTTP Request

GET api/g1/matricula/verificar-duplicidade

Body Parameters

Parameter Type Status Description
nompessoa string required Nome do aluno.
numtelefone string required Número de telefone/celular do aluno. Caracteres que não sejam numéricos não serão considerados.
desemail string required Endereço de e-mail do aluno.

Pré-matrícula pendente para um consultor.

Realiza o cadastro da pré-matrícula básica com status pendente para um consultor no banco do G1.

Example request:

curl -X POST "https://api-comercial.unyleya.com.br/api/g1/matricula/criar-pre-matricula-pendente-para-consultor" \
    -H "Content-Type: application/json" \
    -d '{"nompessoa":"Lucas Willian","numdddcelular":37,"numcelular":999642087,"desemail":"2156317@homologa.com","codatendente":572812}'

const url = new URL("https://api-comercial.unyleya.com.br/api/g1/matricula/criar-pre-matricula-pendente-para-consultor");

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
}

let body = {
    "nompessoa": "Lucas Willian",
    "numdddcelular": 37,
    "numcelular": 999642087,
    "desemail": "2156317@homologa.com",
    "codatendente": 572812
}

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "datvencimento": "2020-02-09",
    "codentidade": 1583,
    "codpessoa": 291301636,
    "codboleto": 55428641,
    "flasituacao": "D"
}

Example response (503):

{
    "tipo": 0,
    "titulo": "Parâmetros inválidos",
    "mensagem": "Não foi possível realizar a pré-matrícula."
}

HTTP Request

POST api/g1/matricula/criar-pre-matricula-pendente-para-consultor

Body Parameters

Parameter Type Status Description
nompessoa string required Nome do aluno.
numdddcelular integer required DDD do celular.
numcelular integer required Número do celular.
desemail string required Endereço de e-mail.
codatendente integer required Código do atendente.

Cadastro de responsável financeiro pessoa jurídica.

Realiza a criação de um novo responsável financeiro do tipo pessoa jurídica, substitui o(s) responsável(is) financeiro(s) atuais e altera o responsável das parcelas da pré-matrícula.

Observação: O responsável do tipo pessoa jurídica é uma entidade no G1.

Example request:

curl -X POST "https://api-comercial.unyleya.com.br/api/g1/matricula/criar-responsavel-financeiro-pessoa-juridica" \
    -H "Content-Type: application/json" \
    -d '{"codboleto":54588999,"codagencia":98,"codbanco":340,"codentidadecadastradora":112,"coduf":"MG","descompendereco":"Sala Comercial","desemail":"responsavel@dominioresponsavel.com","desendereco":"Rua Rubi","desurl":"entidade.com.br","flaconvenio":"N","idemunicipioendereco":3147105,"nombairro":"Nossa Senhora das Gra\u00e7as","nomentidade":"Unyleya","nomrazaosocial":"Unyleya Cursos S.A","numcep":35660000,"numcgc":54829201000125,"numcontacorrente":1912,"numdddtelefone":37,"numdvcontacorrente":9,"numendereco":54,"numfax":32324021,"numtelefone":99987545}'

const url = new URL("https://api-comercial.unyleya.com.br/api/g1/matricula/criar-responsavel-financeiro-pessoa-juridica");

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
}

let body = {
    "codboleto": 54588999,
    "codagencia": 98,
    "codbanco": 340,
    "codentidadecadastradora": 112,
    "coduf": "MG",
    "descompendereco": "Sala Comercial",
    "desemail": "responsavel@dominioresponsavel.com",
    "desendereco": "Rua Rubi",
    "desurl": "entidade.com.br",
    "flaconvenio": "N",
    "idemunicipioendereco": 3147105,
    "nombairro": "Nossa Senhora das Gra\u00e7as",
    "nomentidade": "Unyleya",
    "nomrazaosocial": "Unyleya Cursos S.A",
    "numcep": 35660000,
    "numcgc": 54829201000125,
    "numcontacorrente": 1912,
    "numdddtelefone": 37,
    "numdvcontacorrente": 9,
    "numendereco": 54,
    "numfax": 32324021,
    "numtelefone": 99987545
}

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "codresponsavelfinanceiro": 1507086,
    "codpessoa": null,
    "cpfpessoarepresentante": null,
    "codentidade": "16794",
    "cnpjpessoarepresentante": "72789264000187",
    "datinicio": "2020-01-07 15:30:45.850",
    "dattermino": "1900-01-01 00:00:00.000",
    "percentual": "0",
    "codpessoacadastro": "341709",
    "codresponsabilidadefinanceira": null,
    "codboleto": "85983",
    "codatendimento": "29306",
    "datcadastro": "2020-01-07 15:30:45.850",
    "datatualiza": null
}

Example response (503):

{
    "tipo": 0,
    "titulo": "Parâmetros inválidos",
    "mensagem": "O campo codboleto é obrigatório."
}

HTTP Request

POST api/g1/matricula/criar-responsavel-financeiro-pessoa-juridica

Body Parameters

Parameter Type Status Description
codboleto integer required Código da pré-matrícula (Campo codboleto da tabela gt_boleto do banco do G1).
codagencia integer optional Código da agência bancária do responsável financeiro.
codbanco integer optional Código do banco do responsável financeiro.
codentidadecadastradora integer optional Código da Entidade que está cadastrando o responsável financeiro.
coduf string required Sigla da Unidade da Federação [UF] (estado).
descompendereco string optional Complemento de endereço do responsável financeiro.
desemail string optional E-mail válido do responsável financeiro.
desendereco string required Endereço do responsável financeiro.
desurl string optional Site do responsável financeiro.
flaconvenio string optional Informa se o responsável financeiro tem convênio. Apenas um caractere (S/N).
idemunicipioendereco integer required Código do município de residência do responsável financeiro, fornecido pelo IBGE (https://www.ibge.gov.br/explica/codigos-dos-municipios.php).
nombairro string required Bairro do responsável financeiro.
nomentidade string required Nome do responsável financeiro.
nomrazaosocial string required Razão Social.
numcep integer required Número do CEP do endereço do responsável financeiro. Tamanho máximo: 8 caracteres numéricos.
numcgc integer required Número do CNPJ/CGC do responsável financeiro.
numcontacorrente integer optional Número da conta corrente do responsável financeiro.
numdddtelefone integer optional DDD do número de telefone do responsável financeiro.
numdvcontacorrente integer optional Número do dígito verificador da conta corrente do responsável financeiro.
numendereco integer optional Número do endereço do responsável financeiro.
numfax integer optional Número de fax do responsável financeiro (8 dígitos).
numtelefone integer optional Número de telefone do responsável financeiro (8 ou 9 dígitos).

Cadastro de responsável financeiro pessoa física

Realiza a criação de um novo responsável financeiro do tipo pessoa física, substitui o(s) responsável(is) financeiro(s) atuais e altera o responsável das parcelas da pré-matrícula.

Example request:

curl -X POST "https://api-comercial.unyleya.com.br/api/g1/matricula/criar-responsavel-financeiro-pessoa-fisica" \
    -H "Content-Type: application/json" \
    -d '{"codboleto":54588999,"coduf":"MG","codufcorrespondencia":"MG","codufnaturalidade":"MG","datemissao":"2003-08-19","datnascimento":"2003-08-19","descompendereco":"Sala Comercial","descompenderecocorrespondencia":"Sala Comercial","desemail":"fulano@gmail.com","desemailalternativo":"fulano@gmail.com","desendereco":"Rua Safira","desenderecocorrespondencia":"Rua Safira","dessiglaorgaoemissor":"SSP-MG","flasexo":"M","idemunicipiococorrespondencia":"3147105","idemunicipioendereco":"3147105","idemunicipionaturalidade":"3147105","nombairro":"Nossa Senhora das Gra\u00e7as","nombairrococorrespondencia":"Nossa Senhora das Gra\u00e7as","nommae":"Maria das Dores","nompessoa":"Lucas Junior Dias de Paula","numcelular":3799987545,"numcep":35660000,"numcepcorrespondencia":35660000,"numcpf":25618056038,"numdddfax":37,"numdddtelefone":37,"numendereco":10,"numenderecococorrespondencia":10,"numfax":32379546,"numidentidade":"27.641.703-3","numtelefone":99987545,"numtelefonecomercial":3799987545}'

const url = new URL("https://api-comercial.unyleya.com.br/api/g1/matricula/criar-responsavel-financeiro-pessoa-fisica");

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
}

let body = {
    "codboleto": 54588999,
    "coduf": "MG",
    "codufcorrespondencia": "MG",
    "codufnaturalidade": "MG",
    "datemissao": "2003-08-19",
    "datnascimento": "2003-08-19",
    "descompendereco": "Sala Comercial",
    "descompenderecocorrespondencia": "Sala Comercial",
    "desemail": "fulano@gmail.com",
    "desemailalternativo": "fulano@gmail.com",
    "desendereco": "Rua Safira",
    "desenderecocorrespondencia": "Rua Safira",
    "dessiglaorgaoemissor": "SSP-MG",
    "flasexo": "M",
    "idemunicipiococorrespondencia": "3147105",
    "idemunicipioendereco": "3147105",
    "idemunicipionaturalidade": "3147105",
    "nombairro": "Nossa Senhora das Gra\u00e7as",
    "nombairrococorrespondencia": "Nossa Senhora das Gra\u00e7as",
    "nommae": "Maria das Dores",
    "nompessoa": "Lucas Junior Dias de Paula",
    "numcelular": 3799987545,
    "numcep": 35660000,
    "numcepcorrespondencia": 35660000,
    "numcpf": 25618056038,
    "numdddfax": 37,
    "numdddtelefone": 37,
    "numendereco": 10,
    "numenderecococorrespondencia": 10,
    "numfax": 32379546,
    "numidentidade": "27.641.703-3",
    "numtelefone": 99987545,
    "numtelefonecomercial": 3799987545
}

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "codresponsavelfinanceiro": 1507085,
    "codpessoa": "291301602",
    "cpfpessoarepresentante": "12344469605",
    "codentidade": null,
    "cnpjpessoarepresentante": null,
    "datinicio": "2020-01-07 14:04:30.047",
    "dattermino": "1900-01-01 00:00:00.000",
    "percentual": "0",
    "codpessoacadastro": "341709",
    "codresponsabilidadefinanceira": null,
    "codboleto": "85983",
    "codatendimento": "29306",
    "datcadastro": "2020-01-07 14:04:30.047",
    "datatualiza": null
}

Example response (503):

{
    "tipo": 0,
    "titulo": "Parâmetros inválidos",
    "mensagem": "O campo codboleto é obrigatório."
}

HTTP Request

POST api/g1/matricula/criar-responsavel-financeiro-pessoa-fisica

Body Parameters

Parameter Type Status Description
codboleto integer required Código da pré-matrícula (Campo codboleto da tabela gt_boleto do banco do G1).
coduf string required Sigla da Unidade da Federação [UF] (estado) do endereço residencial do responsável financeiro.
codufcorrespondencia string optional Sigla da Unidade da Federação [UF] (estado) para entrega de correspondência.
codufnaturalidade string required Sigla da Unidade da Federação [UF] (estado) da cidade de nascimento do responsável financeiro.
datemissao string optional Data de emissão da carteira de identidade do responsável financeiro. Formato: YYYY-MM-DD.
datnascimento string required Data de nascimento do responsável financeiro. Formato: YYYY-MM-DD.
descompendereco string optional Complemento de endereço do responsável financeiro.
descompenderecocorrespondencia string optional Complemento de endereço para entrega de correspondência do responsável financeiro.
desemail string required Endereço eletrônico válido do responsável financeiro.
desemailalternativo string optional Endereço eletrônico alternativo válido do responsável financeiro.
desendereco string required Endereço residencial do responsável financeiro.
desenderecocorrespondencia string optional Endereço para entrega de correspondência do responsável financeiro.
dessiglaorgaoemissor string optional Orgão Emissor do documento de identidade do responsável financeiro.
flasexo string required Gênero do responsável financeiro. (M/F).
idemunicipiococorrespondencia string optional Código do município para entrega de correspondência do responsável financeiro, fornecido pelo IBGE (https://www.ibge.gov.br/explica/codigos-dos-municipios.php).
idemunicipioendereco string required Código do município de residência do responsável financeiro, fornecido pelo IBGE (https://www.ibge.gov.br/explica/codigos-dos-municipios.php).
idemunicipionaturalidade string required Código do município de nascimento do responsável financeiro, fornecido pelo IBGE (https://www.ibge.gov.br/explica/codigos-dos-municipios.php).
nombairro string optional Bairro de residência do responsável financeiro.
nombairrococorrespondencia string optional Bairro para entrega de correspondência do responsável financeiro.
nommae string required Nome da mãe do responsável financeiro.
nompessoa string required Nome do responsável financeiro.
numcelular integer required Número de celular do responsável financeiro.
numcep integer required Número do CEP do endereço residencial do responsável financeiro. Tamanho máximo: 8 caracteres numéricos.
numcepcorrespondencia integer optional Número do CEP do endereço para entrega de correspondência do responsável financeiro. Tamanho máximo: 8 caracteres numéricos.
numcpf integer required Número do CPF do responsável financeiro, sem pontuação e hifens. 11 caracteres.
numdddfax integer optional Código de fax do responsável financeiro.
numdddtelefone integer optional Código de celular do responsável financeiro.
numendereco integer optional Número do endereço residencial do responsável financeiro.
numenderecococorrespondencia integer optional Número do endereço para entrega de correspondência do responsável financeiro.
numfax integer optional Número de fax do responsável financeiro (8 dígitos).
numidentidade string required Número da identidade do responsável financeiro.
numtelefone integer optional Número de telefone do responsável financeiro (8 ou 9 dígitos).
numtelefonecomercial integer optional Número de telefone comercial do responsável financeiro.

Robô para processar as pré-matrículas vindas das LPs

do Indique Fácil.

Example request:

curl -X POST "https://api-comercial.unyleya.com.br/api/g1/afiliacao/robo-processar-prematriculas-indique-facil/1" 
const url = new URL("https://api-comercial.unyleya.com.br/api/g1/afiliacao/robo-processar-prematriculas-indique-facil/1");

let headers = {
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "POST",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

POST api/g1/afiliacao/robo-processar-prematriculas-indique-facil/{codboleto?}

Pessoa

Class Pessoa

Função responsavel por cadastrar uma pessoa no cadastro de afiliado através do iDevAffiliate.

Example request:

curl -X POST "https://api-comercial.unyleya.com.br/api/pessoa/criar-pessoa-affiliate" \
    -H "Content-Type: application/json" \
    -d '{"affiliate_id":"100","first_name":"consectetur","last_name":"neque"}'

const url = new URL("https://api-comercial.unyleya.com.br/api/pessoa/criar-pessoa-affiliate");

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
}

let body = {
    "affiliate_id": "100",
    "first_name": "consectetur",
    "last_name": "neque"
}

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

POST api/pessoa/criar-pessoa-affiliate

Body Parameters

Parameter Type Status Description
affiliate_id required optional string - ID da pessoa na plataforma iDevAffiliate.
first_name required optional string - primeiro nome do usuario. Exemple: João
last_name required optional string - ultimo nome do usuario Exemple: João

Unyflow

Campanhas disponíveis


Requires authentication Busca campanhas G2 disponíveis para integrar com o unyflow.

Example request:

curl -X GET -G "https://api-comercial.unyleya.com.br/api/unyflow/campanhas-g2-disponiveis?id_entidade=12&id_campanhacomercial=123&bl_recentes=false" 
const url = new URL("https://api-comercial.unyleya.com.br/api/unyflow/campanhas-g2-disponiveis");

    let params = {
            "id_entidade": "12",
            "id_campanhacomercial": "123",
            "bl_recentes": "false",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "current_page": 1,
    "data": [
        {
            "id_campanhacomercial": 4469,
            "st_campanhacomercial": "Campanha teste",
            "id_entidade": 352,
            "dt_inicio": "2025-07-24 16:50:00.0000000",
            "dt_fim": "2026-02-01 16:53:00.0000000",
            "id_tipocampanha": 3,
            "nu_valordesconto": 15.18,
            "id_situacao": 41
        }
    ],
    "first_page_url": "http:\/\/api-comercial-manutencao.unyleya.xyz\/api\/unyflow\/campanhas-g2-disponiveis?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "http:\/\/api-comercial-manutencao.unyleya.xyz\/api\/unyflow\/campanhas-g2-disponiveis?page=1",
    "next_page_url": null,
    "path": "http:\/\/api-comercial-manutencao.unyleya.xyz\/api\/unyflow\/campanhas-g2-disponiveis",
    "per_page": 100,
    "prev_page_url": null,
    "to": 1,
    "total": 1
}

Example response (418):

{
    "tipo": 2,
    "titulo": "Parâmetros inválidos",
    "mensagem": "O campo bl recentes deve ser verdadeiro ou falso.",
    "dados": null
}

Example response (500):

{
    "tipo": 0,
    "titulo": "Erro",
    "mensagem": "mensagem de erro",
    "dados": null
}

Example response (403):

{
    "tipo": 0,
    "titulo": "Erro ao validar o Token",
    "mensagem": "Wrong number of segments",
    "dados": null
}

HTTP Request

GET api/unyflow/campanhas-g2-disponiveis

Query Parameters

Parameter Status Description
id_entidade optional integer ID entidade G2. Obrigatório se não for informado o ID campanha G2.
id_campanhacomercial optional integer ID da campanha comercial G2.
bl_recentes optional boolean Por padrão (true), busca apenas as campanhas recém-criadas/atualizadas.

Campanhas indisponíveis


Requires authentication Busca campanhas G2 que se tornaram indisponíveis para integrar com o unyflow.

Example request:

curl -X GET -G "https://api-comercial.unyleya.com.br/api/unyflow/campanhas-g2-indisponiveis?id_entidade=12&id_campanhacomercial=%5B123%2C+125%5D" 
const url = new URL("https://api-comercial.unyleya.com.br/api/unyflow/campanhas-g2-indisponiveis");

    let params = {
            "id_entidade": "12",
            "id_campanhacomercial": "[123, 125]",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "current_page": 1,
    "data": [
        {
            "id_campanhacomercial": 1920,
            "st_campanhacomercial": "Campanha teste",
            "id_entidade": 352,
            "dt_inicio": "2018-06-22 06:23:00.0000000",
            "dt_fim": "2026-07-31 16:33:00.0000000",
            "id_tipocampanha": 2,
            "nu_valordesconto": 40.47,
            "id_situacao": 42,
            "bl_disponivel": 0
        }
    ],
    "first_page_url": "http:\/\/api-comercial-manutencao.unyleya.xyz\/api\/unyflow\/campanhas-g2-indisponiveis?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "http:\/\/api-comercial-manutencao.unyleya.xyz\/api\/unyflow\/campanhas-g2-indisponiveis?page=1",
    "next_page_url": null,
    "path": "http:\/\/api-comercial-manutencao.unyleya.xyz\/api\/unyflow\/campanhas-g2-indisponiveis",
    "per_page": 100,
    "prev_page_url": null,
    "to": 1,
    "total": 1
}

Example response (418):

{
    "tipo": 2,
    "titulo": "Parâmetros inválidos",
    "mensagem": "O campo id entidade deve ser um número inteiro.",
    "dados": null
}

Example response (500):

{
    "tipo": 0,
    "titulo": "Erro",
    "mensagem": "mensagem de erro",
    "dados": null
}

Example response (403):

{
    "tipo": 0,
    "titulo": "Erro ao validar o Token",
    "mensagem": "Wrong number of segments",
    "dados": null
}

HTTP Request

GET api/unyflow/campanhas-g2-indisponiveis

Query Parameters

Parameter Status Description
id_entidade optional integer ID entidade G2. Obrigatório se não for informado o ID campanha G2.
id_campanhacomercial optional array[int] IDs de campanhas comerciais G2. Máximo de 2.000 itens no array.

Convênios disponíveis


Requires authentication Busca convênios G1 disponíveis para integrar com o unyflow.

Example request:

curl -X GET -G "https://api-comercial.unyleya.com.br/api/unyflow/convenios-g1-disponiveis?codconvenio=123&bl_recentes=false" 
const url = new URL("https://api-comercial.unyleya.com.br/api/unyflow/convenios-g1-disponiveis");

    let params = {
            "codconvenio": "123",
            "bl_recentes": "false",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "current_page": 1,
    "data": [
        {
            "codconvenio": 12123,
            "codentidade": 112,
            "nomconvenio": "PE - SINPRF - SINDICATO DOS POLICIAIS RODOVIÁRIOS FEDERAIS NO ESTADO DE PERNAMBUCO",
            "flasituacao": "A"
        }
    ],
    "first_page_url": "http:\/\/api-comercial-manutencao.unyleya.xyz\/api\/unyflow\/convenios-g1-disponiveis?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "http:\/\/api-comercial-manutencao.unyleya.xyz\/api\/unyflow\/convenios-g1-disponiveis?page=1",
    "next_page_url": null,
    "path": "http:\/\/api-comercial-manutencao.unyleya.xyz\/api\/unyflow\/convenios-g1-disponiveis",
    "per_page": 1000,
    "prev_page_url": null,
    "to": 1,
    "total": 1
}

Example response (418):

{
    "tipo": 2,
    "titulo": "Parâmetros inválidos",
    "mensagem": "O campo bl recentes deve ser verdadeiro ou falso.",
    "dados": null
}

Example response (500):

{
    "tipo": 0,
    "titulo": "Erro",
    "mensagem": "mensagem de erro",
    "dados": null
}

Example response (403):

{
    "tipo": 0,
    "titulo": "Erro ao validar o Token",
    "mensagem": "Wrong number of segments",
    "dados": null
}

HTTP Request

GET api/unyflow/convenios-g1-disponiveis

Query Parameters

Parameter Status Description
codconvenio optional integer ID do convênio G1.
bl_recentes optional boolean Por padrão (true), busca apenas os convênios recém-criados/atualizados.

Convênios indisponíveis


Requires authentication Busca convênios G1 que se tornaram indisponíveis para integrar com o unyflow.

Example request:

curl -X GET -G "https://api-comercial.unyleya.com.br/api/unyflow/convenios-g1-indisponiveis?codconvenio=%5B123%2C+125%5D" 
const url = new URL("https://api-comercial.unyleya.com.br/api/unyflow/convenios-g1-indisponiveis");

    let params = {
            "codconvenio": "[123, 125]",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "current_page": 1,
    "data": [
        {
            "codconvenio": 4473,
            "codentidade": 686,
            "nomconvenio": "Maria do Amparo - GOFE",
            "flasituacao": "I",
            "bl_disponivel": 0
        }
    ],
    "first_page_url": "http:\/\/api-comercial-manutencao.unyleya.xyz\/api\/unyflow\/convenios-g1-indisponiveis?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "http:\/\/api-comercial-manutencao.unyleya.xyz\/api\/unyflow\/convenios-g1-indisponiveis?page=1",
    "next_page_url": null,
    "path": "http:\/\/api-comercial-manutencao.unyleya.xyz\/api\/unyflow\/convenios-g1-indisponiveis",
    "per_page": 100,
    "prev_page_url": null,
    "to": 1,
    "total": 1
}

Example response (418):

{
    "tipo": 2,
    "titulo": "Parâmetros inválidos",
    "mensagem": "O campo codconvenio deve ser uma matriz.",
    "dados": null
}

Example response (500):

{
    "tipo": 0,
    "titulo": "Erro",
    "mensagem": "mensagem de erro",
    "dados": null
}

Example response (403):

{
    "tipo": 0,
    "titulo": "Erro ao validar o Token",
    "mensagem": "Wrong number of segments",
    "dados": null
}

HTTP Request

GET api/unyflow/convenios-g1-indisponiveis

Query Parameters

Parameter Status Description
codconvenio optional array[int] IDs de convênios G1. Máximo de 2.000 itens no array.

general

Cria uma OrigemVenda no G2

[Cria uma venda no G2 e retorna os dados da mesma para prosseguir com o processo de compra]

Example request:

curl -X POST "https://api-comercial.unyleya.com.br/api/g2/negociacao/criar" \
    -H "Content-Type: application/json" \
    -d '{"id_usuario":13,"id_produto":20}'

const url = new URL("https://api-comercial.unyleya.com.br/api/g2/negociacao/criar");

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
}

let body = {
    "id_usuario": 13,
    "id_produto": 20
}

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

null

Example response (418):

{
    "tipo": 2,
    "titulo": "Aviso",
    "mensagem": "mensagem de Aviso"
}

Example response (503):

{
    "tipo": 0,
    "titulo": "Erro",
    "mensagem": "Mensagem de Erro"
}

HTTP Request

POST api/g2/negociacao/criar

Body Parameters

Parameter Type Status Description
id_usuario integer required ID do Usuário.
id_produto integer required ID do Produto.

Retornar alunos Hubspot

Retorna dados dos alunos de acordo com uma entidade passada.

Example request:

curl -X POST "https://api-comercial.unyleya.com.br/api/g2/hubspot/retornar-alunos" \
    -H "Content-Type: application/json" \
    -d '{"id_entidade":1408,"dt_final":"10\/12\/2018","dt_inicio":"10\/12\/2018","quantidade":10,"sg_uf":"DF","skip":10,"st_areaconhecimento":"Cursos de Extens\u00e3o","st_evolucao":"Cursando","st_projetopedagogico":"2019 - REDA\u00c7\u00c3O OFICIAL"}'

const url = new URL("https://api-comercial.unyleya.com.br/api/g2/hubspot/retornar-alunos");

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
}

let body = {
    "id_entidade": 1408,
    "dt_final": "10\/12\/2018",
    "dt_inicio": "10\/12\/2018",
    "quantidade": 10,
    "sg_uf": "DF",
    "skip": 10,
    "st_areaconhecimento": "Cursos de Extens\u00e3o",
    "st_evolucao": "Cursando",
    "st_projetopedagogico": "2019 - REDA\u00c7\u00c3O OFICIAL"
}

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

null

Example response (400):

{
    "tipo": 2,
    "titulo": "Aviso",
    "mensagem": "O campo id entidade é obrigatório.",
    "dados": null
}

HTTP Request

POST api/g2/hubspot/retornar-alunos

Body Parameters

Parameter Type Status Description
id_entidade integer required ID da entidade a ser pesquisada.
dt_final string optional Data final de matrícula na filtragem.
dt_inicio string optional Data inicial de matrícula na filtragem.
quantidade integer optional Quantidade de dados que serão retornados. Faixa entre 1 - 100
sg_uf string optional Sigla da Unidade Federativa.
skip integer optional Ignora os 'n' primeiros registros da consulta.
st_areaconhecimento string optional Área de conhecimento.
st_evolucao string optional Evolução da matrícula.
st_projetopedagogico string optional Projeto pedagógico.

Verifica os alunos aptos a renovar no IMP e busca os valores para a renovação

[Verifica os alunos aptos a renovar no IMP e busca os valores para a renovação]

Example request:

curl -X POST "https://api-comercial.unyleya.com.br/api/imp/verifica-renovacao" \
    -H "Content-Type: application/json" \
    -d '{"id_matricula":"rerum","id_produto":7}'

const url = new URL("https://api-comercial.unyleya.com.br/api/imp/verifica-renovacao");

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
}

let body = {
    "id_matricula": "rerum",
    "id_produto": 7
}

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

null

Example response (503):

null

HTTP Request

POST api/imp/verifica-renovacao

Body Parameters

Parameter Type Status Description
id_matricula array(integer) optional ID do Usuário.
id_produto integer required ID do Produto.

api/unyflow/ofertas/cursos

Example request:

curl -X GET -G "https://api-comercial.unyleya.com.br/api/unyflow/ofertas/cursos" 
const url = new URL("https://api-comercial.unyleya.com.br/api/unyflow/ofertas/cursos");

let headers = {
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (403):

{
    "tipo": 0,
    "titulo": "Erro ao validar o Token",
    "mensagem": "Wrong number of segments",
    "dados": null
}

HTTP Request

GET api/unyflow/ofertas/cursos

api/unyflow/ofertas/cursos/{id_projetopedagogico}/grade

Example request:

curl -X GET -G "https://api-comercial.unyleya.com.br/api/unyflow/ofertas/cursos/1/grade" 
const url = new URL("https://api-comercial.unyleya.com.br/api/unyflow/ofertas/cursos/1/grade");

let headers = {
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (403):

{
    "tipo": 0,
    "titulo": "Erro ao validar o Token",
    "mensagem": "Wrong number of segments",
    "dados": null
}

HTTP Request

GET api/unyflow/ofertas/cursos/{id_projetopedagogico}/grade

bash javascript