Atenção! Essa versão da API será descontinuada, confira a nova documentação: https://docs.rubeus.com.br/api_crm/apresentacao/

Integrar canais de captação com o CRM Rubeus (API)

Esta API permite o envio de novas oportunidades para o CRM Rubeus. É possível gerenciar direto pela aplicação todas as ações que serão desencadeadas a partir da chegada da nova oportunidade. Antes de iniciar a integração é preciso ter acesso ao um token (chave de acesso única) que deve ser informada a cada requisição. Para obter um token de acesso solicite ao seu respectivo contato da conta.

Atenção: Existem tokens diferentes para o ambiente de homologação e o ambiente de produção.

Modelo de retorno

A API retorna um objeto JSON sempre com o atributo “success” informando se a ação foi concluída com sucesso. Caso não seja possível concluir, os erros serão informados. Todos os dados necessários após o sucesso do método estão dentro do atributo “dados”.

A variável “errors” sempre retorna os erros no formato de texto, já a variável “erro” é utilizada para retornar um array de erros, normalmente relacionada aos parâmetros que devem ser preenchidos.

{"success":false,"errors":"Email já existe no sistema","dados":[],"erro":[]}

Pessoas

Método para cadastro de pessoas no CRM Rubeus. Segue abaixo os dados necessários para o cadastro.

Cadastro de pessoas
URL: [DOMINIO]/api/Pessoa/cadastro
Retorno: Código da pessoa.
codigo Formato: Texto.

Chave única de identificação externa da pessoa enviada.

Opcional.

nome Formato: Texto.

Nome da pessoa.

Obrigatório.

dataNascimento Formato: data (Y-m-d)

Data de nascimento.

telefonePrincipal Formato: Texto.

Telefone principal de contato. O sistema permite o cadastro de mais de um telefone para a pessoa.

Atenção: No cadastro de pessoa é obrigatório informar o e-mail principal ou o telefone principal.

emailPrincipal Formato: Texto.

E-mail principal de contato. O sistema permite o cadastro de mais de um e-mail para a pessoa.

Atenção: No cadastro de pessoa é obrigatório informar o e-mail principal ou o telefone principal.

telefone Formato: Array.

É possível enviar uma lista de telefones secundários para o cadastro de pessoa.

email Formato: Array.

É possível enviar uma lista de telefones secundários para o cadastro de pessoa.

cpf Formato: Inteiro.

CPF da pessoa.

endereco Formato: Texto.

Endereço. Limite de caracteres: 255.

numero Formato: Inteiro.

Número (endereço).

bairro Formato: Texto.

Bairro. Limite de caracteres: 45.

sexo Formato: Inteiro.
Para informar o Sexo utilize:1 para Masculino. 2 para Feminino.
imagemUrl Formato: Texto.

URL para foto de perfil da pessoa.

Em alguns casos a pessoa pode já está cadastrada em um sistema e ter uma foto de perfil. Caso esteja disponível para acesso externo basta informar a url de acesso.

estadoCidade Formato: Objeto.

Deve ser informado um objeto com os dados necessários para vincular a pessoa a uma cidade.

Segue abaixo o exemplo.

{  
   “cidade”: “Rio de Janeiro”,
   “estado”: “RJ”
}

Se não for encontrada uma cidade com esse nome nessa UF a pessoa não será vinculada a uma cidade.

evento Formato: Objeto.

Deve ser informado um objeto com os dados necessários para criar um evento ao realizar o cadastro da pessoa.

Segue abaixo o exemplo.

{
   "tipo": 1,
   "descricao": "<p>Cadastrou-se</p>",
   "codOferta": 1,
   "codCurso": 1
}

 

Atenção: Informe o codOferta e codCurso caso queira que o evento seja vinculado ao curso.

 camposPersonalizados  Formato: Objeto.

Os nomes das colunas dos campos personalizados são informados no método Instituicao/campoPersonalizado.

Os campos devem ser informados como no exemplo abaixo:

camposPersonalizados : { coluna: "teste" }
origem Formato: Inteiro.

Código de identificação do canal criado. Os canais são disponibilizados durante a implantação. Esse código deve ser solicitado ao seu gerente de conta.

Obrigatório.

token Formato: Texto.

Chave de acesso única informada pelo contato da sua conta.

Atenção: Caso não tenha o token solicite ao seu contato da conta.

Obrigatório.

 

Dados da pessoa
URL: [DOMINIO]/api/Pessoa/dadosPessoa
Retorno:

{
 "id": "155",
 "nome": "Nome Exemplo",
 "nomeSocial": null,
 "codigo": "Código externo da pessoa",
 "imagem": "Url da imagem de perfil",
 "cpf": "977.250.067-10",
 "datanascimento": "1996-07-02",
 "endereco": "Rua Heitor Tadeu",
 "numero": "752",
 "bairro": "Barra",
 "cidade": "2354",
 "cidadeNome": "Sete Lagoas - MG",
 "sexo": "1",
 "sexoNome": "Masculino",
 "origem": "Origem",
 "origemNome": "Nome da origem",
 "mesclada": "1 para se está pessado já foi mesclada com alguma, 0 para não",
 "camposPersonalizados": [{
 "nome": "Campo Personalizado",
 "coluna": "campopersonalizado",
 "tipo": "1",
 "valor": "valor"
 }],
 "telefones": {
 "principal": {
 "id": "1534",
 "telefone": "(31)154689835"
 },
 "secundarios": [{}]
 },
 "emails": {
 "principal": {
 "id": "1598",
 "email": "email@email.com"
 },
 "secundarios": [{
 "id": "1600",
 "email": "email2@email.com"
 }]
 }
}
codigo Formato: Texto.

Chave única de identificação externa da pessoa enviada.

Opcional.

id Formato: Inteiro.

Código de identificação da pessoa no CRM.

Opcional.

origem Formato: Inteiro.

Código de identificação do canal criado. Os canais são disponibilizados durante a implantação. Esse código deve ser solicitado ao seu gerente de conta.

Obrigatório.

token Formato: Texto.

Chave de acesso única informada pelo contato da sua conta.

Atenção: Caso não tenha o token solicite ao seu contato da conta.

Obrigatório.

Eventos

Método para cadastro de eventos no CRM Rubeus. Os eventos são exibidos na linha do tempo da pessoa e também são utilizados como gatilhos na persona.

Segue abaixo os dados necessários para o cadastro.

Cadastro de Eventos
URL: [DOMINIO]/api/Evento/cadastro
Retorno: Dados do evento
codigo Formato: Texto.

Chave única de identificação do evento enviado.

Atenção: Caso queira editar um evento criado basta informar o código do evento criado.

tipo Formato: Inteiro.

Código de identificação do tipo do evento. Para listar e cadastrar um Tipo de Evento utilize os seguintes métodos:

Listar Tipos de Eventos:[DOMINIO]/api/Evento/listarTipoEvento

Cadastrar Tipos de Eventos:[DOMINIO]/api/Evento/cadastroTipoEvento

Obrigatório.

descricao Formato: Texto (HTML).

A Descrição pode ser enviada no formato HTML para deixar a apresentação dos dados do evento na linha do tempo mais organizados.

É opcional o envio com as tags HTML.

Obrigatório.

pessoa Formato: Array.

Vincule a pessoa ao evento, esse código é o código que foi enviado ao cadastrar a pessoa pela API. Veja abaixo um exemplo do formato para envio.

{
   "codigo": chave única de identificação da pessoa;
}

 

Obrigatório.

codOferta Formato: Texto.

Código de identificação da oferta do curso.

Atenção: O código da oferta do curso e o código do curso são obrigatórios para vincular o evento ao um curso no

CRM Rubeus.

codCurso Formato: Texto.

Código de identificação do curso.

data Formato: Data e tempo (Y-m-d H:i:s).

A data do evento é utilizada para configurar gatilhos na persona que são disparados X (tempo) antes da data enviada.

Essa data é muito utilizada para atividades como data da prova, entrevista e visitas dos candidatos.

tipoData Formato: Texto.

O tipo da data tem o propósito de diferenciar os eventos com datas um do outro caso seja usado mais de uma atividade. Para a data da atividade funcionar corretamente este campo é necessário.

momento Formato: Data e tempo (Y-m-d H:i:s).

Momento no qual o evento ocorreu. Caso não seja informado o sistema irá informar a data e hora atual.

notaEnem Formato: Inteiro.

A nota do enem é usada para ser vinculada a oportunidade caso o evento esteja vinculado a um curso.

camposPersonalizados Formato: Objeto.

Os nomes das colunas dos campos personalizados são informados no método Instituicao/campoPersonalizado.

Os campos devem ser informados como no exemplo abaixo:

camposPersonalizados : { coluna: "teste" }
dadosOportunidade Formato: Objeto.

Serve para poder enviar os dados da oportunidade caso queira alterá-la.

Deve ser enviado como no exemplo abaixo:

dadosOportunidade : {codOferta: "codigoOferta", codCurso: "codigoCurso", codPessoa: "codigoPessoa"}
origem Formato: Inteiro.

Código de identificação do canal criado. Os canais são disponibilizados durante a implantação. Esse código deve ser solicitado ao seu gerente de conta.

Obrigatório.

token Formato: Texto.

Chave de acesso única informada pelo contato da sua conta.

Atenção: Caso não tenha o token solicite ao seu contato da conta.

Obrigatório.

Tipos de Evento

Os tipos de eventos são utilizados para categorizar os eventos externos enviados por cada canal de captação.

Segue abaixo os dados necessários para o cadastro.

Cadastro de Tipos de Evento
URL: [DOMINIO]/api/Evento/cadastroTipoEvento
Retorno: Código do tipo de evento.
titulo Formato: Texto.

Título para o tipo do evento. Limite de caracteres: 255.

Obrigatório.

fluxo Formato: Inteiro.

Campo que identifica se o evento faz parte do fluxo de compra do cliente ou não. Caso faça, ele será respeitado na condição da persona que verifica a quanto tempo ele não avança no fluxo.

1 para Sim.

0 para Não.

Padrão: 0.

origem Formato: Inteiro.

Código de identificação do canal criado. Os canais são disponibilizados durante a implantação. Esse código deve ser solicitado ao seu gerente de conta.

Obrigatório;

token Formato: Texto.

Chave de acesso única informada pelo contato da sua conta.

Atenção: Caso não tenha o token solicite ao seu contato da conta.

Obrigatório.

Cadastro de cursos

O sistema entende que um curso pode ser ofertado em diversos momentos e com variações. Para isso é preciso primeiro cadastrar o curso para depois cadastrar suas ofertas.

Segue abaixo os dados necessários para cadastrar um curso.

Cadastro de Curso
URL: [DOMINIO]/api/Curso/cadastroCurso
Retorno: Código do curso.
nome Formato: Texto.

Nome do curso. Limite de caracteres: 255.

Obrigatório.

descricao Formato: Texto.

Descrição do curso. Limite de caracteres: 500.

codigo Formato: Inteiro.

Chave única de identificação externa do curso que será utilizada para fazer os vínculos no CRM Rubeus.

Obrigatório.

origem Formato: Inteiro.

Código de identificação do canal criado. Os canais são disponibilizados durante a implantação. Esse código deve ser solicitado ao seu gerente de conta.

Obrigatório.

token Formato: Texto.

Chave de acesso única informada pelo contato da sua conta.

Atenção: Caso não tenha o token solicite ao seu contato da conta.

Obrigatório.

 

Cadastro de ofertas de curso

Após realizar o cadastro do curso, você pode cadastrar suas ofertas. É a oferta de curso que fica vinculada a oportunidade.

Segue abaixo os dados necessários para cadastrar um curso.

Cadastro de Oferta de Curso
URL: [DOMINIO]/api/Curso/cadastroOferta
Retorno: Código da oferta do curso.
nome Formato: Texto.

Nome do curso.

Limite de caracteres: 255.

Obrigatório.

complemento Formato: Texto.

Limite de caracteres: 255.

Este campo é para diferenciar de forma rápida as ofertas do mesmo curso. Por exemplo: “Como falar em público – Intensivo” ou “Como falar em público – Final de Semana”.

Atenção: Seja qual for o complemento que queira usar, lembre que a equipe comercial vai ver ele quando tiver duas ofertas com o mesmo nome do curso.

valor Formato: Real(Float).

Valor referente ao que a oportunidade gerada a partir deste curso representa (valor do contrato).

vagasMinimas Formato: Inteiro.

Mínimo de vagas que deverão ser preenchidas do curso.

Atenção: Esses dados podem ser utilizados nos fluxos de automação para configurar comportamentos automatizados a partir do preenchimento das vagas.

vagasMaximas Formato: Inteiro.

Máximo de vagas que poderão ser preenchidas do curso.

Atenção: Esses dados podem ser utilizados nos fluxos de automação para configurar comportamentos automatizados a partir do preenchimento das vagas.

inicioInscricao Formato: Data (Y-m-d).

Data de início das inscrições.

terminoInscricao Formato: Data (Y-m-d).

Data de término das inscrições.

inicioMatricula Formato: Data (Y-m-d).

Data de início das matrículas.

terminoMatricula Formato: Data (Y-m-d).

Data de término das matrículas.

inicioCurso Formato: Data (Y-m-d).

Data de início do curso.

terminoCurso Formato: Data (Y-m-d).

Data de término do curso.

modalidade Formato: Inteiro.

Código único de identificação da modalidade obtido através do método abaixo no CRM Rubeus.

Consulta modalidades.[DOMINIO]/api/Curso/listarModalidades

codOferta Formato: Inteiro.

Código externo de identificação única da oferta do curso cadastrada. Esse código poderá ser utilizado em futuros envios impedindo que a oferta seja duplicada.

Obrigatório.

codCurso Formato: Texto.

O curso pai pode ser adicionado no momento do cadastro da oferta caso ele já não tenha sido cadastrado pelo método Curso/cadastroCurso”.

Para cadastrar ele basta informar também os campos “nomeCurso” e “descricaoCurso”.

Caso já tenha cadastrado o curso pai, basta informar o codCurso com o código definido no cadastro.

Atenção: É obrigatório estar vinculado a um curso pai.

nomeCurso Formato: Texto.

Nome do curso pai.

Atenção: Deve ser informado caso queira adicionar o curso pai junto com o cadastro da oferta. Caso já tenha cadastrado o curso pai basta informar o codCurso.

descricaoCurso Formato: Texto.

Descrição do curso pai.

Atenção: Deve ser informado caso queira adicionar o curso pai junto com o cadastro da oferta. Caso já tenha cadastrado o curso pai basta informar o codCurso.

codUnidade Formato: Inteiro.

Código único para identificação da unidade que está ofertando o curso atual.

Para visualizar e cadastrar as unidades no CRM Rubeus utilize os métodos abaixo.

[DOMINIO]/api/Unidade/listarUnidades

Obrigatório.

Atenção:

codLocalOferta Formato: Array.

Array com os códigos externos de identificação do local de oferta cadastrado. 

Obrigatório.

codNivelEnsino Formato: Inteiro.

Código único de identificação do nível de ensino.

Para visualizar e cadastrar as unidades no CRM Rubeus utilize os métodos abaixo.

[DOMINIO]/api/Oportunidade/listarNiveisEnsino

Obrigatório.

codProcessoSeletivo Formato: Inteiro.

Código único de identificação do processo seletivo.

Para visualizar os códigos dos processos seletivos utilize a aplicação.

origem Formato: Inteiro.

Código de identificação do canal criado. Os canais são disponibilizados durante a implantação. Esse código deve ser solicitado ao seu gerente de conta.

Obrigatório.

token Formato: Texto.

Chave de acesso única informada pelo contato da sua conta.

Atenção: Caso não tenha o token solicite ao seu contato da conta.

Obrigatório.

Cadastro de Processo seletivo

As ofertas de curso podem ser vinculadas a processos seletivos. Cadastre os processos seletivos e depois vincule eles na oferta de cursos.

Segue abaixo os dados necessários para cadastrar um processo seletivo no CRM Rubeus.

Cadastro de Processo Seletivo
URL: [DOMINIO]/api/ProcessoSeletivo/cadastro
Retorno: Código do processo seletivo.
nome Formato: Texto.

Nome do processo seletivo. Limite de caracteres: 255.

Obrigatório.

descricao Formato: Texto.

Descrição do processo seletivo. Limite de caracteres: 255.

inicioInscricao Formato: Data (Y-m-d).

Data de início das inscrições.

terminoinscricao Formato: Data (Y-m-d).

Data de término das inscrições.

inicioMatricula Formato: Data (Y-m-d).

Data de início das matrículas.

terminoMatricula Formato: Data (Y-m-d).

Data de término das matrículas.

codigo Formato: Texto.

Código único para identificação do processo seletivo.

Obrigatório.

codUnidade Formato: Inteiro.

Código único para identificação da unidade que está ofertando o curso atual.

Para visualizar e cadastrar as unidades no CRM Rubeus utilize os métodos abaixo.

Obrigatório.

Atenção:

codNivelEnsino Formato: Inteiro.

Código único de identificação do nível de ensino.

Para visualizar e cadastrar as unidades no CRM Rubeus utilize os métodos abaixo.

Obrigatório.

origem Formato: Inteiro.

Código de identificação do canal criado. Os canais são disponibilizados durante a implantação. Esse código deve ser solicitado ao seu gerente de conta.

Obrigatório.

token Formato: Texto.

Chave de acesso única informada pelo contato da sua conta.

Atenção: Caso não tenha o token solicite ao seu contato da conta.

Obrigatório.

Campos personalizados

Você pode adicionar e listar campos personalizados via API. 

Segue abaixo os dados necessários para cadastrar um campo personalizado.

Cadastro de Campos Personalizados
URL: [DOMINIO]/api/Instituicao/adicionarCampo
Retorno: Dados do campo personalizado.
nome Formato: Texto.

Nome do campo personalizado. Limite de caracteres: 75.

Obrigatório.

tipo Formato: Inteiro.

Informe o tipo do campo que você está criando.

1 para Texto.
2 para Texto Longo.
3 para Número.
4 para Data.
5 para Boolean.

tipoLocal  

1 para pessoa

2 para oportunidade

Obrigatório.

origem Formato: Inteiro.

Código de identificação do canal criado. Os canais são disponibilizados durante a implantação. Esse código deve ser solicitado ao seu gerente de conta.

Obrigatório.

token Formato: Texto.

Chave de acesso única informada pelo contato da sua conta.

Atenção: Caso não tenha o token solicite ao seu contato da conta.

Obrigatório.

 

Listagem de Campos Personalizados
URL: [DOMINIO]/api/Instituicao/campoPersonalizado
Retorno: Objeto.
origem Formato: Inteiro.

Código de identificação do canal criado. Os canais são disponibilizados durante a implantação. Esse código deve ser solicitado ao seu gerente de conta.

Obrigatório.

token Formato: Texto.

Chave de acesso única informada pelo contato da sua conta.

Atenção: Caso não tenha o token solicite ao seu contato da conta.

Obrigatório.

Alterar status da oportunidade

Você pode alterar o status de uma oportunidade (ganha, perdida ou em andamento) via API. Segue abaixo os dados necessários para cadastrar um processo seletivo no CRM Rubeus.

Alterar status da oportunidade
URL: [DOMINIO]/api/Oportunidade/alterarStatus
Retorno: Boolean.
status Formato: Inteiro.

Código de identificação do novo status da oportunidade.

Utilize 1 para em andamento, 2 para ganha e 3 para perdida;

Obrigatório.

codOferta Formato: Texto.

Código de identificação da oferta de curso atual.

Obrigatório.

codCurso Formato: Texto.

Código de identificação do curso pai da oferta atual.

Obrigatório.

codPessoa Formato: Texto.

Código de identificação da pessoa vinculada a oportunidade atual atual.

Obrigatório.

objecao Formato: Inteiro.

Código de identificação da objeção. Para visualizar todas utilize o método abaixo.

[DOMINIO]/api/Objecao/listarObjecoes

observacaoPerda Formato: Texto.

Observação opcional caso o status inserido seja o de perda.

origem Formato: Inteiro.

Código de identificação do canal criado. Os canais são disponibilizados durante a implantação. Esse código deve ser solicitado ao seu gerente de conta.

Obrigatório.

token Formato: Texto.

Chave de acesso única informada pelo contato da sua conta.

Atenção: Caso não tenha o token solicite ao seu contato da conta.

Obrigatório.

Alterar pessoas na oportunidade

Alterar pessoas na oportunidade
URL: [DOMINIO]/api/Oportunidade/alterarPessoasOportunidade
Retorno: Boolean
codPessoa Formato: Texto.

Código da pessoa principal

Obrigatório.

codCurso Formato: Texto.

Código do curso principal

Obrigatório.

codOferta Formato: Texto.

Código da oferta do curso principal.

Obrigatório.

pessoas Formato: Array.

Neste modelo com as pessoas secundárias que vão ser vinculadas a oportunidade

[{

"codigo": "Somente se vier de um canal externo",

"tipo": 1

}]
observacaoPerda Formato: Texto.

Observação opcional caso o status inserido seja o de perda.

origem Formato: Inteiro.

Código de identificação do canal criado. Os canais são disponibilizados durante a implantação. Esse código deve ser solicitado ao seu gerente de conta.

Obrigatório;

token Formato: Texto.

Chave de acesso única informada pelo contato da sua conta.

Atenção: Caso não tenha o token solicite ao seu contato da conta.

Obrigatório.

Listar cursos

Listar cursos
URL: [DOMINIO]/api/Curso/listarCursos
Retorno: Objeto
codigo Formato: Texto.

Caso o código do curso seja informado será retornado apenas o curso desejado.

origem Formato: Inteiro.

Código de identificação do canal criado. Os canais são disponibilizados durante a implantação. Esse código deve ser solicitado ao seu gerente de conta.

Obrigatório.

token Formato: Texto.

Chave de acesso única informada pelo contato da sua conta.

Atenção: Caso não tenha o token solicite ao seu contato da conta.

Obrigatório.

Listar ofertas

Listar ofertas
URL: [DOMINIO]/api/Curso/listarOfertas
Retorno: Objeto
codigo Formato: Texto.

Caso o código da oferta seja informado será retornado apenas a oferta desejada.

origem Formato: Inteiro.

Código de identificação do canal criado. Os canais são disponibilizados durante a implantação. Esse código deve ser solicitado ao seu gerente de conta.

Obrigatório.

token Formato: Texto.

Chave de acesso única informada pelo contato da sua conta.

Atenção: Caso não tenha o token solicite ao seu contato da conta.

Obrigatório.

Cadastrar local oferta

Cadastrar local oferta
URL: [DOMINIO]/api/LocalOferta/cadastro
Retorno: Objeto
id Formato: Inteiro.

Código de identificação da pessoa no CRM.

  • Informe o id para editar;
  • Se o id não for informado será feito um novo cadastro.
titulo Formato: Texto.

Título para o tipo do evento. Limite de caracteres: 255.

Obrigatório.

descricao Formato: Texto (HTML).

A Descrição pode ser enviada no formato HTML para deixar a apresentação dos dados do evento na linha do tempo mais organizados.

É opcional o envio com as tags HTML.

Obrigatório.

telefone Formato: Array.

É possível enviar uma lista de telefones secundários para o cadastro de pessoa.

email Formato: Array.

É possível enviar uma lista de telefones secundários para o cadastro de pessoa.

endereco Formato: Texto.

Endereço. Limite de caracteres: 255.

numero Formato: Inteiro.

Número (endereço).

bairro Formato: Texto.

Bairro. Limite de caracteres: 45.

cep Formato: Inteiro.

CEP do endereço.

cidade Formato: Texto.

Cidade. Limite de caracteres: 255.

codigo Formato: Texto.

Chave única de identificação externa da pessoa enviada.

Obrigatório.

origem Formato: Inteiro.

Código de identificação do canal criado. Os canais são disponibilizados durante a implantação. Esse código deve ser solicitado ao seu gerente de conta.

Obrigatório.

token Formato: Texto.

Chave de acesso única informada pelo contato da sua conta.

Atenção: Caso não tenha o token solicite ao seu contato da conta.

Obrigatório.

Dados do local da oferta

Dados do local da oferta
URL: [DOMINIO]/api/LocalOferta/dadosLocalOferta
Retorno: Objeto
id Formato: Inteiro.

Código de identificação da pessoa no CRM.

Opcional.

origem Formato: Inteiro.

Código de identificação do canal criado. Os canais são disponibilizados durante a implantação. Esse código deve ser solicitado ao seu gerente de conta.

Obrigatório.

token Formato: Texto.

Chave de acesso única informada pelo contato da sua conta.

Atenção: Caso não tenha o token solicite ao seu contato da conta.

Obrigatório.

Excluir local de oferta

Excluir local de oferta
URL: [DOMINIO]/api/LocalOferta/excluirLocalOferta
Retorno: Objeto
id Formato: Inteiro.

Código de identificação da pessoa no CRM.

Opcional.

origem Formato: Inteiro.

Código de identificação do canal criado. Os canais são disponibilizados durante a implantação. Esse código deve ser solicitado ao seu gerente de conta.

Obrigatório.

token Formato: Texto.

Chave de acesso única informada pelo contato da sua conta.

Atenção: Caso não tenha o token solicite ao seu contato da conta.

Obrigatório.

Listar local de oferta

Listar local de oferta
URL: [DOMINIO]/api/LocalOferta/listarLocaisOferta
Retorno: Array de objetos
origem Formato: Inteiro.

Código de identificação do canal criado. Os canais são disponibilizados durante a implantação. Esse código deve ser solicitado ao seu gerente de conta.

Obrigatório.

token Formato: Texto.

Chave de acesso única informada pelo contato da sua conta.

Atenção: Caso não tenha o token solicite ao seu contato da conta.

Obrigatório.

Alterar código da pessoa

Alterar código da pessoa
URL: [DOMINIO]/api/Pessoa/alterarCodigo
Retorno: Objeto
codigoAntigo Formato: String.

Código enviado no cadastro da pessoa.

Obrigatório.

codigoNovo Formato: String.

Código que será substituído com base no código antigo enviado.

Obrigatório.

origem Formato: Inteiro.

Código de identificação do canal criado. Os canais são disponibilizados durante a implantação. Esse código deve ser solicitado ao seu gerente de conta.

Obrigatório.

token Formato: Texto.

Chave de acesso única informada pelo contato da sua conta.

Atenção: Caso não tenha o token solicite ao seu contato da conta.

Obrigatório.