{"info":{"_postman_id":"e1e36d20-191f-475f-9985-04dfa9fada69","name":"API CRM EDUCACIONAL","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"11860820","collectionId":"e1e36d20-191f-475f-9985-04dfa9fada69","publishedId":"Uz59MehH","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"1469E3"},"publishDate":"2022-05-24T19:21:30.000Z"},"item":[{"name":"Informações Importantes","item":[{"name":"Gerar Token Autenticação","id":"27f17c6a-6a79-4499-96b0-2ec949c282e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","type":"text"},{"key":"username","value":"usuario","type":"text"},{"key":"password","value":"senha","type":"text"},{"key":"authentication_type","value":"APICRMEducacional","type":"text"}]},"url":"https://XXXapi.crmeducacional.com/api/token","description":"

Em toda requisição à API do Captação é necessário incluir no Header um token e seu tipo.

\"username\": Usuário do CRM
\"password\": Senha do CRM
\"grant_type\": \"password\"
\"authentication_type\": \"APICRMEducacional\" ou \"CRM\"

Observação:

No parâmetro \"authentication_type\", para autenticar com um usuário do Dynamics CRM informe \"CRM\".
Para autenticar com um Usuário de Integração informe \"APICRMEducacional\".

\n","urlObject":{"protocol":"https","path":["api","token"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"27f17c6a-6a79-4499-96b0-2ec949c282e0"},{"name":"Refresh Token Autenticação","id":"a3f0fe7c-4d46-48d6-98dd-703c3829be3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"refresh_token","value":"","type":"text"},{"key":"grant_type","value":"refresh_token","type":"text"}]},"url":"https://XXXapi.crmeducacional.com/api/token","description":"

Objetivo

O Refresh token é um token especial utilizado para geração de tokens de acesso adicionais sem a necessidade de uma nova autenticação com usuário e senha para quando o access token está expirado ou simplesmente para mantê-lo atualizado.

O primeiro valor do refresh token é obtido quando se gera um token pela API Token Autenticação.

Parâmetros Necessários:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro Lógico	Descrição	Obrigatório
refresh_token	Valor do refresh_token gerado na API Gerar Token.	Sim
grant_type	refresh_token	Sim

Retorno

Variável	Descrição
access_token	Token de acesso.
token_type	Tipo do Token.
expires_in	Quantidade de segundos até a expiração.
username	Nome do usuário logado.
created_on	Data de criação do token.
expires_on	Data de expiração do token.

","urlObject":{"protocol":"https","path":["api","token"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[{"id":"cd668adc-c328-4312-9706-86df34587748","name":"Refresh Token Autenticação","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"refresh_token","value":"7e504688e69d43a4a1afe0affaf19532bc2cf1865c784fd6a5ababbd2298ec48","type":"text"},{"key":"grant_type","value":"refresh_token","type":"text"}]},"url":"https://XXXapi.crmeducacional.com/api/token"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"n7OieAwBTsrytreKywoZPqtxC2LeiDvWPc4YGASwaIdp2DdKW6jE6VCzSUn-zpZJA93pq0-rUgY1QsBbED0WkUSxE32f7iXLilGD64tm8EKI4LEK96F1ELMWEpF4fJsAXIoC_g_8Zhb5m5oNzWJ7SGKRyty0RdNM_PJwzfrFQfdKDKwxpf2u2Qgz81q2qDYxlIlBR6lom9bCp1SyhwtCMPOEPnQzl_eVIOjrcXosqRHQF50VaB5O6jRGV3WvORCEV\",\n \"token_type\": \"bearer\",\n \"expires_in\": 86399,\n \"refresh_token\": \"03d7c6424ba54b00b913d069c376dce0ff98380307e14f9597d22b22ce38acdf\",\n \"username\": \"user.exemplo@exemplo.com\",\n \"created_on\": \"18/04/2022 09:29:20 \",\n \"expires_on\": \"19/04/2022 09:29:20 \"\n}"}],"_postman_id":"a3f0fe7c-4d46-48d6-98dd-703c3829be3f"},{"name":"Criptografar String","id":"8cd51fbd-1f2a-4651-adab-c9c86e7b9f6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"access_token","value":"","type":"text"},{"key":"token_type","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"Valor\": \"abc123!*\",\r\n \"Chave\": \"chave123**&\"\r\n}"},"url":"https://XXXapi.crmeducacional.com/api/IntegracaoClientes/CriptografarString","description":"

Objetivo

Permitir a criptografia de uma valor de acordo com uma chave personalizada.

\n\n

Observações:

\n\n

Para descriptografia dos dados é necessário utilizar a API Descriptografar String. A chave a ser utilizada na descriptografia deverá ser a mesma da criptografia.

Para os métodos que a CRM realiza a criptografia, ex: Integração com sistema externo para exibição do Comprovante de Inscrição, existe uma chave padrão a ser alinhada com a CRM, uma vez que este item é utilizado em alguns pontos da ficha, caso seja necessário realizar a troca do valor, deve-se entrar em contato com a CRM para que a mesma seja atualizada também na configuração.

Valor da chave padrão: cdsftnfrmtc

Exemplo de Informação a ser enviada

Chave do Campo	Exemplo	Tipo	Obrigatório	Descrição
Valor	abc123!\\\\\\*	String	Sim	Valor a ser criptografado. Deverá ser passado entre aspas simples.
Chave	chave123**&	String	Sim	Chave a ser utilizada na criptografia. Deverá ser passado entre aspas simples.

\n\n

Possíveis retornos

Código	Descrição
200	\"{\"Mensagem\":\"Sucesso ao criptografar valor.\",\"Valor\":\"5VTLFdxw5L0CZHSgTaih9Q==\",\"Status\":\"Sucesso\"}\"
500	\"{\"Mensagem\":\"Erro ao criptografar valor. Detalhes: XXXXXXX.\",\"Status\":\"Falha\"}\"

","urlObject":{"protocol":"https","path":["api","IntegracaoClientes","CriptografarString"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8cd51fbd-1f2a-4651-adab-c9c86e7b9f6c"},{"name":"Descriptografar String","id":"5fcbf424-ee52-4979-aa55-152cb7c9ec7b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"access_token","value":"","type":"text"},{"key":"token_type","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"Valor\": \"5VTLFdxw5L0CZHSgTaih9Q==\",\r\n \"Chave\": \"chave123**&\"\r\n}"},"url":"https://XXXapi.crmeducacional.com/api/IntegracaoClientes/DescriptografarString","description":"

Objetivo

Permitir a descriptografia de uma valor de acordo com uma chave.

\n\n

Observações

Para criptografia dos dados é necessário utilizar a APICriptografar String. A chave a ser utilizada na descriptografia deverá ser a mesma da criptografia.

\n\n

Valor da chave padrão: cdsftnfrmtc

Exemplo de Informação a ser enviada

Chave do Campo	Exemplo	Tipo	Obrigatório	Descrição
Valor	abc123!\\\\\\\\\\\\\\\\\\*	String	Sim	Valor a ser descriptografado.
Chave	chave123**&	String	Sim	Chave a ser utilizada na descriptografia.

\n\n

Possíveis retornos:

Código	Descrição
200	\"{\"Mensagem\":\"Sucesso ao descriptografar valor.\",\"Valor\":\"abc123!\\\\\\\\\\\\\\\\\\*\",\"Status\":\"Sucesso\"}\"
500	\"{\"Mensagem\":\"Erro ao descriptografar valor. Detalhes: XXXXXXX.\",\"Status\":\"Falha\"}\"

","urlObject":{"protocol":"https","path":["api","IntegracaoClientes","DescriptografarString"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5fcbf424-ee52-4979-aa55-152cb7c9ec7b"}],"id":"714e9001-b9b1-45eb-8e65-da0b599b9fa1","description":"

Esta seção tem como finalidade descrever os parâmetros fundamentais para utilização das APIs (Application Programming Interface) desenvolvidas pelo CRM Educacional para integração entre os diversos sistemas de gestão acadêmica utilizados pelas instituições de ensino.

Para melhor usabilidade, os métodos foram categorizados e relacionados na entidade principal atuante, ou seja, caso exista a necessidade, por exemplo, de verificar as integrações relacionadas ao concurso, basta procurar o menu concurso. Para integrações relacionadas aos parceiros da CRM, procure no menu Integrações com Sistemas Externos de Parceiros

URL's de requisição

A URL é o ponto inicial das requisições, pois direciona o local para consumo dos serviços oferecidos pelas APIs. Para cada organização existe uma URL específica, tendo como base principal os aspectos do protocolo HTTP.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Protocolo	Endereço
HTTPS	https://XXXapi.crmeducacional.com/api/YYY
HTTP	http://XXX.api.crmeducacional.com/api/YYY

Definição:

XXX = Deverá ser preenchido com o Nome da Organização.

Exemplo:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Protocolo	URL
HTTP	http://faculdade.api.crmeducacional.com/api/LocalizacaoAvancada
HTTPS	https://faculdadeapi.crmeducacional.com/api/LocalizacaoAvancada

YYY = Deverá indicar o Nome do Método.

Exemplo:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Protocolo	URL
HTTP	http://faculdade.api.crmeducacional.com/api/LOCALIZACAOAVANCADA
HTTPS	https://faculdadesapi.crmeducacional.com/api/LOCALIZACAOAVANCADA

Também é possível identificar a URL utilizada pela organização diretamente no ambiente do CRM Educacional, para isso:

Basta ir ao menu lateral inferior esquerdo
Depois em clique em Configurações,
Posteriormente na entidade CRM Educacional,
Abra o registro relacionado ao CRM Educacional.
Na guia captação, procure o campo Endereço da Api Ficha de Inscrição.
Lá constará uma das URL's disponíveis para a organização, bastando apenas ajustar para o protocolo (HTTP ou HTTPS) desejado.

Tipos de requisições:

Os recursos das APIS CRM Educacional podem ser acessados e modificados utilizando as operações padrões do HTTP como GET, POST e PATCH.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Verbo	Descrição
`POST`	O verbo `POST` é frequentemente utilizado para criação novos recursos.
`GET`	O método `GET` é utilizado quando existe a necessidade de se obter um recurso (listar ou exibir). Ele é considerado idempotente, ou seja, independente da quantidade de vezes que for executado sob um recurso, o resultado sempre será o mesmo.
`PATCH`	O método `PATCH` é usado para modificar parcialmente os recursos. A requisição só precisa conter as alterações específicas para o recurso, não o recurso completo.

Códigos de status de respostas HTTP

É importante uma correta validação destes status HTTP, considerando que um valor maior ou igual a 300 sempre representa um erro. Os mais comuns são:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Definição
`200`	Estas requisição foi bem sucedida. O significado do sucesso varia de acordo com o método HTTP
`400`	Essa resposta significa que o servidor não entendeu a requisição pois está com uma sintaxe inválida.
`401`	Embora o padrão HTTP especifique \"unauthorized\", semanticamente, essa resposta significa \"unauthenticated\". Ou seja, o usuário deve se autenticar para obter a resposta solicitada.
`500`	Significa que alguma validação da parte do servidor não ocorreu como planejado na requisição

Autenticação / Geração de Token :

Para interagir com as APIs, será necessário a obtenção de um token de acesso temporário (24 hrs corridas) - o bearer token. Sua geração poderá ser realizada através da API Gerar Token.

Por ter tempo de expiração, sempre será necessário a geração de um novo token, porém o custo deste processo é alto, pois é preciso autentica-se novamente no CRM. Pensando nisso, a CRM também desenvolveu a API Refresh Token para otimização. Indicamos utilizar sempre que possível.

Usuário de Integração:

O usuário de integração serve justamente para fornecer os parâmetros necessários para possibilitar a geração do token. Ele é composto por um nome e senha e é criado no ambiente da CRM Educacional.

Como criar um usuário de integração:

Acesse o CRM, no menu lateral inferior esquerdo acesse o menu configurações
Posteriormente clique em usuário de integração,
Clique em novo.
Defina um Nome, Senha e o Tipo como API CRM EDUCACIONAL.

Pronto! Agora é só utilizar o nome e senha para gerar o token de acesso.

FetchXML

Em determinas APIs, existe a necessidade da utilização do FetchXML, ele é o meio estrutural que determina quais informações serão retornadas na requisição. Sua obtenção facilitada poderá ocorrer através de uma localização avançada criada no CRM / Dynamics, ou seja, lá serão apontados quais os filtros, as colunas (atributos) e os relacionamentos necessários entre as entidades, tudo de acordo com os dados demandados pelo cliente. A partir disso, será possível montar uma requisição com tais parâmetros e utilizá-los para consultas e/ou atualizações de registros em softwares terceiros.

Como gerar um FetchXML?

Logado no CRM, clique no símbolo de funil, ele fica localizado do lado direto, na parte superior.
Será aberto em uma nova guia para montagem da localização avançada.
Posteriormente é necessário definir qual será a entidade principal desejada através do campo de pesquisa Localizar. Conforme exemplo abaixo:

Exemplo para inscrição do candidato:

\n\n

4. Caso deseje adicionar filtros e/ou relacionamentos com outras entidades basta utilizar a opção selecionar disposta logo abaixo do campo localizar.

\n\n

5. Para adição/remoção das colunas (atributos), ou seja, dos dados complementares do registro principal que serão retornados na requisição, basta clicar em Editar colunas no menu superior e definir as opções.

Adição

\n\n

Remoção:

\n\n

6. Depois que a consulta da localização estiver pronta, clique no botão baixar FetchXML no menu superior.

\n\n

Resultado:

\n\n

Caso possua dúvidas ou dificuldades para geração de um fetch, entre em contato com o nosso time de suporte.

Paginação das Requisições

Ao realizar consultas nas API's CRM Educacional você pode ter uma quantidade de registros que não caiba na primeira página de resultados, nessa situação é possível realizar a paginação pelos valores da consulta
como na localização avançada dentro de seu ambiente. Para realizar a paginação dentro de suas consultas é bem fácil, você deve inserir no Header de sua consulta a chave pagina e o valor dessa chave devera ser a página que deseja visualizar referente a consulta.

\n\n\n\n\n\n\n\n\n\n\n\n\n

KEY/chave	VALUE/valor
pagina	2

Por exemplo, na ferramenta Postman ficaria assim:

\n\n

Campos - Nomenclatura e Valores Lógicos

Existem cenários que dependem da necessidade de identificação da nomenclatura lógica dos campos e alguns deles possuem vários status possíveis de serem utilizados, como exemplo temos o campo Situação no Concurso que poderá assumir valores de inscrito, convocado, matriculado, desclassificado e/ou ausente. Nestes casos, cada status possui um identificador inteiro e devem ser considerados de acordo com a requisição utilizada.

Para acessá-los, siga o passo a passo abaixo:

Clique no símbolo engrenagem localizado do lado direito do seu ambiente CRM Educacional.
Posteriormente, selecione Configurações avançadas.
Expanda o menu superior clicando na seta que aparecerá no menu de configurações.
Selecione Personalizações.
Escolha a opção Personalizar o sistema.
Em sequência será aberta uma nova guia, expanda o submenu Entidades do lado esquerdo da tela. Será aberto todas as entidades que compõem a solução do Dynamics / CRM.
Expanda novamente a entidade desejada (Ex.: lead) e clique no submenu campos.
Feito isso, será carregados todos os campos que compõem a entidade

Para o caso que utiliza valores lógicos de acordo com o status, a informação fica localizada na parte inferior do registro. Conforme exemplo abaixo:

\n\n

Como ser atendido se eu tiver Dúvidas?

Nosso time de suporte poderá te ajudar, neste caso será necessário a abertura de uma ocorrência.

• Para abrir uma ocorrência, acesse https://atendimento.crmeducacional.com/ e realize seu login.

• Em seguida, vá até: Ajuda > Suporte técnico > Abrir uma Nova Ocorrência.

Caso não possua acesso ao nosso portal de atendimento, entre em contato com o Service Desk: (31) 2516-2724 (telefone e WhatsApp)

\n","_postman_id":"714e9001-b9b1-45eb-8e65-da0b599b9fa1"},{"name":"Localização Avançada","item":[{"name":"API LocalizacaoAvancada","id":"e5fd4eba-92a8-40e3-ba89-a08dfa7120d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n","options":{"raw":{"language":"xml"}}},"url":"https://XXXapi.crmeducacional.com/api/LocalizacaoAvancada","description":"

Objetivo

Este método genérico permite a busca de dados e os seus relacionamentos no CRM Educacional/Dynamics através do FetchXML. Para saber mais sobre como extrair um FetchXML, bem como o seu relacionamento com a localização avançada, basta retornar a seção de informações importantes.

Para fins de exemplificação da utilização deste método, foi utilizado um FetchXML de uma Localização avançada na entidade Inscrição do Candidato para retorno exclusivo de todas as inscrições relacionadas as inscrições.

Mensagem de Retorno:

O Retorno se dará através de um FetchXML com os seguintes dados:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição
`cad_numeroinscricao`	NÚMERO DA INSCRIÇÃO
`cad_clientepotencialid`	LEAD VINCULADO A INSCRIÇÃO
`cad_situacao`	SITUAÇÃO NO CONCURSO
`cad_concursoid`	CONCURSO
`cad_ofertaid`	OFERTA
`coc_situacaopagamento`	SITUAÇÃO DO PAGAMENTO
`cad_situacaoavaliacao`	SITUAÇÃO DA AVALIAÇÃO
`cad_salaid`	SALA
`createdon`	DATA DA CRIAÇÃO DA INSCRIÇÃO
`cad_dadosobrigatorioscoletados`	RETORNA SE OS DADOS OBRIGATORIOS FORAM COLETADOS.
`cad_inscricaocandidatoid`	RETORNA O ID DA INSCRIÇÃO
`cad_cpf`	CPF DO LEAD INSCRITO

","urlObject":{"protocol":"https","path":["api","LocalizacaoAvancada"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e5fd4eba-92a8-40e3-ba89-a08dfa7120d6"},{"name":"Buscar Dados Candidato Por Concurso Eh CPF - API LocalizacaoAvancada","id":"74990f2b-24d2-4549-9739-129c25effdd0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n","options":{"raw":{"language":"xml"}}},"url":"https://XXXapi.crmeducacional.com/api/LocalizacaoAvancada","description":"

Objetivo:

Esta requisição segue os mesmos princípios do método API LocalizacaoAvancada (Genérica), porém a sua principal funcionalidade é para retornar inscrições do candidato em determinado concurso pelo CPF possuindo com entidades relacionadas o lead, o concurso, a oferta, e o calendário de prova.

Parâmetros Necessários:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Nome Lógico	Nome do Campo Correspondente no CRM	Tipo de informação a ser preenchida	Obrigatório
`cad_cpf`	CPF	CPF do Lead	Sim
`cad_codigo`	Código do concurso	Código do concurso que o candidato encontra-se vinculado.	Sim
`Token`	-	Token Gerado Pela API

Estes dados deverão ser modificados em value do parâmetro filter do fetchXML.

Mensagem Retorno:

Haverá campos que, mesmo inserido no FetchXML, não irá retornar valores, isso acontece o campo está vazio ou não existe o registro relacionado.

Exemplo:

Neste FetchXML de exemplo existe a busca de informações sobre o calendário de prova ligado a Inscrição do Candidato, caso o concurso referente a inscrição não seja do tipo Agendado, não haverá calendário registrado, portanto não irá retornada nada relacionado ao calendário, mesmo que esteja sendo mencionado no FetchXML.

Uma outra possibilidade, ainda neste exemplo do Calendário de Prova, pode ser que o candidato tenha parado a inscrição ainda na tela de Dados, sem ter escolhido a sua Data de Prova, em um cenário desses, também não irá retornar nenhum valor.

Entidade Inscrição do Candidato:

Campo	Descrição	Tipo
`cad_numeroinscricao`	NÚERO DA INSCRIÇÃO	STRING
`cad_trainee`	TRAINEE	STRING
`cad_linguaestrangeira`	LÍNGUA ESTRANGEIRA	STRING

\n\n

Entidade Calendário de Prova

Este calendário fica armazenado no campo \"Prova Agendada no dia\" da Inscrição do Candidato.

Campo	Descrição	Tipo
`cad_dataprova`	DATA DA PROVA	DATE
`cad_horaprova`	HORA DA PROVA	DATE
`cad_sala`	SALA	STRING
`cad_categoria`	UNIDADE DA PROVA / CATEGORIA	STRING

\n\n

Entidade Concurso:

Campo	Descrição	Tipo
`cad_codigo`	CÓDIGO	INT
`cad_nome`	NOME DO CONCURSO	STRING

\n\n

Entidade Ofertas (1ª, 2ª e 3ª Opção)

Só irá retornar se existir essas ofertas vinculadas à inscrição, para cada uma delas, irá retornar as seguintes
propriedades.

Campo	Descrição	Tipo
`cad_turnoofertado`	TURNO OFERTADO	STRING
`cad_turnoequivalente`	TURNO EQUIVALENTE	STRING
`cad_semestreofertado`	SEMESTRE OFERTADO	STRING
`cad_regime`	REGIME	INT
`cad_vagasdisponveissga`	VAGAS DISPONÍVEIS SGA	INT
`cad_vagasdisponiveis`	VAGAS DISPONÍVEIS	INT
`cad_quantidadevagas`	QUANTIDADE DE VAGAS	INT
`cad_periodo`	PERÍODO	INT
`cad_nome`	NOME	STRING
`cad_modalidade`	MODALIDADE	STRING
`cad_minimovagaspreenchidas`	MÍNIMO DE VAGAS PREENCHIDAS	INT
`cad_identificadoroferta`	IDENTIFICADOR DA OFERTA	STRING
`cad_datainicial`	DATA INICIAL	DATE
`cad_datafinal`	DATA FINAL	DATE
`cad_currequiv`	CURRÍCULO EQUIVALENTE	INT
`cad_codturno`	TURNO	INT
`cad_subformaingr`	SUB FORMA DE INGRESSO	INT
`cad_codigoocde`	CÓDIGO OCDE	STRING
`cad_codigodomec`	CÓDIGO DO MEC	INT
`cad_formaingr`	FORMA DE INGRESSO	INT
`cad_codescola`	CÓDIGO ESCOLA	INT
`cad_codcurriculo`	CÓDIGO CURRÍCULO	STRING
`cad_codcampus`	CÓDIGO CAMPUS	STRING
`cad_ano`	ANO	INT

","urlObject":{"protocol":"https","path":["api","LocalizacaoAvancada"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"74990f2b-24d2-4549-9739-129c25effdd0"},{"name":"Buscar Dados Candidato Por Inscricao - API LocalizacaoAvancada","id":"87fa7d75-8efd-454f-a4b3-fb5ed4671bd8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n","options":{"raw":{"language":"xml"}}},"url":"https://XXXapi.crmeducacional.com/api/LocalizacaoAvancada","description":"

Objetivo:

Este método segue os mesmos princípios do método API LocalizacaoAvancada (Genérica), porém a sua principal funcionalidade é para buscar informações que foram coletadas do candidato no processo seletivo, utilizando como parâmetro de busca o número de inscrição, permitindo que estas informações possam ser enviadas para o sistema de SGA.

Para buscar informações sobre classificação, existe um modelo pronto de busca chamado BuscarClassificacaoPorInscricao.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Nome Lógico	Nome do Campo Correspondente no CRM	Tipo de informação a ser preenchida
`cad_numeroinscricao`	Inscrição do candidato	Número de inscrição do candidato
`Token`		token gerado

Mensagem de Retorno:

Entidade Inscrição do Candidato:

Campo	Descrição	Tipo
`cad_numeroinscricao`	NÚMERO DA INSCRIÇÃO	STRING
`cad_trainee`	TRAINEE	STRING
`cad_linguaestrangeira`	LÍNGUA ESTRANGEIRA	STRING

\n\n

Entidade Calendário de Prova

Este calendário fica armazenado no campo \"Prova Agendada no dia\" da Inscrição do Candidato.

Campo	Descrição	Tipo
`cad_dataprova`	DATA DA PROVA	DATE
`cad_horaprova`	HORA DA PROVA	STRING
`cad_sala`	SALA	STRING
`cad_categoria`	UNIDADE DA PROVA / CATEGORIA	STRING

\n\n

Entidade Concurso:

Campo	Descrição	Tipo
`cad_codigo`	CÓDIGO	INT
`cad_nome`	NOME	STRING

\n\n

Entidade Ofertas (1ª, 2ª e 3ª Opção)

Só irá retornar se existir essas ofertas vinculadas à inscrição, para cada uma delas, irá retornar as seguintes
propriedades.

Campo	Descrição	Tipo
`cad_turnoofertado`	TURNO OFERTADO	STRING
`cad_turnoequivalente`	TURNO EQUIVALENTE	STRING
`cad_semestreofertado`	SEMESTRE OFERTADO	STRING
`cad_regime`	REGIME	INT
`cad_vagasdisponveissga`	VAGAS DISPONÍVEIS SGA	INT
`cad_vagasdisponiveis`	VAGAS DISPONÍVEIS	INT
`cad_quantidadevagas`	QUANTIDADE DE VAGAS	INT
`cad_periodo`	PERÍODO	INT
`cad_nome`	NOME	STRING
`cad_modalidade`	MODALIDADE	STRING
`cad_minimovagaspreenchidas`	MÍNIMO DE VAGAS PREENCHIDAS	INT
`cad_identificadoroferta`	IDENTIFICADOR DA OFERTA	STRING
`cad_datainicial`	DATA INICIAL	DATE
`cad_datafinal`	DATA FINAL	DATE
`cad_currequiv`	CURRÍCULO EQUIVALENTE	INT
`cad_codturno`	TURNO	INT
`cad_subformaingr`	SUB FORMA DE INGRESSO	INT
`cad_codigoocde`	CÓDIGO OCDE	STRING
`cad_codigodomec`	CÓDIGO DO MEC	INT
`cad_formaingr`	FORMA DE INGRESSO	INT
`cad_codescola`	CÓDIGO ESCOLA	INT
`cad_codcurriculo`	CÓDIGO CURRÍCULO	STRING
`cad_codcampus`	CÓDIGO CAMPUS	STRING
`cad_ano`	ANO	INT

","urlObject":{"protocol":"https","path":["api","LocalizacaoAvancada"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"87fa7d75-8efd-454f-a4b3-fb5ed4671bd8"},{"name":"Buscar Dados Cadastro Candidato - API LocalizacaoAvancada","id":"dca874c4-daf4-4648-aa07-a31f1c67229f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"bearer p_9b1it8kWX0QhVwuifia-2B9JK4sLpaM19GXzQFblHJ7nPW6p8EHPbZQU7f9ADyD27HDGh-TCmdAb10btJrIrfyLA-oOH3s5oETRp4r9jfR8oFuvNevahsmAhy7b33m8Y1KMyJBAtJgv8dfmNLEyw4UnnzEA-CtGZOHlnwV2KldxRqn4hKxL_gOEhcIssJigS4y922gX8X0H_GoDvKVLJAnvmqcD0JaRw8CdkvJ8xU"}],"body":{"mode":"raw","raw":"\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n","options":{"raw":{"language":"xml"}}},"url":"https://XXXapi.crmeducacional.com/api/LocalizacaoAvancada","description":"

Objetivo

Esta requisição segue os mesmos princípios do método API LocalizacaoAvancada (Genérica), porém a sua principal funcionalidade é para buscar informações da inscrição do candidato possuindo com entidades relacionadas o lead, o concurso, a oferta, o calendário de prova e a conta.

Parâmetros Necessários

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Nome Lógico	Nome do Campo Correspondente no CRM	Tipo de informação a ser preenchida	Obrigatório
`cad_numeroinscricao`	Número de inscrição	Número de inscrição do candidato	Sim
`cad_cpf`	CPF	CPF do Candidato	Sim
`cad_codigo`	Código do concurso	Código do concurso que o candidato encontra-se vinculado.	Sim
`Token`		Token gerado pela Api

Estes dados deverão ser modificados em value do parâmetro filter do fetchXML.

Os campos de retorno presentes na requisição foram escolhidos com base na alta frequência de demandas originadas pelos clientes. Portanto, poderá haver campos nesta relação que não fazem sentido para cenário atual da instituição.

Caso queira excluir os dados retornados, basta remover os atributos indesejados das respectivas entidades dentro do FetchXML, porém, caso queira incluir, será necessário saber exatamente qual é o nome lógico do campo para inseri-lo como novo atributo.

Para mais informações sobre o FetchXmL e como obter os nomes lógicos do campos volte na seção informações importantes.

Mensagem Retorno:

Caso os valores obrigatórios não sejam informados, será retornado a seguinte mensagem de erro: Nenhuma informação encontrada

Haverá campos que, mesmo inserido no FetchXML, não irão retornar valores, quando isso acontece é porque o campo está vazio ou não existe o registro relacionado no CRM.

Neste FetchXML utilizado na requisição, existe a busca de informações sobre o calendário de prova vinculado a Inscrição do Candidato, caso o concurso referente a inscrição não seja do tipo Agendado, não haverá calendário registrado, portanto não irá retornar nenhuma informação relacionada ao calendário, mesmo que esteja sendo mencionado no FetchXML.

Relação de campos retornados para Inscrição do Candidato:

Campo	Descrição	Tipo
`cad_numeroinscricao`	NÚMERO DA INSCRIÇÃO	STRING
`cad_clientepotencialid`	GUID DO INTERESSADO	STRING
`cad_situacao`	SITUAÇÃO NO CONCURSO	STRING
`cad_dadosobrigatorioscoletados`	DADOS OBRIGATÓRIOS COLETADOS	INT
`coc_situacaopagamento`	SITUACAO DE PAGAMENTO	STRING
`cad_situacaoavaliacao`	SITUAÇÃO DE AVALIAÇÃO	STRING
`cad_dadosobrigatorioscoletados`	DADOS OBRIGATÓRIOS COLETADOS	STRING
`cad_trainee`	TRAINEE	STRING
`cad_linguaestrangeira`	LINGUA ESTRANGEIRA	STRING
`cad_inscriesid`	GUID DA INSCRIÇÃO DO CANDIDATO	STRING

\n\n

Relação de campos retornados para o Lead:

Campo	Descrição	Tipo
`cad_cpf`	CPF	STRING
`mobilephone`	TELEFONE CELULAR	STRING
`lastname`	SOBRENOME	STRING
`new_sexo`	SEXO	STRING
`cad_ofertaatual`	OFERTA ATUAL	STRING
`fullname`	NOME COMPLETO	STRING
`firstname`	NOME	STRING
`cad_necessidadesespeciais`	NECESSIDADES ESPECIAIS	STRING
`emailaddress1`	EMAIL	STRING
`cad_datanascimento`	DATA DE NASCIMENTO	DATE
`cad_concursodeorigem`	CONCURSO DE ORIGEM	STRING
`cad_concursoatual`	CONCURSO ATUAL	STRING

\n\n

Relação de campos retornados para o Calendário de Prova

Este calendário fica armazenado no campo \"Prova Agendada no dia\" da Inscrição do Candidato.

Campo	Descrição	Tipo
`cad_dataprova`	DATA DA PROVA	DATE
`cad_horaprova`	HORA DA PROVA	DATE
`cad_sala`	SALA	STRING
`cad_categoria`	UNIDADE DA PROVA / CATEGORIA	STRING

\n\n

Relação de campos da entidade Ofertas (1ª, 2ª e 3ª Opção)

Só irá retornar se existir essas ofertas vinculadas à inscrição, para cada uma delas, irá retornar as seguintes
propriedades.

Campo	Descrição	Tipo
`cad_turnoofertado`	TURNO OFERTADO	STRING
`cad_turnoequivalente`	TURNO EQUIVALENTE	STRING
`cad_semestreofertado`	SEMESTRE OFERTADO	STRING
`cad_regime`	REGIME	INT
`cad_vagasdisponveissga`	VAGAS DISPONÍVEIS SGA	INT
`cad_vagasdisponiveis`	VAGAS DISPONÍVEIS	INT
`cad_quantidadevagas`	QUANTIDADE DE VAGAS	INT
`cad_periodo`	PERÍODO	INT
`cad_nome`	NOME	STRING
`cad_modalidade`	MODALIDADE	STRING
`cad_minimovagaspreenchidas`	MÍNIMO DE VAGAS PREENCHIDAS	INT
`cad_identificadoroferta`	IDENTIFICADOR DA OFERTA	STRING
`cad_datainicial`	DATA INICIAL	DATE
`cad_datafinal`	DATA FINAL	DATE
`cad_currequiv`	CURRÍCULO EQUIVALENTE	INT
`cad_codturno`	TURNO	INT
`cad_subformaingr`	SUB FORMA DE INGRESSO	INT
`cad_codigoocde`	CÓDIGO OCDE	STRINGINT
`cad_codigodomec`	CÓDIGO DO MEC	INT
`cad_formaingr`	FORMA DE INGRESSO	INT
`cad_codescola`	CÓDIGO ESCOLA	INT
`cad_codcurriculo`	CÓDIGO CURRÍCULO	STRING
`cad_codcampus`	CÓDIGO CAMPUS	STRING
`cad_ano`	ANO	INT

\n\n

Relação de campos retornados para o Concurso:

Campo	Descrição	Tipo
`cad_codigo`	CÓDIGO	INT
`cad_dataprova`	DATA DA PROVA	DATE
`cad_horaprova`	HORA DA PROVA	STRING
`cad_minutosdaprova`	MINUTOS DA PROVA	STRING
`cad_nome`	NOME	STRING
`cad_tamanhoanexo`	TAMANHO MÁXIMO DO ANEXO	STRING

\n\n

Relação de campos retornados para a Conta:

Campo	Descrição	Tipo
`cad_permitiruploadprova`	PERMITE UPLOAD DE PROVA	STRING
`cad_permitirrelatorios`	PERMITE RELATÓRIOS	STRING
`name`	NOME	STRING
`accountcategorycode`	CATEGORIA DA CONTA	STRING
`cad_permitirarquivoretorno`	PERMITE ARQUIVO RETORNO	STRING

Objetivo:

Este método segue os mesmos princípios do método API LocalizacaoAvancada (Genérica), porém a sua principal finalidade é para retornar os concursos e suas respectivas informações de um determinado período letivo tendo como base também o tipo de concurso (Tradicional, Agendado, ENEM, etc).

Observação

Caso deseje realizar a busca sem parâmetros de período letivo e tipo de concurso, ou seja, trazer todos os concursos, basta remover as tags de filtro (filter) do FetchXML.

Parâmetros de entrada para os campos Período Letivo e Tipo de Concurso:

Parâmetro	Nome do Campo Correspondente no CRM	Possíveis Valores	Descrição	Obrigatório
`cad_periodoletivo`	Período Letivo			Sim
`cad_tipodeconcurso`	Tipo de Concurso	0 1 2 3 4 5 7 809.220.000 809.220.001 809.220.002	Tradicional ENEM Agendado PROUNI Pós-Graduação Cursos Livres Formulário de Interesse Transferência Diploma Medicina	Sim
`Token`	-	-	Token de acesso gerado pela API

\n\n

É possível que o campo tipo de concurso sofra modificações, do tipo exclusão ou adição de valores. Neste sentido, indicamos sempre confirmar esta informação. Para isso, em seu CRM clique no símbolo de engrenagem no menu superior direito > Clique em configurações avançadas > Personalizações > Personalizar o Sistema > No menu lateral esquerdo expandir \"entidades\" > Selecionar Concurso > Expandir o submenu concurso > Selecione o submenu Campos > Abrir o campo desejado > Verifique os valores correspondentes.

Para mais detalhes de como consultar os campos lógicos, bem como os valores disponíveis neles, acesse a seção informações importantes.

Mensagem de Retorno:

Será um FetchXML com as seguintes propriedades abaixo para cada concurso encontrado.

Campo	Descrição	Tipo
`cad_codigo`	CÓDIGO DO CONCURSO	INT
`cad_nome`	NOME DO CONCURSO	STRING
`cad_periodoletivo`	PERÍODO LETIVO DO CONCURSO	STRING
`cad_dataprova`	DATA DA PROVA DO CONCURSO	DATE
`cad_tipodeconcurso`	TIPO DO CONCURSO	STRING

Objetivo:

Esta requisição segue os mesmos princípios do método API LocalizacaoAvancada (Genérica), porém a sua principal funcionalidade é para retornar todas as ofertas em determinado concurso.

Parâmetros de Entrada

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Nome Lógico	Nome do Campo Correspondente no CRM	Tipo de informação a ser preenchida	Obrigatório
`cad_codigo`	Código do concurso	Inserir o código do concurso	Sim
`Token`	-	Token Gerado Pela API	Sim

Mensagem de Retorno:

Para cara oferta encontrada no concurso escolhido, será retornado os valores abaixo.

Campo	Descrição	Tipo
`cad_ano`	ANO	INT
`cad_categoria`	CÓDIGO CATEGORIA	INT
`cad_codcampus`	CÓDIGO CAMPUS	INT
`cad_codcurriculo`	CÓDIGO CURRICULO	INT
`cad_codcurso`	CÓDIGO CURSO	INT
`cad_codescola`	CÓDIGO ESCOLA	INT
`cad_formaingr`	FORMA INGRESSO	INT
`cad_subformaingr`	SUB FORMA INGRESSO	INT
`cad_codturno`	TURNO	INT
`cad_currequiv`	CURRÍCULO EQUIVALENTE	INT
`cad_datafinal`	DATA FINAL	DATE
`cad_datainicial`	DATA INICIAL	DATE
`cad_ofertaid`	OFERTA ID	STRING
`cad_identificadoroferta`	IDENTIFICADOR DA OFERTA	STRING
`cad_minimovagaspreenchidas`	MÍNIMO DE VAGAS PREENCHIDAS	INT
`cad_modalidade`	MODALIDADE	STRING
`cad_nome`	NOME	STRING
`cad_periodo`	PERÍODO	INT
`cad_quantidadevagas`	QUANTIDADE DE VAGAS	INT
`cad_regime`	REGIME	INT
`cad_semestreofertado`	SEMESTRE OFERTADO	STRING
`cad_turnoequivalente`	TURNO EQUIVALENTE	STRING
`cad_turnoofertado`	TURNO OFERTADO	STRING
`cad_vagasdisponiveis`	VAGAS DISPONIVEIS	INT
`cad_vagasdisponveissga`	VAGAS DISPONIVEIS SGA	INT
`cad_servicoeducacionalid`	SERVIÇO EDUCACIONAL	STRING
`cad_quantidadeparcelas`	QUANTIDADE DE PARCELAS	INT
`cad_idareainteresse`	VAGAS DISPONÍVEIS	INT
`cad_formulanotafinal`	FÓRMULA NOTA FINAL	STRING
`cad_valorparcela`	VALOR DA PARCELA	INT
`cad_categoriaid`	CATEGORIA	STRING
`cad_codigoocde`	CÓDIGO OCDE	INT
`cad_codigodomec`	CÓDIGO DO MEC	INT

Objetivo

Este método segue os mesmos princípios do método API LocalizacaoAvancada (Genérica), porém a sua principal funcionalidade é para buscar informações dos resultados das avaliações das inscrições.

Parâmetros Obrigatórios:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Nome Lógico	Nome do Campo Correspondente no CRM	Tipo de informação a ser preenchida
`cad_numeroinscricao`	Número de Inscrição	Número do candidato disponível no CRM.
`Token`		Token Gerado pela Api

Este dado deverá ser modificado em value do parâmetro filter do fetchXML.

Mensagem de Retorno:

O Retorno se dará através de um FetchXML com os seguintes dados:

Avaliação:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição	Tipo
`cad_valor`	VALOR DA AVALIAÇÃO	INT
`cad_inscricaocandidatoid`	NÚMERO DE INSCRIÇÃO	STRING
`cad_fatoravaliacaoid`	FATOR DE AVALIAÇÃO	STRING

Retorno para Inscrição:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição	Tipo
`cad_concursoid`	CONCURSO	STRING
`cad_situacao`	SITUAÇÃO DA AVALIAÇÃO	STRING
`cad_trainee`	SE A INSCRIÇÃO É TRAINEE	STRING
`cad_numeroinscricao`	NÚMERO DE INSCRIÇÃO	STRING
`cad_linguaestrangeira`	LÍNGUA ESTRANGEIRA	STRING
`cad_conta`	CONTA VINCULADA	STRING
`cad_salaid`	RETORNA A SALA	STRING
`cad_inscriesid`	PROVA AGENDADA NO DIA	STRING
`cad_ofertaid`	NOME DA OFERTA	STRING
`cad_clientepotencialid`	LEAD VINCULADO A INSCRIÇÃO	STRING
`cad_2opcaooferta`	2 ª OPÇÃO DE OFERTA (SE HOUVER)	STRING
`cad_3opcaooferta`	3 ª OPÇÃO DE OFERTA (SE HOUVER)	STRING

Objetivo

Este método retorna os números de inscrições em um determinado concurso que tiveram modificações recentes no cadastro ou na oferta, esta validação ocorre através do campo Data de Alteração do Cadastro ou Oferta modificadas no período compreendido entre a data inicial (on-or-after)e a data final (on-or-before), passadas como parâmetro na chamada do método.

Os parâmetros principais e obrigatórios para este modelo FetchXML são:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Nome Lógico	Nome do Campo Correspondente no CRM	Tipo de informação a ser preenchida
`cad_dataalteracaocadastrooferta`	Data de Alteração Cadastrou ou Oferta (Em ou depois de)	Período inicial do período desejado
`cad_dataalteracaocadastrooferta`	Data de Alteração Cadastrou ou Oferta (Em ou antes de)	Período final do período desejado
`cad_codigo`	Código de identificação	Código do concurso desejado
`Token`		Token Gerado pela Api

Estes dados devem ser modificados em value que estão localizados nos parâmetros filter pertencentes de suas respectivas entidades.

Mensagem de Retorno:

O Retorno se dará através de um FetchXML com os seguintes dados:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição	Tipo
`cad_numeroinscricao`	NÚMERO DA INSCRIÇÃO	STRING
`cad_clientepotencialid`	LEAD VINCULADO A INSCRIÇÃO	STRING
`cad_situacao`	SITUAÇÃO NO CONCURSO	STRING
`cad_concursoid`	CONCURSO	STRING
`cad_ofertaid`	OFERTA	STRING
`coc_situacaopagamento`	SITUAÇÃO DO PAGAMENTO	STRING
`cad_situacaoavaliacao`	SITUAÇÃO DA AVALIAÇÃO	STRING
`cad_salaid`	SALA	STRING
`createdon`	DATA DA CRIAÇÃO DA INSCRIÇÃO	DATE
`cad_dadosobrigatorioscoletados`	RETORNA SE OS DADOS OBRIGATORIOS FORAM COLETADOS.	STRING
`cad_inscricaocandidatoid`	RETORNA O ID DA INSCRIÇÃO	STRING
`cad_cpf`	CPF DO LEAD INSCRITO	STRING

OBS:

Caso os parâmetros DATAINICIAL e DATAFINAL tenham hora, minuto e segundo zerados (00:00:00), o método considerará que a busca está sendo realizada somente por data e irá ignorar horas, minutos e segundos. Caso em algum dos parâmetros ou em ambos seja preenchido hora, minuto ou segundo, a busca será realizada considerando data e hora.

\n","urlObject":{"protocol":"https","path":["api","LocalizacaoAvancada"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9a650a0a-47d2-4b6d-b92a-557982da4730"},{"name":"Buscar Pagamentos - API LocalizacaoAvancada","id":"2f5c8c80-7fda-4071-a380-153181c1853e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n","options":{"raw":{"language":"xml"}}},"url":"https://XXXapi.crmeducacional.com/api/LocalizacaoAvancada","description":"

Objetivo:

Este método tem a finalidade de retornar todos os pagamentos processados que estejam com algum dos seguintes status: Pago, Aprovado e Isento, no dia referentes ao concurso informado.

Parâmetro de Entrada

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Nome Lógico	Nome do Campo Correspondente no CRM	Tipo de informação a ser preenchida	Obrigatório
`cad_datadeprocessamento`	Data de Processamento	Inserir o período de obtenção dos dados.	Sim
`cad_centrodecusto`	Centro de Custo	Inserir o centro de custo do preço	Sim
`cad_codigo`	Código do concurso	Inserir o código do concurso	Sim
`Token`	-	Token Gerado Pela API	Sim

Obs.: Caso as informações relacionadas ao centro de custo não forem utilizadas no CRM, basta remover os filtros relacionados no fetch.

O Retorno se dará através de um FetchXML com os seguintes dados:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição	Tipo
`cad_name`	NOME DO PAGAMENTO	STRING
`cad_valor`	VALOR DO PAGAMENTO	INT
`cad_datavencimento`	DATA DO VENCIMENTO	DATE
`statuscode`	STATUS DO PAGAMENTO (ATIVO INATIVO)	STRING
`cad_urlboleto`	URL DO BOLETO	STRING
`cad_numerolotearquivoretorno`	NÚMERO DO ARQUIVO RETORNO	INT
`cad_numeroboleto`	NÚMERO DO BOLETO	STRING
`cad_nomeoperadoracartao`	NOME DA OPERADORA DO CARTÃO	STRING
`cad_isento`	PAGAMENTO É ISENTO	STRING
`cad_idtransacao`	IDENTIFICADOR DA TRANSAÇÃO	STRING
`cad_idtransacaooperadoracartao`	IDENTIFICADOR DA TRANSAÇÃO DA OPERADORA DO CARTÃO	STRING
`cad_formapagamento`	FORMA DE PAGAMENTO	STRING
`cad_boletodatacredito`	DATA DOPAGAMENTO DO BOLETO	DATE
`cad_contacorrente`	CONTA CORRENTE	STRING
`cad_agencia`	AGÊNCIA	STRING
`createdon`	DATA DE CRIAÇÃO DO PAGAMENTO	DATE
`cad_numeroparcelasselecionado`	PARCELAS DO PAGAMENTO	INT
`cad_datapagamento`	DATA DO PAGAMENTO	DATE
`cad_clientepotencialid`	LEAD VINCULADO A INSCRIÇÃO	STRING
`cad_numeroinscricao`	NÚMERO DE INSCRIÇÃO	STRING
`cad_centrodecusto`	CENTRO DE CUSTO	STRING

Objetivo

Esta requisição segue os mesmos princípios do método API LocalizacaoAvancada (Genérica), porém a sua principal funcionalidade é retornar todos os pagamentos de determinada inscrição do candidato independentemente da situação deles no CRM.

Os parâmetros principais e obrigatórios para este modelo FetchXML são:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Nome Lógico	Nome do Campo Correspondente no CRM	Tipo de informação a ser preenchida
`cad_numeroinscricao`	Inscrição do candidato	Número de inscrição do candidato
`Token`		Token gerado pela API

Estes dados devem ser modificados em value que estão localizados nos parâmetros filter pertencentes de suas respectivas entidades.

Mensagem de Retorno:

O Retorno se dará através de um FetchXML com os seguintes dados:

Campo	Descrição	Tipo
`cad_name`	NOME DO PAGAMENTO	STRING
`cad_valor`	VALOR DO PAGAMENTO	INT
`cad_datavencimento`	DATA DO VENCIMENTO	DATE
`statuscode`	STATUS DO PAGAMENTO (ATIVO INATIVO)	STRING
`cad_urlboleto`	URL DO BOLETO	STRING
`cad_numerolotearquivoretorno`	NÚMERO DO ARQUIVO RETORNO	INT
`cad_numeroboleto`	NÚMERO DO BOLETO	STRING
`cad_nomeoperadoracartao`	NOME DA OPERADORA DO CARTÃO	STRING
`cad_isento`	PAGAMENTO É ISENTO	STRING
`cad_idtransacao`	IDENTIFICADOR DA TRANSAÇÃO	STRING
`cad_idtransacaooperadoracartao`	IDENTIFICADOR DA TRANSAÇÃO DA OPERADORA DO CARTÃO	STRING
`cad_formapagamento`	FORMA DE PAGAMENTO	STRING
`cad_boletodatacredito`	DATA DOPAGAMENTO DO BOLETO	DATE
`cad_contacorrente`	CONTA CORRENTE	STRING
`cad_agencia`	AGÊNCIA	STRING
`createdon`	DATA DE CRIAÇÃO DO PAGAMENTO	DATE
`cad_numeroparcelasselecionado`	PARCELAS DO PAGAMENTO	INT
`cad_datapagamento`	DATA DO PAGAMENTO	DATE
`cad_clientepotencialid`	LEAD VINCULADO A INSCRIÇÃO	STRING
`cad_numeroinscricao`	NÚMERO DE INSCRIÇÃO	STRING
`cad_centrodecusto`	CENTRO DE CUSTO	STRING

","urlObject":{"protocol":"https","path":["api","LocalizacaoAvancada"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"fe76c2c8-ab86-44ee-8f60-05adb2a8eead"},{"name":"Buscar Inscrições Alteradas Pagas Convocadas - API LocalizacaoAvancada","id":"5d3e6ea0-ba28-4246-b200-cf16fd62b977","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 1\r\n 809220005\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n","options":{"raw":{"language":"xml"}}},"url":"https://XXXapi.crmeducacional.com/api/LocalizacaoAvancada","description":"

Objetivo

Este método é um complemento do BuscarInscricoesAlteradas - API LocalizacaoAvancada, em sua configuração, existe um filtro adicional que busca somente as inscrições que estão com a situação do pagamento com status de Pago/ Isento e que ao mesmo tempo esteja com a situação no concurso com status Convocado em determinado concurso.

Os parâmetros principais e obrigatórios para este modelo FetchXML são:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Nome Lógico	Nome do Campo Correspondente no CRM	Tipo de informação a ser preenchida
`cad_dataalteracaocadastrooferta`	Data de Alteração Cadastrou ou Oferta (Em ou depois de)	Período inicial do período desejado
`cad_dataalteracaocadastrooferta`	Data de Alteração Cadastrou ou Oferta (Em ou antes de)	Período final do período desejado
`cad_codigo`	Código de identificação	Código do concurso desejado
`Token`		Token Gerado pela API

Estes dados devem ser modificados em value que estão localizados nos parâmetros filter pertencentes de suas respectivas entidades.

Mensagem de Retorno:

O Retorno se dará através de um FetchXML com os seguintes dados:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição	Tipo
`cad_numeroinscricao`	NÚMERO DA INSCRIÇÃO	STRING
`cad_clientepotencialid`	LEAD VINCULADO A INSCRIÇÃO	STRING
`cad_situacao`	SITUAÇÃO NO CONCURSO	STRING
`cad_concursoid`	CONCURSO	STRING
`cad_ofertaid`	OFERTA	STRING
`coc_situacaopagamento`	SITUAÇÃO DO PAGAMENTO	STRING
`cad_situacaoavaliacao`	SITUAÇÃO DA AVALIAÇÃO	STRING
`cad_salaid`	SALA	STRING
`createdon`	DATA DA CRIAÇÃO DA INSCRIÇÃO	DATE
`cad_dadosobrigatorioscoletados`	RETORNA SE OS DADOS OBRIGATORIOS FORAM COLETADOS.	STRING
`cad_inscricaocandidatoid`	RETORNA O ID DA INSCRIÇÃO	STRING
`cad_cpf`	CPF DO LEAD INSCRITO	STRING

OBS:

\n","urlObject":{"protocol":"https","path":["api","LocalizacaoAvancada"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5d3e6ea0-ba28-4246-b200-cf16fd62b977"},{"name":"Buscar Inscricões Alteradas Pagas - API LocalizacaoAvancada","id":"8a793908-da42-4482-8eeb-529d8419ac3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"bearer oeEqw0lj1idWLfGCeY-T39JtdXsj67CzqmtRL1XkEvKTLH1FbAloCJQ1vNddfg6xOoSGTr1x-0lz98dYjnDEy_kMQwuXa2VodAzOfwuJu027Uuou3fONJo21BYrPl7NLjsA7fHyctSOkV27Fg0y9772uzr0t-2HlFW3Crt-JxSmu97RVzoOlxcP6iNNWk6aY8GB3_O5od4hicZWFTTAjQ9VsRrOcnOSKjW6MMJnhThM"}],"body":{"mode":"raw","raw":"\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n 1\r\n 809220005\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n","options":{"raw":{"language":"xml"}}},"url":"https://XXXapi.crmeducacional.com/api/LocalizacaoAvancada","description":"

Objetivo

\n","urlObject":{"protocol":"https","path":["api","LocalizacaoAvancada"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8a793908-da42-4482-8eeb-529d8419ac3d"},{"name":"Buscar Classificacão Por Inscricão - API LocalizacaoAvancada","id":"9c742e5c-261d-41e5-a2ad-d9e56f9ed8ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n","options":{"raw":{"language":"xml"}}},"url":"https://XXXapi.crmeducacional.com/api/LocalizacaoAvancada","description":"

Objetivo:

Este método segue os mesmos princípios do método API LocalizacaoAvancada (Genérica), porém a sua principal funcionalidade é para buscar classificações de determinadas inscrições.

Parâmetros Necessários:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Nome Lógico	Nome do Campo Correspondente no CRM	Tipo de informação a ser preenchida	Obrigatório
`cad_numeroinscricao`	Número de inscrição	Número de inscrição do candidato	Sim
`Token`	-	Token gerado através da API	Sim

Mensagem de Retorno:

Será um FetchXML seguindo as propriedades abaixo.

Campo	Descrição	Tipo
`cad_inscricaocandidatoid`	NÚMERO DA INSCRIÇÃO	STRING
`cad_ofertaid`	OFERTA	STRING
`cad_posicao`	POSIÇÃO	STRING
`cad_situacao`	SITUAÇÃO NA CHAMADA	STRING
`cad_chamadaid`	CHAMADA QUE A CLASSIFICAÇÃO ESTÁ ASSOCIADA.	STRING
`cad_classificacaoid`	GUID DA CLASSIFICAÇÃO	STRING
`cad_pontuacaofinal`	PONTUAÇÃO FINAL DO INSCRITO	INT
`cad_concursoid`	CONCURSO	STRING

","urlObject":{"protocol":"https","path":["api","LocalizacaoAvancada"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9c742e5c-261d-41e5-a2ad-d9e56f9ed8ad"},{"name":"Buscar Leads Sem Inscrição - API LocalizacaoAvancada Copy","id":"355a12d1-e26b-404c-9547-0002933c9f64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"bearer oeEqw0lj1idWLfGCeY-T39JtdXsj67CzqmtRL1XkEvKTLH1FbAloCJQ1vNddfg6xOoSGTr1x-0lz98dYjnDEy_kMQwuXa2VodAzOfwuJu027Uuou3fONJo21BYrPl7NLjsA7fHyctSOkV27Fg0y9772uzr0t-2HlFW3Crt-JxSmu97RVzoOlxcP6iNNWk6aY8GB3_O5od4hicZWFTTAjQ9VsRrOcnOSKjW6MMJnhThM"}],"body":{"mode":"raw","raw":"\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n","options":{"raw":{"language":"xml"}}},"url":"https://XXXapi.crmeducacional.com/api/LocalizacaoAvancada","urlObject":{"protocol":"https","path":["api","LocalizacaoAvancada"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"355a12d1-e26b-404c-9547-0002933c9f64"}],"id":"605e0152-cd28-42cd-8a24-fd5ae5049b3d","description":"

As requisições disponíveis nesta seção, são variações do método API LocalizaçãoAvançada Genérica. Em sua ampla concepção, ele permite a consulta dos mais variados tipos dados das entidades do CRM Dynamics.

\n","_postman_id":"605e0152-cd28-42cd-8a24-fd5ae5049b3d"},{"name":"Integrações com Sistemas Externos de Parceiros","item":[{"name":"Avisar sistemas externos quando ocorrer Criação, Alteração Automática ou Sob demanda de pagamentos na Ficha de inscrição","item":[],"id":"ee88c119-db93-495a-a723-4c0bb029ae6c","description":"

Objetivo

Esta integração permite \"avisar\" sistemas externos como SGAs (Sistema de Gestão Acadêmica) das instituições quando ocorrer a criação/atualização automática ou sob demanda de um Pagamento na ficha de inscrição.

Para utilizar esta funcionalidade/método basta realizar as seguintes configurações no CRM Educacional:

Na guia Portal do candidato na entidade / tabela Concurso existem 3 campos responsáveis pela integração, sendo: URL's POST Pagamento, Usuario Sistema Externo e Senha Sistema Externo.

Exemplo

\n\n

URL's Post Pagamento: Cadastrar uma ou mais URL's, separadas por ; (ponto e vírgula) para as quais será feito o POST para enviar os dados do Pagamento. Estas URL's deverão ser criadas pela instituição.
Usuário Sistema Externo e Senha Usuário Sistema Externo: são campos opcionais, se forem preenchidas, essas informações serão enviadas juntamente no POST. Estes dados deverão ser criados pela instituição.

Para que a integração aconteça de forma satisfatória será necessário realizar dois passos:

Preencher os campos citados acima na entidade /tabela concurso em que se deseja que os pagamentos sejam integrados.
Criar os fluxos para realizar a integração. (A instituição poderá definir através de gatilhos o momento que deseja realizar os envios dos dados ).

Abaixo um fluxo simples criado para exemplificar como notificar o sistema externo do pagamento:

Exemplo

\n\n

O fluxo criado deverá ter como entidade / tabela principal o Pagamento, conforme exemplo a seguir:

Exemplo

\n\n

Na criação dos fluxos é necessário selecionar a etapa criada/customizada pelo CRM Educacional chamada:

CRMEducacional : WorkFlow Central Queue

Exemplo

\n\n

Posteriormente, será necessário preencher duas informações adicionais clicando em ‘Definir Propriedades’.

Exemplo

\n\n

Fluxo para enviar Pagamento:

Em Classe = SistemaExternoNegocio
Metodo = NotificarPagamentoSistemaExterno

Exemplo

\n\n

Após realizar as configurações anteriores, os dados serão enviados para as Url's cadastradas no Concurso por meio de uma requisição POST no formato JSON seguindo o modelo de estrutura abaixo:

{\n\"DadosPagamento\":{\n    \"IDPagamento\":\"1973790647\",\n    \"NomePagamento\":\"CAN-030443-USM | preco geral\",\n    \"URLBoleto\":\"http://servicopagamentoapplicationhmg.azurewebsites.net/servicopagamento/InicioPagamento.aspx?pg=1973790647\",\n    \"FormaDePagamento\":\"Boleto Bancário\",\n    \"SituacaoPagamento\":\"Pago\",\n    \"NumeroBoleto\":\"0000000181897\",\n    \"Agencia\":\"3026\",\n    \"ContaCorrente\":\"0130064016\",\n    \"BoletoDataCredito\":\"N/A\",\n    \"Valor\":\"57.8900000000\",\n    \"Isento\":\"False\",\n    \"Nome\":\"Aviso Sistema Externo Pagamento\",\n    \"NumeroInscricao\":\"CAN-030443-USM\",\n    \"DataEmissao\":\"10/01/2018\",\n    \"DataVencimento\":\"11/01/2018\",\n    \"DataPagamento\":\"N/A\",\n    \"CentroDeCusto\":\"Centro de Custo Teste\",\n    \"NumeroParcelas\":\"N/A\"\n},\n\"Usuario\":\"teste\",\n\"Senha\":\"testesenha\"\n}\n\n

","_postman_id":"ee88c119-db93-495a-a723-4c0bb029ae6c"},{"name":"Avisar sistemas externos quando ocorrer conversão de Lead e Inscrição na Ficha de inscrição","item":[],"id":"6de185da-de70-4123-a3fe-2152bd9beed2","description":"

Objetivo

Esta integração permite \"avisar\" sistemas externos como SGAs (Sistema de Gestão Acadêmica) das instituições quando ocorrer conversão de Lead e Inscrições na ficha de inscrição.

Para utilizar esta funcionalidade/método basta realizar as seguintes configurações no concurso desejado no Wakeme Captação:

Na guia Portal do candidato, na entidade / tabela Concurso existem 4 campos responsáveis pela integração, sendo: URL's Post Lead, URL's Post Inscrição, Usuário Sistema Externo e Senha Usuário Sistema Externo

(OBS.: Caso você já tenha utilizado este método anteriormente, reforçamos que os campos no módulo CRM Educacional em Configurações - CRM Educacional criados anteriormente devem ser ignorados).

Exemplo

\n\n\n

Esses campos são responsáveis pela integração, ou seja, envio dos dados do Lead e/ou Inscrições para o seu SGA. A seguir explicamos cada um deles:

URL's Post Lead: Cadastrar uma ou mais URL's, separadas por ; (ponto e vírgula) para as quais será feito o POST para enviar os dados do lead. Estas URL's deverão ser criadas pela instituição.
\n
URL's Post Inscrição: Cadastrar uma ou mais URL's, separadas por ; (ponto e vírgula) para as quais será feito o POST para enviar os dados da inscrição. Estas URL's deverão ser criadas pela instituição.
\n
Usuário Sistema Externo e Senha Usuário Sistema Externo: são campos opcionais, se forem preenchidas, essas informações serão enviadas juntamente no POST. Estes dados deverão ser criados pela instituição.
\n

Para que a integração aconteça de forma satisfatória será necessário realizar dois passos:

Preencher os campos citados acima
Criar os fluxos para realizar a integração.

A instituição poderá definir o momento que deseja realizar os envio dos dados dos Leads e Inscrições no momento que desejar. Seguem alguns EXEMPLOS:

O valor do campo de dados origatórios são manipulados após recolhimento dos dados que são considerados obrigatorios na ficha de isncrição, geralemnte a sua alteração ocorre após a fase de curso. Sendo assim, sabemos que por meio do fluxo de trabalho é possível utilizar como gatilho o campo ‘Dados Obrigatórios Coletados’ da entidade inscrição, no sentido de que toda vez que houver alteração no campo ‘Dados Obrigatórios Coletados’ e o valor for igual a SIM, então executará a etapa criada/customizada pelo CRM Educacional chamada: CRMEducacional:WorkFlow Central Queue e enviará/integrará os dados dos candidatos inscritos, conforme imagem a seguir para exemplo:

\n\n\n\n\n\n\n

Exemplo
\n\n $\"Exemplo$ \n

\n\n\n

Conforme exemplo da imagem acima você ainda pode definir para cada tipo de processo seletivo/tipo de ingresso, por exemplo Tradicional, Agendado ou ENEM, dentre outros em que momento deseja realizar o envio de dados para o seu SGA.
\n
Outro bom exemplo seria criar um fluxo no caso de processo seletivo do tipo Agendado que só enviaria as inscrições ao SGA quando o local de estudo e local de prova estiverem preenchidos, seguindo a mesma lógica do exemplo anterior, o gatilho deste fluxo seria toda vez que houver alteração no campo ‘Dados Obrigatórios Coletados’ e o valor for igual a SIM, então executará a etapa criada/customizada pelo CRM Educacional chamada: CRMEducacional:WorkFlow Central Queue e enviará/integrará os dados dos candidatos inscritos.
\n
Outro possível fluxo de exemplo seria no caso de processo seletivo do tipo ENEM, só enviar as inscrições para o seu SGA quando o candidato for convocado/aprovado. A lógica inicial/gatilho do fluxo seria a mesma dos exemplos anteriores. O gatilho deste fluxo seria toda vez que houver alteração no campo ‘Dados Obrigatórios Coletados’ e o valor for igual a SIM, você adicionaria mais as verificações se o tipo de processo seletivo é igual ENEM, depois aguardar até que data da situação na chamada contenha dados e se Situação no Concurso for igual a Convocado/Aprovados, então executará a etapa criada/customizada pelo CRM Educacional chamada: CRMEducacional:WorkFlow Central Queue e enviará/integrará os dados dos candidatos inscritos.
\n

\n\n\n\n\n\n\n

Exemplo
\n\n $\"Exemplo$ \n

\n\n

Um próximo bom exemplo poderia ser enviar os dados dos Leads ao SGA após a mudança do campo ‘Situação no Funil’ da entidade lead de Potencial ou Qualificado para Inscrito, na qual o gatilho do fluxo será mudança do campo ‘Situação no Funil’, depois faria a verificação se o campo ‘Situação no Funil’ é igual a Inscrito e então executará a etapa criada/customizada pelo CRM Educacional chamada: CRMEducacional:WorkFlow Central Queue e enviará/integrará os dados dos Lead, conforme imagem do fluxo a seguir para exemplo:

\n\n\n\n\n\n\n

Exemplo
\n\n $\"Exemplo$ \n

\n\n

Os fluxos devem ter como entidade principal o Lead ou Inscrição do Candidato, conforme imagens a seguir para exemplo:

\n\n\n\n\n\n\n

Exemplo
\n\n $\"Exemplo$ \n

\n\n\n\n\n\n\n\n\n

Exemplo
\n\n $\"Exemplo$ \n

\n\n

Na criação dos fluxos é necessário selecionar a etapa criada/customizada pelo CRM Educacional chamada: CRMEducacional:WorkFlow Central Queue

\n\n\n\n\n\n\n

Exemplo
\n\n $\"Exemplo$ \n

\n\n\n

Ao incluir nos fluxos a etapa criada/customizada pelo CRM Educacional chamada: CRMEducacional:WorkFlow Central Queue é necessário preencher duas informações clicando em ‘Definir Propriedades’.

\n\n\n\n\n\n\n

Exemplo
\n\n $\"Exemplo$ \n

\n\n

As informações a serem preenchidas são:

Fluxo para enviar Lead/Interessado

Classe: SistemaExternoNegocio

Metodo: NotificarInteressadoSistemaExterno

\n\n\n\n\n\n\n

Exemplo
\n\n $\"Exemplo$ \n

\n\n

As informações a serem preenchidas são:

Fluxo para enviar Inscrição:

Classe: SistemaExternoNegocio

Metodo: NotificarInscricaoSistemaExterno

\n\n\n\n\n\n\n

Exemplo
\n\n $\"Exemplo$ \n

\n\n

Após realizar as configurações anteriores, os dados serão enviados para as URL's (Lead e/ou Inscrição) criadas pela instituição e cadastradas nos Concursos/Processos Seletivos por meio de uma requisição POST.

Os dados serão enviados no formato JSON e as informações serão enviadas seguindo o seguinte modelo de estrutura.

\n\n\n\n\n\n\n

JSON Lead:

\n\n

{\n  \"dados\": {\n    \"Nome\": \"Marco\",\n    \"ConcursoReferencia\": {\n      \"Id\": \"a62ad202-b032-ed11-9db2-000d3a88f247\",\n      \"Nome\": \"[Homologação 108]:: Concurso ENEM  Com pagamento de curso\",\n      \"NomeLogico\": \"cad_concurso\"\n    },\n    \"ConcursoAtualReferencia\": {\n      \"Id\": \"a62ad202-b032-ed11-9db2-000d3a88f247\",\n      \"Nome\": \"[Homologação 108]:: Concurso ENEM Com pagamento de curso\",\n      \"NomeLogico\": \"cad_concurso\"\n    },\n    \"OfertaAtualReferencia\": {\n      \"Id\": \"6798cf08-b032-ed11-9db2-000d3a88f247\",\n      \"Nome\": \"Oferta Base ENEM\",\n      \"NomeLogico\": \"cad_oferta\"\n    },\n    \"InscricaoAtualReferencia\": {\n      \"Id\": \"11cc3884-da70-ed11-81ac-000d3a88f247\",\n      \"Nome\": \"CAN-004874-DEV\",\n      \"NomeLogico\": \"cad_inscricaocandidato\"\n    },\n    \"ProprietarioReferencia\": {\n      \"Id\": \"b03f2902-14c6-ec11-a7b5-002248d30908\",\n      \"Nome\": \"CRM Educacional, Atendimento\",\n      \"NomeLogico\": \"systemuser\"\n    },\n    \"UsuarioReferencia\": {\n      \"Id\": \"b03f2902-14c6-ec11-a7b5-002248d30908\",\n      \"NomeLogico\": \"systemuser\"\n    },\n    \"Email\": \"782.672.960-26@crm.com\",\n    \"SobreNome\": \"r\",\n    \"NomeCompleto\": \"Marco r\",\n    \"TelefoneCelular\": \"(11)11111-1111\",\n    \"CPF\": \"782.672.960-26\",\n    \"PreMatriculado\": false,\n    \"UrlCancelamentoContatos\": \"https://inscricao.exemplo.net/PreferenciasContato?idLead=e40a3e7e-da70-ed11-81ac-000d3a88f247\",\n    \"CEP\": \"31030000\",\n    \"EnderecoEstado\": \"MG\",\n    \"EnderecoCidade\": \"São Paulo\",\n    \"EnderecoRua\": \"Avenida Altamiro Avelino Soares\",\n    \"EnderecoNumero\": \" \\\\z\",\n    \"EnderecoBairro\": \"Castelo\",\n    \"SincronizarBearings\": false,\n    \"SincronizadoPlanetaY\": false,\n    \"EnderecoComplemento\": \"s\",\n    \"NomeSocial\": \"Marco r\",\n    \"PossuiNomeSocial\": false,\n    \"TelefoneComercial\": \"(11)11111-1111\",\n    \"AceitouLgpd\": false,\n    \"ContaReferencia\": {\n      \"Id\": \"7acc46b6-98cc-ec11-a7b5-002248d2cd29\",\n      \"Nome\": \"Homologação Kratos MG\",\n      \"NomeLogico\": \"account\"\n    },\n    \"PreferenciaContatoColetada\": false,\n    \"EnderecoCountry\": \"x\",\n    \"Id\": \"e40a3e7e-da70-ed11-81ac-000d3a88f247\",\n    \"ConcursoOrigem\": {\n      \"Nome\": \"[Homologação 108]:: Concurso- Com pagamento de curso\",\n      \"NomeInstituicao\": \"Teste\",\n      \"HoraProvaValue\": -1,\n      \"Codigo\": 108,\n      \"TamanhoAnexo\": 5,\n      \"InformacoesPreMatriculado\": \"Nome Padrão\",\n      \"_MensagemCandidatoJaMatriculado\": \"Nome Padrão\",\n      \"MensagemCandidatoJaMatriculado\": \"Nome Padrão\",\n      \"_MensagemCandidatoJaAprovado\": \"cad_mensagemcandidatojaaprovado\",\n      \"MensagemCandidatoJaAprovado\": \"cad_mensagemcandidatojaaprovado\",\n      \"_MensagemAusente\": \"Nome Padrão\",\n      \"MensagemAusente\": \"Nome Padrão\",\n      \"_MensagemResumoComprovanteInscricao\": \"Nome Padrão\",\n      \"MensagemResumoComprovanteInscricao\": \"Nome Padrão\",\n      \"InformacoesCandidatoAusente\": \"Nome Padrão\",\n      \"LogoTipoRelatorio\": \"https://Nome Padrão\",\n      \"LinkComprovanteInscricao\": \"https://webhook.site/04cdce45-1c11-4c97-b95f-2638aab17ff5\",\n      \"Categoria\": \"ENEM\",\n      \"ProcessoPublicado\": false,\n      \"ProvaAgendada\": true,\n      \"InformacoesCandidatoJaMatriculado\": \"Nome Padrão\",\n      \"InformacoesCandidatosJaInscrito\": \"Nome Padrão\",\n      \"InformacoesCandidatosJaAprovado\": \"cad_informacoescandidatosjaaprovados\",\n      \"UtilizaCupomDesconto\": true,\n      \"UrlVantagensEstouCompressa\": \"Nome Padrão\",\n      \"UrlVantagensFuraFila\": \"Nome Padrão\",\n      \"UrlBotaoSair\": \"Nome Padrão\",\n      \"UrlImagemDoPainel\": \"https://Nome Padrão\",\n      \"ImagemTopoFicha\": \"https://cdn.discordapp.com/attachments/912329977406574663/1022185038189703189/Dev_Banner_Desktop.png\",\n      \"ImagemTopoFichaMobile\": \"https://cdn.discordapp.com/attachments/912329977406574663/1022185037715750912/Dev_Banner_Mobile.png\",\n      \"UrlMatriculaDeCalouros\": \"https://webhook.site/04cdce45-1c11-4c97-b95f-2638aab17ff5\",\n      \"UrlImagemFanPage\": \"Nome Padrão\",\n      \"IntegracaoQueroBolsa\": true,\n      \"UtilizaIntegracaoRedacaoOnline\": false,\n      \"TokenPrivadoRdstation\": \"Nome Padrão\",\n      \"BloquearAlteracaoDadosCadastraisConvocado\": true,\n      \"EnsalamentoAposPagamento\": false,\n      \"BloquearAlteracaoDadosCadastraisMatriculado\": false,\n      \"LabelCampoAnexarArquivos\": \"Nome Padrão\",\n      \"EnsalamentoAutomatico\": false,\n      \"UtilizaDistribuicaoAutomaticaCarteiras\": true,\n      \"SegundaOpcaoObrigatoria\": false,\n      \"TerceiraOpcaoObrigatoria\": false,\n      \"BloquearCategoriaCalendario\": true,\n      \"UtilizaConsultaCPF\": true,\n      \"PeriodoLetivo\": \"2024/2\",\n      \"PeriodoLetivoReferencia\": {\n        \"Id\": \"3928ad67-c2fe-ec11-82e6-000d3a88fff5\",\n        \"Nome\": \"2024/2\",\n        \"NomeLogico\": \"cad_periodoletivo\"\n      },\n      \"CodigoAppFacebook\": \"Nome Padrão\",\n      \"UrlImagemLogo\": \"Nome Padrão\",\n      \"ExibirMobilePhone\": true,\n      \"PermiteInscricoesAprovadas\": true,\n      \"PermiteInscricoesOutrosConcursos\": true,\n      \"PermiteInscricoesDeMatriculadosEmOutrosConcursos\": false,\n      \"UrlBannerPainel\": \"Nome Padrão\",\n      \"URLImagemGabaritoCartaoResposta\": \"Nome Padrão\",\n      \"UrlImagemFundoPortal\": \"https://crmeducacional.com/wp-content/uploads/2020/10/devteam_desktop.png\",\n      \"LinkImagemPainel\": \"Nome Padrão\",\n      \"PermiteAnexarArquivos\": false,\n      \"AnexoObrigatorio\": false,\n      \"RestringirExtensaoAnexo\": true,\n      \"ForcarAtualizacaoCadastralConvocado\": false,\n      \"ChamadaAutomatica\": true,\n      \"CupomUsoUnico\": true,\n      \"CorTemaPainel\": \"Nome Padrão\",\n      \"CorFontePainel\": \"Nome Padrão\",\n      \"TituloPortal\": \"[Homologação 108]\",\n      \"PermiteConvocadoAlterarOferta\": true,\n      \"IsentaTrainee\": true,\n      \"UtilizaDistribuicaoProvas\": true,\n      \"UtilizarRegrasReagendamento\": false,\n      \"LabelBtnAcaoLogin\": \"Nome Padrão\",\n      \"LabelBtnAcaoCurso\": \"Nome Padrão\",\n      \"LabelBtnAdicionarOpcaoCurso\": \"Nome Padrão\",\n      \"LabelBtnRemoverOpcaoCurso\": \"Nome Padrão\",\n      \"LabelBtnAcaoDados\": \"Nome Padrão\",\n      \"LabelBtnAcaoPagamento\": \"Nome Padrão\",\n      \"LabelBtnAcaoResumo\": \"Nome Padrão\",\n      \"ExibirApenasOfertasUnidCert\": false,\n      \"NomeExibicaoCategoria\": \"Nome Padrão\",\n      \"UrlPostInteressado\": \"https://webhook.site/04cdce45-1c11-4c97-b95f-2638aab17ff5\",\n      \"UrlPostInscricao\": \"Nome Padrão\",\n      \"PermitirContestacao\": false,\n      \"PossuiPagamento\": false,\n      \"PermiteAlterarPrimeiraOpcaoCursoChamadaAutomatica\": false,\n      \"PermiteAlterarConsultor\": true,\n      \"ExibirConsultor\": true,\n      \"LabelCampoConsultor\": \"Nome Padrão\",\n      \"LabelSecaoConsultor\": \"cad_lablesecaoconsultor\",\n      \"PermitirIndicacao\": false,\n      \"MascaraIndicacao\": \"Nome Padrão\",\n      \"LabelSecaoIndicacao\": \"Nome Padrão\",\n      \"LabelCampoIndicacao\": \"Nome Padrão\",\n      \"PermitirAlteracaoOfertasInscPagas\": false,\n      \"UsuarioQB\": \"Nome Padrão\",\n      \"SenhaQB\": \"Nome Padrão\",\n      \"ExibirMensagemTesteVocacionalQueCurso\": true,\n      \"_MensagemTesteVocacionalQueCurso\": \"Nome Padrão\",\n      \"MensagemTesteVocacionalQueCurso\": \"Nome Padrão\",\n      \"ExibirMensagemTesteVocacionalMinhaEscolha\": true,\n      \"_MensagemTesteVocacionalMinhaEscolha\": \"Nome Padrão\",\n      \"MensagemTesteVocacionalMinhaEscolha\": \"Nome Padrão\",\n      \"Rua\": \"Rua Nome Padrão\",\n      \"Numero\": \"1\",\n      \"Complemento\": \"Apto 201\",\n      \"Bairro\": \"Teste\",\n      \"Cidade\": \"Teste\",\n      \"CEP\": \"32315-040\",\n      \"_MensagemWizardPagamentoMatricula\": \"Mensagem Wizard Padrão\",\n      \"MensagemWizardPagamentoMatricula\": \"Mensagem Wizard Padrão\",\n      \"TempoDuracaoRedacaoOnline\": 1,\n      \"MaximoCaracteresRedacaoOnline\": 1,\n      \"MinimoCaracteresRedacaoOnline\": 1,\n      \"TempoAlertaTerminoRedacaoOnline\": 1,\n      \"TituloTelaRedacaoOnline\": \"TituloTelaRedacaoOnline\",\n      \"_MensagemTelaRedacaoOnline\": \"MensagemTelaRedacaoOnline\",\n      \"MensagemTelaRedacaoOnline\": \"MensagemTelaRedacaoOnline\",\n      \"_InstrucoesTelaRedacaoOnline\": \"InstrucoesTelaRedacaoOnline\",\n      \"InstrucoesTelaRedacaoOnline\": \"InstrucoesTelaRedacaoOnline\",\n      \"LabelBotaoQueroProvaAgora\": \"LabelBotaoQueroFazerProvaAgoraRedacaoOnline\",\n      \"LabelBotaoQueroProvaDepois\": \"LabelBotaoQueroFazerDepoisAgoraRedacaoOnline\",\n      \"LabelBotaoAcaoProvaOnline\": \"LabelBotaoAcaoRedacaoOnline\",\n      \"_MensagemAguardarConfirmacaoPagamento\": \"cad_mensagemaguardarconfirmacaopagamento\",\n      \"MensagemAguardarConfirmacaoPagamento\": \"cad_mensagemaguardarconfirmacaopagamento\",\n      \"_MensagemDataProvaOnlineExpirada\": \"cad_mensagemdataredacaoonlineexpirada\",\n      \"MensagemDataProvaOnlineExpirada\": \"cad_mensagemdataredacaoonlineexpirada\",\n      \"_MensagemQueroFazerRedacaoDepois\": \"cad_mensagemquerofazerredacaodepois\",\n      \"MensagemQueroFazerRedacaoDepois\": \"cad_mensagemquerofazerredacaodepois\",\n      \"_MensagemRedacaoEntregueTempoEsgotado\": \"cad_mensagemredacaoentreguetempoesgotado\",\n      \"MensagemRedacaoEntregueTempoEsgotado\": \"cad_mensagemredacaoentreguetempoesgotado\",\n      \"_MensagemRedacaoEntregue\": \"cad_mensagemredacaoentregue\",\n      \"MensagemRedacaoEntregue\": \"cad_mensagemredacaoentregue\",\n      \"_MensagemRedacaoAlertaTempoEsgotando\": \"cad_mensagemalertatempoesgotando\",\n      \"MensagemRedacaoAlertaTempoEsgotando\": \"cad_mensagemalertatempoesgotando\",\n      \"_MensagemConfirmacaoEntregarRedacao\": \"cad_mensagemconfirmacaoentregarredacao\",\n      \"MensagemConfirmacaoEntregarRedacao\": \"cad_mensagemconfirmacaoentregarredacao\",\n      \"LabelBotaoEntregarProvaOnlineAgora\": \"cad_labelbotaoentregarredacaoagora\",\n      \"LabelBotaoEntregarProvaOnlineDepois\": \"cad_labelbotaoentregarredacaodepois\",\n      \"_MensagemPagamentoVencido\": \"cad_mensagempagamentovencido\",\n      \"MensagemPagamentoVencido\": \"cad_mensagempagamentovencido\",\n      \"_MensagemRedacaoNaoEntregueMinimoCaracteres\": \"cad_mensagemredacaonaoentreguemincaracteres\",\n      \"MensagemRedacaoNaoEntregueMinimoCaracteres\": \"cad_mensagemredacaonaoentreguemincaracteres\",\n      \"_MensagemRedacaoNaoEntregueTempoExpirado\": \"cad_mensagemredacaonaoentreguetempoexpirado\",\n      \"MensagemRedacaoNaoEntregueTempoExpirado\": \"cad_mensagemredacaonaoentreguetempoexpirado\",\n      \"GuidFormularioHubSpot\": \"Guid Padrão\",\n      \"PortalID\": \"ID Padrão\",\n      \"EnsalamentoLocalProva\": false,\n      \"LabelSecaoLocalProva\": \"Label Padrão\",\n      \"BloquearTrocaOfertaStatusPreMatriculo\": false,\n      \"PermitirTrocaOfertaViaURL\": false,\n      \"PermitirSomenteExAlunos\": false,\n      \"ControleApuracaoID\": \"00000000-0000-0000-0000-000000000000\",\n      \"ControleApuracaoReferencia\": {\n        \"Id\": \"6af58356-ead6-ec11-a7b5-00224837f065\",\n        \"Nome\": \"Controle de Apuração - Homologação Zeus Enem.\",\n        \"NomeLogico\": \"cad_controleapuracao\"\n      },\n      \"PermiteInscricaoCandidatosAprovadosOutrosConcursos\": true,\n      \"PermiteInscricoesDeMatriculadosOutrosConcursos\": false,\n      \"PermiteInscricaoCandidatosInscritosOutrosConcursos\": true,\n      \"BloquearAlteracaoParaAprovados\": true,\n      \"BloquearAlteracaoParaMatriculados\": false,\n      \"IdConcurso\": \"a62ad202-b032-ed11-9db2-000d3a88f247\",\n      \"PermiteMultiplasInscricoes\": false,\n      \"ConcursoEnsinoBasico\": false,\n      \"AssinaturaObrigatoria\": false,\n      \"PreMatriculaID\": {\n        \"Id\": \"afd58840-7a3b-ed11-9db0-000d3a88e678\",\n        \"Nome\": \"Contrato Exemplo Edunext Docusign\",\n        \"NomeLogico\": \"cad_contrato\"\n      },\n      \"CodigoContrato\": 0,\n      \"IntegracaoAutomaticaSistemaExterno\": true,\n      \"PermiteInscricaoMesmaOferta\": false,\n      \"UtilizaContratoOnline\": true,\n      \"ResponsavelFinanceiroSegundaEtapa\": false,\n      \"_MensagemLgpd\": \"Mensagem LGPD (Login)\",\n      \"MensagemLgpd\": \"Mensagem LGPD (Login)\",\n      \"HabilitaLGPD\": false,\n      \"HabilitaCamposOpcionaisMobile\": false,\n      \"_MensagemResponsavelLegal\": \"Mensagem Responsável Legal LGPD (Dados)\",\n      \"MensagemResponsavelLegal\": \"Mensagem Responsável Legal LGPD (Dados)\",\n      \"_MsgConsentimentoRespLegalLGPD\": \"Mensagem Consentimento Responsável Legal LGPD (Dados)\",\n      \"MsgConsentimentoRespLegalLGPD\": \"Mensagem Consentimento Responsável Legal LGPD (Dados)\",\n      \"_MsgProgramaIndicacao\": \"testando123\",\n      \"MsgProgramaIndicacao\": \"testando123\",\n      \"_CheckboxConsentimentoRespLegalLGPD\": \"Checkbox Consentimento Responsável Legal LGPD (Dados)\",\n      \"CheckboxConsentimentoRespLegalLGPD\": \"Checkbox Consentimento Responsável Legal LGPD (Dados)\",\n      \"UtilizaContratoPosPagamento\": true,\n      \"LiberaPagamentoComplementacaoDados\": false,\n      \"LiberaPagamentoPreMatricula\": false,\n      \"LabelValordoCurso\": \"teste\",\n      \"LinkFichadeInscricao\": \"https://inscricaotime1-dev1.azurewebsites.net/login/108\",\n      \"UtilizaIntegracaoEdunext\": true,\n      \"Id\": \"a62ad202-b032-ed11-9db2-000d3a88f247\",\n      \"MinutoProvaValue\": -1,\n      \"DataInicial\": \"12-09-2022 11:00:00\",\n      \"DataFinal\": \"30-12-2023 11:00:00\",\n      \"QuantidadeOpcoesOferta\": \"Um\",\n      \"FormulariosExibidos\": \"Ambos\",\n      \"EmpresaIntegracaoIboundMarketing\": \"Desabilitado\",\n      \"TipoConcurso\": \"Enem\",\n      \"TipoCalculoFinal\": \"Media\",\n      \"OpcaoFormularioAlterado\": \"CadastroCompleto\",\n      \"OrdenacaoEnsalamento\": \"DataInscricao\",\n      \"CorIcones\": \"Clara\",\n      \"OrigemEnderecoComprovanteInscricao\": \"LocalAvaliacao\",\n      \"UF\": \"MG\",\n      \"OpcaoPagamento\": \"Curso\",\n      \"AlteracaoLocalProvaAte\": \"InscricaoPaga\",\n      \"TipoContrato\": \"PreMatricula\",\n      \"IntegracaoContratoOnline\": \"DocuSing\",\n      \"DataCriacao\": \"12-09-2022 15:31:50\",\n      \"DataModificacao\": \"30-11-2022 18:53:20\"\n    },\n    \"SituacaoFunil\": \"Convocado\",\n    \"DataNascimento\": \"19-02-1999 03:00:00\",\n    \"OrigemClientePotencial\": \"PortalCandidato\",\n    \"TipoInteressado\": \"Responsavel\",\n    \"UltimoLoginRealizado\": \"30-11-2022 18:12:11\",\n    \"PreferenciaContato\": \"QualquerUma\",\n    \"DataCriacao\": \"30-11-2022 18:12:05\",\n    \"DataModificacao\": \"30-11-2022 18:14:12\"\n  },\n  \"usuario\": \"\",\n  \"senha\": \"\"\n}\n                                            \n

\n\n\n\n\n\n\n\n\n

JSON Inscrição Candidato:

\n\n

{  \n{\n  \"dados\": {\n    \"Classificacao\": 1,\n    \"ClassificacaoOferta\": 1,\n    \"PreMatriculado\": false,\n    \"Processado\": true,\n    \"PeriodoLetivo\": \"2024/2\",\n    \"AvaliacaoPagamentoReferencia\": {\n      \"Id\": \"3ccc3884-da70-ed11-81ac-000d3a88f247\",\n      \"Nome\": \"Nome Padrão\",\n      \"NomeLogico\": \"cad_avaliacao\"\n    },\n    \"LeadReferencia\": {\n      \"Id\": \"e40a3e7e-da70-ed11-81ac-000d3a88f247\",\n      \"Nome\": \"Marco r\",\n      \"NomeLogico\": \"lead\"\n    },\n    \"DadosObrigatoriosColetados\": true,\n    \"DadosComplementaresColetados\": false,\n    \"OfertaPrimeiraOpcaoReferencia\": {\n      \"Id\": \"6798cf08-b032-ed11-9db2-000d3a88f247\",\n      \"Nome\": \"Oferta Base ENEM\",\n      \"NomeLogico\": \"cad_oferta\"\n    },\n    \"ConcursoReferencia\": {\n      \"Id\": \"a62ad202-b032-ed11-9db2-000d3a88f247\",\n      \"Nome\": \"[Homologação 108]:: Concurso ENEM  Com pagamento de curso\",\n      \"NomeLogico\": \"cad_concurso\"\n    },\n    \"ContaReferencia\": {\n      \"Id\": \"7acc46b6-98cc-ec11-a7b5-002248d2cd29\",\n      \"Nome\": \"Homologação Kratos MG\",\n      \"NomeLogico\": \"account\"\n    },\n    \"RetornoSistemaExterna\": \"Invalid URI: The format of the URI could not be determined.;\",\n    \"NumeroInscricaoCriptografado\": \"UMy5O6Jyf9nvGE7NFIg+mQ==\",\n    \"ConversaoAdwords\": false,\n    \"ProcessandoChamadaAutomatica\": false,\n    \"OportunidadeMarcadaInboundMarketing\": false,\n    \"VendaMarcadaInboundMarketing\": false,\n    \"EnemNotaRedacao\": \"900\",\n    \"EnemNotaMatematica\": \"900\",\n    \"EnemNotaCienciasNatureza\": \"900\",\n    \"EnemNotaLinguagens\": \"900\",\n    \"EnemNotaCienciasHumanas\": \"900\",\n    \"ProvaAnexada\": false,\n    \"MaioridadeRA\": false,\n    \"MatriculaCancelada\": false,\n    \"SincronizacaoQB\": false,\n    \"DocumentacaoEntregue\": false,\n    \"LiberarProvaDigital\": false,\n    \"Maioridade\": false,\n    \"EtapaConfirmacaoDados\": false,\n    \"AceitouTermoResponsavelLegal\": false,\n    \"ExibirGabarito\": false,\n    \"HistoricoOfertaReferencia\": {\n      \"Id\": \"6798cf08-b032-ed11-9db2-000d3a88f247\",\n      \"Nome\": \"Oferta Base ENEM\",\n      \"NomeLogico\": \"cad_oferta\"\n    },\n    \"ExibirNumeroPerguntaGabarito\": false,\n    \"stateCode\": 0,\n    \"ExibirNoPortal\": false,\n    \"EtapaPeriodoIngresso\": \"1\",\n    \"Id\": \"11cc3884-da70-ed11-81ac-000d3a88f247\",\n    \"NumeroInscricao\": \"CAN-004874-DEV\",\n    \"Trainee\": false,\n    \"Avaliacoes\": [],\n    \"FasePortalCandidato\": \"Inscricao\",\n    \"SituacaoVaga\": \"Livre\",\n    \"SituacaoAvaliacao\": \"Avaliado\",\n    \"Oferta\": {\n      \"Nome\": \"Oferta Base ENEM\",\n      \"VagasDisponiveis\": 78,\n      \"VagasDisponiveisSGA\": 100,\n      \"QuantidadeVagas\": 100,\n      \"ConcursoReferencia\": {\n        \"Id\": \"a62ad202-b032-ed11-9db2-000d3a88f247\",\n        \"Nome\": \"[Homologação 108]:: Concurso ENEM  Com pagamento de curso\",\n        \"NomeLogico\": \"cad_concurso\"\n      },\n      \"MinimoDeVagasPreenchidas\": 1,\n      \"CategoriaNome\": \"Minas Gerais - Brasil\",\n      \"CodEscola\": 1,\n      \"Regime\": 1,\n      \"CodCampus\": 1,\n      \"CodCurso\": 1,\n      \"CodCurriculo\": 5,\n      \"CodTurno\": 1,\n      \"CurrEquiv\": 1,\n      \"CodFormaIngr\": 1,\n      \"CodSubFormaIngr\": 1,\n      \"CategoriaID\": \"4db540f9-98cc-ec11-a7b5-002248d2cd29\",\n      \"CategoriaReferencia\": {\n        \"Id\": \"4db540f9-98cc-ec11-a7b5-002248d2cd29\",\n        \"Nome\": \"Minas Gerais - Brasil\",\n        \"NomeLogico\": \"cad_categoria\"\n      },\n      \"IdentificadorOferta\": \"IdentificadorOfertaPadrão\",\n      \"TurnoOfertado\": \"Manhã\",\n      \"SemestreOfertado\": \"2018/1\",\n      \"CodigoDoMec\": 0,\n      \"PermiteCupom\": false,\n      \"NumeroInscritos\": 27,\n      \"NumeroAprovados\": 23,\n      \"ExibirOfertaSemVagaDisponivel\": true,\n      \"IdOferta\": \"6798cf08-b032-ed11-9db2-000d3a88f247\",\n      \"Id\": \"6798cf08-b032-ed11-9db2-000d3a88f247\",\n      \"Modalidade\": \"Presencial\",\n      \"TurnoEquivalente\": \"Noite\",\n      \"CreatedOn\": \"12-09-2022 15:31:57\",\n      \"DataModificacao\": \"30-11-2022 18:14:17\"\n    },\n    \"OrigemInscricaoCandidato\": \"PortalCandidato\",\n    \"CreatedOn\": \"30-11-2022 18:12:17\",\n    \"TimestampLogin\": \"30-11-2022 18:12:11\",\n    \"TimestampCurso\": \"30-11-2022 18:12:12\",\n    \"TimestampDados\": \"30-11-2022 18:13:06\",\n    \"SituacaoAnteriorNoConcurso\": \"Inscrito\",\n    \"SituacaoAuxiliarConcurso\": \"Aprovado\",\n    \"PermiteNovaAvaliacaoPickList\": \"Nao\",\n    \"DataModificacao\": \"30-11-2022 18:14:14\",\n    \"SituacaoConcurso\": \"Aprovado\",\n    \"Concurso\": {\n      \"Nome\": \"[Homologação 108]:: Concurso ENEM - Com pagamento de curso\",\n      \"NomeInstituicao\": \"Teste\",\n      \"HoraProvaValue\": -1,\n      \"Codigo\": 108,\n      \"TamanhoAnexo\": 5,\n      \"InformacoesPreMatriculado\": \"Nome Padrão\",\n      \"_MensagemCandidatoJaMatriculado\": \"Nome Padrão\",\n      \"MensagemCandidatoJaMatriculado\": \"Nome Padrão\",\n      \"_MensagemCandidatoJaAprovado\": \"cad_mensagemcandidatojaaprovado\",\n      \"MensagemCandidatoJaAprovado\": \"cad_mensagemcandidatojaaprovado\",\n      \"_MensagemAusente\": \"Nome Padrão\",\n      \"MensagemAusente\": \"Nome Padrão\",\n      \"_MensagemResumoComprovanteInscricao\": \"Nome Padrão\",\n      \"MensagemResumoComprovanteInscricao\": \"Nome Padrão\",\n      \"InformacoesCandidatoAusente\": \"Nome Padrão\",\n      \"LogoTipoRelatorio\": \"https://Nome Padrão\",\n      \"LinkComprovanteInscricao\": \"https://webhook.site/04cdce45-1c11-4c97-b95f-2638aab17ff5\",\n      \"Categoria\": \"ENEM\",\n      \"ProcessoPublicado\": false,\n      \"ProvaAgendada\": true,\n      \"InformacoesCandidatoJaMatriculado\": \"Nome Padrão\",\n      \"InformacoesCandidatosJaInscrito\": \"Nome Padrão\",\n      \"InformacoesCandidatosJaAprovado\": \"cad_informacoescandidatosjaaprovados\",\n      \"UtilizaCupomDesconto\": true,\n      \"UrlVantagensEstouCompressa\": \"Nome Padrão\",\n      \"UrlVantagensFuraFila\": \"Nome Padrão\",\n      \"UrlBotaoSair\": \"Nome Padrão\",\n      \"UrlImagemDoPainel\": \"https://Nome Padrão\",\n      \"ImagemTopoFicha\": \"https://cdn.discordapp.com/attachments/912329977406574663/1022185038189703189/Dev_Banner_Desktop.png\",\n      \"ImagemTopoFichaMobile\": \"https://cdn.discordapp.com/attachments/912329977406574663/1022185037715750912/Dev_Banner_Mobile.png\",\n      \"UrlMatriculaDeCalouros\": \"https://webhook.site/04cdce45-1c11-4c97-b95f-2638aab17ff5\",\n      \"UrlImagemFanPage\": \"Nome Padrão\",\n      \"IntegracaoQueroBolsa\": true,\n      \"UtilizaIntegracaoRedacaoOnline\": false,\n      \"TokenPrivadoRdstation\": \"Nome Padrão\",\n      \"BloquearAlteracaoDadosCadastraisConvocado\": true,\n      \"EnsalamentoAposPagamento\": false,\n      \"BloquearAlteracaoDadosCadastraisMatriculado\": false,\n      \"LabelCampoAnexarArquivos\": \"Nome Padrão\",\n      \"EnsalamentoAutomatico\": false,\n      \"UtilizaDistribuicaoAutomaticaCarteiras\": true,\n      \"SegundaOpcaoObrigatoria\": false,\n      \"TerceiraOpcaoObrigatoria\": false,\n      \"BloquearCategoriaCalendario\": true,\n      \"UtilizaConsultaCPF\": true,\n      \"PeriodoLetivo\": \"2024/2\",\n      \"PeriodoLetivoReferencia\": {\n        \"Id\": \"3928ad67-c2fe-ec11-82e6-000d3a88fff5\",\n        \"Nome\": \"2024/2\",\n        \"NomeLogico\": \"cad_periodoletivo\"\n      },\n      \"CodigoAppFacebook\": \"Nome Padrão\",\n      \"UrlImagemLogo\": \"Nome Padrão\",\n      \"ExibirMobilePhone\": true,\n      \"PermiteInscricoesAprovadas\": true,\n      \"PermiteInscricoesOutrosConcursos\": true,\n      \"PermiteInscricoesDeMatriculadosEmOutrosConcursos\": false,\n      \"UrlBannerPainel\": \"Nome Padrão\",\n      \"URLImagemGabaritoCartaoResposta\": \"Nome Padrão\",\n      \"UrlImagemFundoPortal\": \"https://crmeducacional.com/wp-content/uploads/2020/10/devteam_desktop.png\",\n      \"LinkImagemPainel\": \"Nome Padrão\",\n      \"PermiteAnexarArquivos\": false,\n      \"AnexoObrigatorio\": false,\n      \"RestringirExtensaoAnexo\": true,\n      \"ForcarAtualizacaoCadastralConvocado\": false,\n      \"ChamadaAutomatica\": true,\n      \"CupomUsoUnico\": true,\n      \"CorTemaPainel\": \"Nome Padrão\",\n      \"CorFontePainel\": \"Nome Padrão\",\n      \"TituloPortal\": \"[Homologação 108]\",\n      \"PermiteConvocadoAlterarOferta\": true,\n      \"IsentaTrainee\": true,\n      \"UtilizaDistribuicaoProvas\": true,\n      \"UtilizarRegrasReagendamento\": false,\n      \"LabelBtnAcaoLogin\": \"Nome Padrão\",\n      \"LabelBtnAcaoCurso\": \"Nome Padrão\",\n      \"LabelBtnAdicionarOpcaoCurso\": \"Nome Padrão\",\n      \"LabelBtnRemoverOpcaoCurso\": \"Nome Padrão\",\n      \"LabelBtnAcaoDados\": \"Nome Padrão\",\n      \"LabelBtnAcaoPagamento\": \"Nome Padrão\",\n      \"LabelBtnAcaoResumo\": \"Nome Padrão\",\n      \"ExibirApenasOfertasUnidCert\": false,\n      \"NomeExibicaoCategoria\": \"Nome Padrão\",\n      \"UrlPostInteressado\": \"https://webhook.site/04cdce45-1c11-4c97-b95f-2638aab17ff5\",\n      \"UrlPostInscricao\": \"https://webhook.site/04cdce45-1c11-4c97-b95f-2638aab17ff5\",\n      \"PermitirContestacao\": false,\n      \"PossuiPagamento\": false,\n      \"PermiteAlterarPrimeiraOpcaoCursoChamadaAutomatica\": false,\n      \"PermiteAlterarConsultor\": true,\n      \"ExibirConsultor\": true,\n      \"LabelCampoConsultor\": \"Nome Padrão\",\n      \"LabelSecaoConsultor\": \"cad_lablesecaoconsultor\",\n      \"PermitirIndicacao\": false,\n      \"MascaraIndicacao\": \"Nome Padrão\",\n      \"LabelSecaoIndicacao\": \"Nome Padrão\",\n      \"LabelCampoIndicacao\": \"Nome Padrão\",\n      \"PermitirAlteracaoOfertasInscPagas\": false,\n      \"UsuarioQB\": \"Nome Padrão\",\n      \"SenhaQB\": \"Nome Padrão\",\n      \"ExibirMensagemTesteVocacionalQueCurso\": true,\n      \"_MensagemTesteVocacionalQueCurso\": \"Nome Padrão\",\n      \"MensagemTesteVocacionalQueCurso\": \"Nome Padrão\",\n      \"ExibirMensagemTesteVocacionalMinhaEscolha\": true,\n      \"_MensagemTesteVocacionalMinhaEscolha\": \"Nome Padrão\",\n      \"MensagemTesteVocacionalMinhaEscolha\": \"Nome Padrão\",\n      \"Rua\": \"Rua Nome Padrão\",\n      \"Numero\": \"1\",\n      \"Complemento\": \"Apto 201\",\n      \"Bairro\": \"Teste\",\n      \"Cidade\": \"Teste\",\n      \"CEP\": \"32315-040\",\n      \"_MensagemWizardPagamentoMatricula\": \"Mensagem Wizard Padrão\",\n      \"MensagemWizardPagamentoMatricula\": \"Mensagem Wizard Padrão\",\n      \"TempoDuracaoRedacaoOnline\": 1,\n      \"MaximoCaracteresRedacaoOnline\": 1,\n      \"MinimoCaracteresRedacaoOnline\": 1,\n      \"TempoAlertaTerminoRedacaoOnline\": 1,\n      \"TituloTelaRedacaoOnline\": \"TituloTelaRedacaoOnline\",\n      \"_MensagemTelaRedacaoOnline\": \"MensagemTelaRedacaoOnline\",\n      \"MensagemTelaRedacaoOnline\": \"MensagemTelaRedacaoOnline\",\n      \"_InstrucoesTelaRedacaoOnline\": \"InstrucoesTelaRedacaoOnline\",\n      \"InstrucoesTelaRedacaoOnline\": \"InstrucoesTelaRedacaoOnline\",\n      \"LabelBotaoQueroProvaAgora\": \"LabelBotaoQueroFazerProvaAgoraRedacaoOnline\",\n      \"LabelBotaoQueroProvaDepois\": \"LabelBotaoQueroFazerDepoisAgoraRedacaoOnline\",\n      \"LabelBotaoAcaoProvaOnline\": \"LabelBotaoAcaoRedacaoOnline\",\n      \"_MensagemAguardarConfirmacaoPagamento\": \"cad_mensagemaguardarconfirmacaopagamento\",\n      \"MensagemAguardarConfirmacaoPagamento\": \"cad_mensagemaguardarconfirmacaopagamento\",\n      \"_MensagemDataProvaOnlineExpirada\": \"cad_mensagemdataredacaoonlineexpirada\",\n      \"MensagemDataProvaOnlineExpirada\": \"cad_mensagemdataredacaoonlineexpirada\",\n      \"_MensagemQueroFazerRedacaoDepois\": \"cad_mensagemquerofazerredacaodepois\",\n      \"MensagemQueroFazerRedacaoDepois\": \"cad_mensagemquerofazerredacaodepois\",\n      \"_MensagemRedacaoEntregueTempoEsgotado\": \"cad_mensagemredacaoentreguetempoesgotado\",\n      \"MensagemRedacaoEntregueTempoEsgotado\": \"cad_mensagemredacaoentreguetempoesgotado\",\n      \"_MensagemRedacaoEntregue\": \"cad_mensagemredacaoentregue\",\n      \"MensagemRedacaoEntregue\": \"cad_mensagemredacaoentregue\",\n      \"_MensagemRedacaoAlertaTempoEsgotando\": \"cad_mensagemalertatempoesgotando\",\n      \"MensagemRedacaoAlertaTempoEsgotando\": \"cad_mensagemalertatempoesgotando\",\n      \"_MensagemConfirmacaoEntregarRedacao\": \"cad_mensagemconfirmacaoentregarredacao\",\n      \"MensagemConfirmacaoEntregarRedacao\": \"cad_mensagemconfirmacaoentregarredacao\",\n      \"LabelBotaoEntregarProvaOnlineAgora\": \"cad_labelbotaoentregarredacaoagora\",\n      \"LabelBotaoEntregarProvaOnlineDepois\": \"cad_labelbotaoentregarredacaodepois\",\n      \"_MensagemPagamentoVencido\": \"cad_mensagempagamentovencido\",\n      \"MensagemPagamentoVencido\": \"cad_mensagempagamentovencido\",\n      \"_MensagemRedacaoNaoEntregueMinimoCaracteres\": \"cad_mensagemredacaonaoentreguemincaracteres\",\n      \"MensagemRedacaoNaoEntregueMinimoCaracteres\": \"cad_mensagemredacaonaoentreguemincaracteres\",\n      \"_MensagemRedacaoNaoEntregueTempoExpirado\": \"cad_mensagemredacaonaoentreguetempoexpirado\",\n      \"MensagemRedacaoNaoEntregueTempoExpirado\": \"cad_mensagemredacaonaoentreguetempoexpirado\",\n      \"GuidFormularioHubSpot\": \"Guid Padrão\",\n      \"PortalID\": \"ID Padrão\",\n      \"EnsalamentoLocalProva\": false,\n      \"LabelSecaoLocalProva\": \"Label Padrão\",\n      \"BloquearTrocaOfertaStatusPreMatriculo\": false,\n      \"PermitirTrocaOfertaViaURL\": false,\n      \"PermitirSomenteExAlunos\": false,\n      \"ControleApuracaoID\": \"00000000-0000-0000-0000-000000000000\",\n      \"ControleApuracaoReferencia\": {\n        \"Id\": \"6af58356-ead6-ec11-a7b5-00224837f065\",\n        \"Nome\": \"Controle de Apuração - Homologação Zeus Enem.\",\n        \"NomeLogico\": \"cad_controleapuracao\"\n      },\n      \"PermiteInscricaoCandidatosAprovadosOutrosConcursos\": true,\n      \"PermiteInscricoesDeMatriculadosOutrosConcursos\": false,\n      \"PermiteInscricaoCandidatosInscritosOutrosConcursos\": true,\n      \"BloquearAlteracaoParaAprovados\": true,\n      \"BloquearAlteracaoParaMatriculados\": false,\n      \"IdConcurso\": \"a62ad202-b032-ed11-9db2-000d3a88f247\",\n      \"PermiteMultiplasInscricoes\": false,\n      \"ConcursoEnsinoBasico\": false,\n      \"AssinaturaObrigatoria\": false,\n      \"PreMatriculaID\": {\n        \"Id\": \"afd58840-7a3b-ed11-9db0-000d3a88e678\",\n        \"Nome\": \"Contrato Exemplo Edunext Docusign\",\n        \"NomeLogico\": \"cad_contrato\"\n      },\n      \"CodigoContrato\": 0,\n      \"IntegracaoAutomaticaSistemaExterno\": true,\n      \"PermiteInscricaoMesmaOferta\": false,\n      \"UtilizaContratoOnline\": true,\n      \"ResponsavelFinanceiroSegundaEtapa\": false,\n      \"_MensagemLgpd\": \"Mensagem LGPD (Login)\",\n      \"MensagemLgpd\": \"Mensagem LGPD (Login)\",\n      \"HabilitaLGPD\": false,\n      \"HabilitaCamposOpcionaisMobile\": false,\n      \"_MensagemResponsavelLegal\": \"Mensagem Responsável Legal LGPD (Dados)\",\n      \"MensagemResponsavelLegal\": \"Mensagem Responsável Legal LGPD (Dados)\",\n      \"_MsgConsentimentoRespLegalLGPD\": \"Mensagem Consentimento Responsável Legal LGPD (Dados)\",\n      \"MsgConsentimentoRespLegalLGPD\": \"Mensagem Consentimento Responsável Legal LGPD (Dados)\",\n      \"_MsgProgramaIndicacao\": \"testando123\",\n      \"MsgProgramaIndicacao\": \"testando123\",\n      \"_CheckboxConsentimentoRespLegalLGPD\": \"Checkbox Consentimento Responsável Legal LGPD (Dados)\",\n      \"CheckboxConsentimentoRespLegalLGPD\": \"Checkbox Consentimento Responsável Legal LGPD (Dados)\",\n      \"UtilizaContratoPosPagamento\": true,\n      \"LiberaPagamentoComplementacaoDados\": false,\n      \"LiberaPagamentoPreMatricula\": false,\n      \"LabelValordoCurso\": \"teste\",\n      \"LinkFichadeInscricao\": \"https://inscricaotime1-dev1.azurewebsites.net/login/108\",\n      \"UtilizaIntegracaoEdunext\": true,\n      \"Id\": \"a62ad202-b032-ed11-9db2-000d3a88f247\",\n      \"MinutoProvaValue\": -1,\n      \"DataInicial\": \"12-09-2022 11:00:00\",\n      \"DataFinal\": \"30-12-2023 11:00:00\",\n      \"QuantidadeOpcoesOferta\": \"Um\",\n      \"FormulariosExibidos\": \"Ambos\",\n      \"EmpresaIntegracaoIboundMarketing\": \"Desabilitado\",\n      \"TipoConcurso\": \"Enem\",\n      \"TipoCalculoFinal\": \"Media\",\n      \"OpcaoFormularioAlterado\": \"CadastroCompleto\",\n      \"OrdenacaoEnsalamento\": \"DataInscricao\",\n      \"CorIcones\": \"Clara\",\n      \"OrigemEnderecoComprovanteInscricao\": \"LocalAvaliacao\",\n      \"UF\": \"MG\",\n      \"OpcaoPagamento\": \"Curso\",\n      \"AlteracaoLocalProvaAte\": \"InscricaoPaga\",\n      \"TipoContrato\": \"PreMatricula\",\n      \"IntegracaoContratoOnline\": \"DocuSing\",\n      \"DataCriacao\": \"12-09-2022 15:31:50\",\n      \"DataModificacao\": \"30-11-2022 19:11:04\"\n    },\n    \"Interessado\": {\n      \"CamposFormulario\": [],\n      \"Nome\": \"Marco\",\n      \"ConcursoReferencia\": {\n        \"Id\": \"a62ad202-b032-ed11-9db2-000d3a88f247\",\n        \"Nome\": \"[Homologação 108]:: Concurso ENEM - EDUNEXT - Com pagamento de curso\",\n        \"NomeLogico\": \"cad_concurso\"\n      },\n      \"ConcursoAtualReferencia\": {\n        \"Id\": \"a62ad202-b032-ed11-9db2-000d3a88f247\",\n        \"Nome\": \"[Homologação 108]:: Concurso ENEM - EDUNEXT - Com pagamento de curso\",\n        \"NomeLogico\": \"cad_concurso\"\n      },\n      \"OfertaAtualReferencia\": {\n        \"Id\": \"6798cf08-b032-ed11-9db2-000d3a88f247\",\n        \"Nome\": \"Oferta Base ENEM\",\n        \"NomeLogico\": \"cad_oferta\"\n      },\n      \"InscricaoAtualReferencia\": {\n        \"Id\": \"11cc3884-da70-ed11-81ac-000d3a88f247\",\n        \"Nome\": \"CAN-004874-DEV\",\n        \"NomeLogico\": \"cad_inscricaocandidato\"\n      },\n      \"ProprietarioReferencia\": {\n        \"Id\": \"b03f2902-14c6-ec11-a7b5-002248d30908\",\n        \"Nome\": \"CRM Educacional, Atendimento\",\n        \"NomeLogico\": \"systemuser\"\n      },\n      \"UsuarioReferencia\": {\n        \"Id\": \"b03f2902-14c6-ec11-a7b5-002248d30908\",\n        \"NomeLogico\": \"systemuser\"\n      },\n      \"Email\": \"782.672.960-26@crm.com\",\n      \"SobreNome\": \"r\",\n      \"NomeCompleto\": \"Marco r\",\n      \"TelefoneCelular\": \"(11)11111-1111\",\n      \"CPF\": \"782.672.960-26\",\n      \"PreMatriculado\": false,\n      \"UrlCancelamentoContatos\": \"https://inscricaotime1-dev1.azurewebsites.net/PreferenciasContato?idLead=e40a3e7e-da70-ed11-81ac-000d3a88f247\",\n      \"RetornoSistemaExterna\": \"OK;\",\n      \"CEP\": \"31330000\",\n      \"EnderecoEstado\": \"MG\",\n      \"EnderecoCidade\": \"Belo Horizonte\",\n      \"EnderecoRua\": \"Avenida Altamiro Avelino Soares\",\n      \"EnderecoNumero\": \" \\\\z\",\n      \"EnderecoBairro\": \"Santa Cecilia\",\n      \"SincronizarBearings\": false,\n      \"SincronizadoPlanetaY\": false,\n      \"EnderecoComplemento\": \"s\",\n      \"NomeSocial\": \"Marco r\",\n      \"PossuiNomeSocial\": false,\n      \"TelefoneComercial\": \"(11)11111-1111\",\n      \"AceitouLgpd\": false,\n      \"ContaReferencia\": {\n        \"Id\": \"7acc46b6-98cc-ec11-a7b5-002248d2cd29\",\n        \"Nome\": \"Homologação Kratos MG\",\n        \"NomeLogico\": \"account\"\n      },\n      \"PreferenciaContatoColetada\": false,\n      \"EnderecoCountry\": \"x\",\n      \"Id\": \"e40a3e7e-da70-ed11-81ac-000d3a88f247\",\n      \"ConcursoOrigem\": {\n        \"HoraProvaValue\": -1,\n        \"ControleApuracaoID\": \"00000000-0000-0000-0000-000000000000\",\n        \"PermiteInscricaoCandidatosAprovadosOutrosConcursos\": true,\n        \"PermiteInscricoesDeMatriculadosOutrosConcursos\": true,\n        \"PermiteInscricaoCandidatosInscritosOutrosConcursos\": true,\n        \"BloquearAlteracaoParaAprovados\": false,\n        \"BloquearAlteracaoParaMatriculados\": false,\n        \"IdConcurso\": \"00000000-0000-0000-0000-000000000000\",\n        \"AssinaturaObrigatoria\": false,\n        \"CodigoContrato\": 0,\n        \"PermiteInscricaoMesmaOferta\": true,\n        \"UtilizaContratoOnline\": false,\n        \"HabilitaLGPD\": false,\n        \"UtilizaContratoPosPagamento\": false,\n        \"LiberaPagamentoComplementacaoDados\": false,\n        \"LiberaPagamentoPreMatricula\": false,\n        \"UtilizaIntegracaoEdunext\": false,\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"MinutoProvaValue\": -1\n      },\n      \"SituacaoFunil\": \"Convocado\",\n      \"DataNascimento\": \"19-02-1999 03:00:00\",\n      \"OrigemClientePotencial\": \"PortalCandidato\",\n      \"TipoInteressado\": \"Responsavel\",\n      \"UltimoLoginRealizado\": \"30-11-2022 18:12:11\",\n      \"PreferenciaContato\": \"QualquerUma\",\n      \"DataCriacao\": \"30-11-2022 18:12:05\",\n      \"DataModificacao\": \"30-11-2022 18:56:52\"\n    }\n  },\n  \"usuario\": \"\",\n  \"senha\": \"\"\n}                            \n

","_postman_id":"6de185da-de70-4123-a3fe-2152bd9beed2"},{"name":"Envio de Telefonemas (Outros Provedores)","item":[],"id":"26772d64-572a-4d0c-b225-02a49a5d7289","description":"

Objetivo

Possibilitar a realização de telefonemas automáticos com qualquer provedor de Call Center de sua preferência por meio desta integração genérica .

Para utilizar esta funcionalidade é necessário realizar as seguintes configurações no CRM Educacional:

Marketplace

A integração com Outros Provedores (Telefonema) é adquirida na opção Marketplace do menu Captação de Aluno do ambiente Dynamics CRM. Lá, um cartão do tipo Telefonema, possui um botão Detalhes que ao ser clicado abrirá uma nova janela com detalhes do serviço e um botão Obter agora.

\n\n\n\n\n\n

\n\n $\"Exemplo$ \n

\n\n\n

Ainda na entidade Marketplace preencha o campo URL do CRM.

Após adquirida, é necessário configurá-la com o preenchimento dos campos:

Token (Opcional): caso seja informado, em todas as requisições, enviaremos o parâmetro Authorization: \"Basic {Token}\" no header;
URL para ligação imediata (Obrigatório): URL da API que deverá ser criada pelo cliente para receber a requisição que é enviada ao clicar no botão \"ligar\" na entidade \"Interessado\" do CRM;
URL para envio para fila de atendimento (Obrigatório): URL da API que deverá ser criada pelo cliente para receber a requisição que é enviada sempre que um registro de Telefonema é criado no CRM;
URL para cancelamento de telefonema (Obrigatório): URL da API que deverá ser criada pelo cliente para receber a requisição que é enviada para cancelar um Telefonema.

Na entidade CRM Educacional será necessário preencher o campo Empresa (Telefonema), com a opção Outros Provedores.\nFeito isso será exibibo o campo Integração Telefonema, preencha com a Integração que você configurou no passo anterior através do MarketPlace.

\n\n\n\n\n\n\n

Configurando a seção Provedor de Envio de Telefonemas na entidade CRM Educacional
\n\n $\"Exemplo$ \n

\n\n\n

Ainda na entidade CRM Educacional preencha o campo URL do CRM com a URL do seu ambiente caso não esteja preenchida.

Caso possua dúvida em relação a URL, contate o nosso time de suporte.

\n\n\n\n\n\n\n

Configurando URL do CRM na entidade CRM Educacional
\n\n $\"Exemplo$ \n

\n\n

Após realizadas as configurações, os eventos abaixo serão enviados através de requisições HTTP para as URL's de API's informadas no Marketplace.

Importante: todas as requisições estão programadas com um Time-out de 3 segundos. Faz-se necessário levar isso em consideração na hora de desenvolver sua integração, sugerimos que armazene o JSON recebido para processar a integração com seu provedor em um segundo momento e retorne imediatamente para nossa API saber que receberam a requisição com sucesso.

Sempre salvaremos os retornos recebidos pelas API's no campo Retorno da entidade Telefonema, ou nos Logs do CRM

Sempre que um registro comum de telefonema for criado no CRM, iremos enviar a seguinte requisição:

URL: URL informada no campo \"URL para envio para fila de atendimento\"
Http Method: POST
Content Type: application/json
Conteúdo do Body: JSON informado no quadro abaixo

Para que isso seja possível é obrigatório que o campo Fila Prevista seja preenchido em todos os telefonemas.

Importante: Sempre que concluir uma ligação no Provedor de Call Center é necessário concluir também o Telefonema no CRM preenchendo os campos referentes ao resultado da ligação.

\n\n\n\n\n\n\n

Exemplo do JSON enviado nessa requisição

\n\n

{  \n   \"TelefonemaId\":\"31403aac-454b-e911-9633-000d3ac046b2\",\n   \"NomeEntidadeTelefonema\":\"phonecall\",\n   \"ChamadaParaId\":\"105ae739-1b4b-e911-9633-000d3ac046b2\",\n   \"NomeEntidadeChamadaPara\":\"lead\",\n   \"Token\":\"e4c07811-8f38-47b2-9f7a-f86c928cbe29\",\n   \"UrlTelefonemaCrm\":\"http%3A%2F%2Fcrm.crmeducacional.com%2FCRMDesenv%2Fmain.aspx%3Fetn%3Dphonecall%26pagetype%3Dentityrecord%26id%3D%257B31403aac-454b-e911-9633-000d3ac046b2%257D\",\n   \"IdentificadorFila\":\"5\",\n   \"FilaPrevista\":\"Nom da Fila Prevista\",\n   \"NomeCompleto\":\"Nome Sobrenome\",\n   \"TelefoneCelular\":\"(99)99999-9999\",\n   \"ConcursoAtual\":\"Nome do concurso Atual\",\n   \"OfertaAtual\":\"Nome da oferta Atual\",\n   \"TelefoneComercial\":\"(99)99999-9999\",\n   \"DataProva\":\"18/10/2019\",\n   \"SituacaoConcurso\":\"Inscrito\"\n}\n                                            \n

\n\n\n

Observe que além dos campos padrões, enviamos também Os IDs e Nomes das entidades Telefonema e a entidade do campo Chamada Para.

Isso abre a possibilidade do cliente utilizar nossas APIs genéricas para buscar mais campos, caso seja necessário.

Realizar Telefonemas imediatos para um Interessado

Existe um botão no menu dos registros de Interessado dentro do CRM para realizar ligações imediatas.

Para utlizar esse botão, é necessário informar o seu login de agente no Provedor de Call Center na seção Integração Telefonema na entidade Usuário no menu de configurações avançadas.

Feito isso, basta acessar o registro do lead que você deseja e clicar no botão Ligar.

\n\n\n\n\n\n\n

Preenchendo o Login/Agente na entidade Usuário
\n\n $\"Exemplo$ \n

\n\n\n

Nesse momento, iremos enviar a seguinte requisição:

URL: URL informada no campo \"URL para ligação imediata\"
Http Method: POST
Content Type: application/json
Conteúdo do Body: JSON informado no quadro abaixo

\n\n\n\n\n\n\n

Exemplo do JSON enviado nessa requisição

\n\n

{  \n   \"TelefonemaId\":\"67f0772d-444b-e911-9633-000d3ac046b2\",\n   \"NomeEntidadeTelefonema\":\"phonecall\",\n   \"ChamadaParaId\":\"105ae739-1b4b-e911-9633-000d3ac046b2\",\n   \"NomeEntidadeChamadaPara\":\"lead\",\n   \"LoginAgente\":\"operador.02\",\n   \"TelefoneCelular\":\"(99)99999-9999\",\n   \"Token\":\"e4c07811-8f38-47b2-9f7a-f86c928cbe29\"\n}\n

\n\n\n

Cancelar telefonema

Para cancelar um telefonema você deve incluir uma chamada para o método CancelarTelefonema da classe TelefonemaNegocio como uma das etapas do fluxo de trabalho.

$\"Exemplo$

Sempre que uma etapa do processo de inscrição for concluída e existirem telefonemas alocados para o candidato é possível configurar fluxos que cancelam esses telefonemas.

Nesse caso, iremos enviar a seguinte requisição:

URL: URL informada no campo \"URL para cancelamento de telefonema\" concatenada com os parametros Identificador da campanha e o Id do Telefonema (http://UrlParaCancelamentoTelefonema/identificadorcampanha/idtelefonema)
Http Method: DELETE

Atualizar telefonema

É possível utilizar a API Atualizar Telefonema (Ver documentação na aba API) para atualizar campos da entidade Telefonema via integração no CRM .

\n","_postman_id":"26772d64-572a-4d0c-b225-02a49a5d7289"},{"name":"Envio de Telefonemas (EVOLUX)","item":[],"id":"9cc95cce-4483-4221-8dc8-63946719dd89","description":"

Objetivo

A Integração do CRM com a Evolux possibilita a realização de telefonemas automáticos ao Call Center por meio dessa plataforma.

Para utilizar esta funcionalidade é necessário realizar as seguintes configurações no CRM Educacional:

1º Altere a seção Captação de alunos no menu lateral esquerdo do aplicativo para Configurações.

2º Clique na entidade CRM Educacional

3º Abra o registro da CRM Educacional

\n\n

4º Altere para a Guia Captação.

5º Identifique na seção Provedor de Envio de Telefonemas os campos Empresa (Telefonema), Token e URL API

\n\n

6º Preencha com as informações solicitadas:

Empresa (Telefonema) : Evolux
Token: O token da API é fornecido pela Evolux. Para obtê-lo é necessário acessar o seu ambiente Evolux, possuir acesso admininstrativo, acessar o menu de PBX, posteriormente o submenu configução, depois Tokens de API e por fim gerar um novo token.

\n\n

URL API : URL fornecida pela Evolux para acesso a plataforma.

Sempre que um registro comum de telefonema for criado no CRM, será criado um registro de assinante na EVOLUX.

Para que isso seja possível é obritagório que o campo Fila Prevista seja preenchido em todos os telefonemas, pois através dessa fila que será identificardo para qual campanha da EVOLUX será enviado o assinante.

\n\n

Para cada campanha existente na EVOLUX, deverá ser criada uma fila no CRM. Dentro dessa fila deve-se preencher o campo Identificador EVOLUX com o ID da campanha correspondente.

\n\n

Para encontrar o ID da Campanha basta logar na plataforma EVOLUX, no menu Discador/Campanhas, abrir a campanha desejada e copiar o ID na URL.

\n\n

Dentro da plataforma EVOLUX, na tela de edição de campanhas, será necessário preencher o campo URL Externa com o valor \"$url\" nas configurações avançadas.

Com isso, sempre que o atendente receber uma ligação, deverá clicar no botão Abrir Sistema Externo para abrir a tela referente ao telefonema dentro do CRM para que ele possa ser concluído.

\n\n

Botão para abrir o telefonema de dentro da ligação na EVOLUX

\n\n

Além dos campos obrigatórios da EVOLUX, nós também enviamos alguns campos customizados que podem ser utilizados pelos agentes conforme imagem abaixo.

Campos customizados enviados para a EVOLUX

\n\n

Importante: Sempre que concluir uma ligação na EVOLUX é necessário concluir também o Telefonema no CRM preenchendo os campos referentes ao resultado da ligação.

Realizar Telefonemas imediatos para um Lead

Para clientes que utilizam Integração com EVOLUX, foi criado um botão no menu dos registros de lead dentro do CRM para realizar ligações imediatas.

Para utlizar esse botão, é necessário informar o seu login de agente EVOLUX no campo Login/Agente na seção Integração Telefonema na entidade Usuário no menu de configurações avançadas -> Segurança

\n\n

Além disso é necessário estar logado na EVOLUX em uma outra \"aba\" do navegador.

Feito isso, basta acessar o registro do Lead que você deseja e clicar no botão Ligar.

\n\n

Cancelar telefonema

Para cancelar um telefonema você deve incluir uma chamada para o método CancelarTelefonema da classe TelefonemaNegocio como uma das etapas do fluxo de trabalho.

\n\n

Sempre que uma etapa do processo de inscrição for concluída e existirem telefonemas alocados para o candidato é possível configurar fluxos que cancelam esses telefonemas.

\n","_postman_id":"9cc95cce-4483-4221-8dc8-63946719dd89"},{"name":"Envio de Telefonemas (WEON)","item":[],"id":"6eeed2bb-d26f-4dc3-9427-295d9fe12320","description":"

Objetivo

Agora o CRM Educacional possui integração com a WeOn possibilitando a realização de telefonemas automáticos ao Call Center por meio dessa plataforma. Para utilizar esta funcionalidade é necessário realizar as seguintes configurações:

Marketplace

A integração com Weon é adquirida na opção Marketplace do menu Captação do ambiente Dynamics CRM. Lá, um cartão do tipo Telefonema, dedicado ao Weon, possui um botão Detalhes que, ao ser clicado, abre uma nova janela com detalhes do serviço e um botão Obter agora. Após adquirida, é necessário configura-la com o preenchimento dos campos:

Nome: nome da configuração a ser criada;
Descrição: descrição da configuração a ser criada;
Id da Campanha(Chamada Imediata): identificador de campanha de chamada imediata;
URL do Webservice: URL do web service do WeOn.

O próximo passo é definir o Provedor de Envio de Telefonemas do registro CRM Educacional (menu Configurações), selecionando a opção WeOn como Empresa e atribuindo ao campo Integração Telefonema a referência à configuração realizada via Marketplace.

Ainda, configurar uma fila de telefonemas com o ID da campanha WeOn.

Objetivo

Agora o CRM Educacional possui integração com a WeOn possibilitando a realização de telefonemas automáticos ao Call Center por meio dessa plataforma.

Para utilizar esta funcionalidade é necessário realizar as seguintes configurações no CRM Educacional:

Na entidade CRM Educacional será necessário escolher a opção WeOn no campo Empresa(Telefonema) e selecionar uma configuração no campo Integração telefonema na seção Provedor de Envio de Telefonemas.

Configurando a seção Provedor de Envio de Telefonemas na entidade CRM Educacional

\n\n

Ainda na entidade CRM Eduaccional preencha o campo URL do CRM

Configurando URL do CRM na entidade CRM Educacional

\n\n

Sempre que um registro comum de telefonema for criado no CRM, iremos criar uma registro de assinante na WEON.

Para que isso seja possível é obritagório que o campo Fila Prevista seja preenchido em todos os telefonemas. Pois através dessa fila é que iremos identificar para qual campanha da WEON enviaremos esse asinante.

Para cada campanha existente na WEON, deve ser criada uma fila no CRM. Dentro dessa fila deve-se preencher o campo Identificador Campanha com o ID da campanha correspondente.

Preenchendo o campo Fila Prevista na entidade Telefonema

Campo Identificador Campanha na entidade Fila

\n\n

Para encontrar o ID da Campanha basta logar na plataforma WEON, no menu Aplicações/Call Center/Discador e copiar o id da execução da campanha desejada.

Obtendo o ID da Campanha na WEON

\n\n

Dentro da plataforma WEON, na tela de edição de campanhas, será necessário preencher o campo URL com o valor \"URL_do_CRM/main.aspx?etn=phonecall&pagetype=entityrecord&id={[idtelefonemacrm]}\" substituindo o \"URL_do_CRM\" pela URL do CRM, para que este campo seja exibido clique na opção URL Open. Com isso, sempre que o atendente receber uma ligação, será aberto uma tela referente ao telefonema dentro do CRM para que ele possa ser concluído.

Configurando URL na WEON

\n\n

Configuração de campos customizados

Sempre que um telefonema é enviado para a WeOn são enviados alguns campos que podem ser utilizados no script de atendimento. Para criar estes campos no ambiente WeOn, acesse o menu Aplicações/Call Center/Contatos(Leads)/Informações preencha os campos Nome da coluna, Descrição da coluna, Tipo da coluna e clique em Criar.

Obs. Apenas os campos listados na tabela abaixo podem ser criados para que a integração funcione corretamente.

Nome da Coluna	Descrição da Coluna	Tipo da Coluna
concursoatual	ConcursoAtual	VARCHAR(150)
ofertaatual	OfertaAtual	VARCHAR(150)
telefonecomercial	TelefoneComercial	VARCHAR(20)
telefone2	Telefone2	VARCHAR(20)
telefone3	Telefone3	VARCHAR(20)
dataprova	DataProva	DATE
situacaoaluno	Situação do aluno	VARCHAR(300)
idtelefonemacrm	Id do Telefonema no CRM	VARCHAR(30)
filaprevista	FilaPrevista	VARCHAR(80)

Criando campos customizados

\n\n

Importante: Sempre que concluir uma ligação na WEON é necessário concluir também o Telefonema no CRM preenchendo os campos referentes ao resultado da ligação.

Realizar Telefonemas imediatos para um Interessado

Para clientes que utilizam Integração com WEON, foi criado um botão no menu dos registros de Interessado dentro do CRM para realizar ligações imediatas.

Para utlizar esse botão, é necessário informar o seu Id de agente WEON no campo Login/Agente na seção Integração Telefonema na entidade Usuário do CRM.

Além disso é necessário estar logado na WEON em uma outra \"aba\" do navegador.

Realizando uma ligação imediata

\n\n

Feito isso, basta acessar o registro do Interessado que você deseja e clicar no botão Ligar.

Preenchendo o Login do Operador na entidade Usuário

\n\n

Cancelar telefonema

Para cancelar um telefonema você deve incluir uma chamada para o metodo CancelarTelefonema da classe TelefonemaNegocio como uma das etapas do fluxo de trabalho.

![](https://portal.crmeducacional.com/Imagens/Documentacao/Dynamics CRM/FluxoEtapaCancelarTelefonema.png)

![](https://portal.crmeducacional.com/Imagens/Documentacao/Dynamics CRM/FluxoCancelarTelefonemaParametrosWorkflow.png)

Sempre que uma etapa do processo de inscrição for concluída e existirem telefonemas alocados para o candidato é possível configurar fluxos que cancelam esses telefonemas. Veja a documentação de cancelamento de telefonemas no menu Dynamics CRM para mais informações.

\n","_postman_id":"6eeed2bb-d26f-4dc3-9427-295d9fe12320"},{"name":"Formulário de Interesse","item":[{"name":"Formulário de Interesse","id":"389a3212-46ee-4fb9-a6e6-c2712be9b01d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer IJjrtChsl8pPMeD8aFxleRojnBjwA7HGD2_tWSgdzduieIYy_zO605IFxheaoul4vagW6jJHqpVqmocey95B1lG8mqnFm6WBa5OyxW9GWnGQasYaNxHTIzjYJ2dIz-QWJ7a_7uIq2dbzoIzWpUDM7zshqHBRyEL6XQmcKr3H0d80HPf5uV4SAg5pAbNOyODsy6RcBm33U6rXbcoJNhP7DRRJLrJEsa8yO--eijr_MbTmye8HjEEaLgc8lPBoZscO","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://XXXapi.crmeducacional.com/api/IntegracaoFormularioInteresse/SalvarDados","description":"

Objetivo

A utilização desta API permite a criação e atualização de registros de leads no CRM, baseando-se na integralização de informações coletadas através de formulários web personalizados, denominados Formulário de Interesse.

Não existem restrições em relação aos campos da entidade leads que podem ser integralizados, porém é necessário atenta-se ao nome lógico e o formato de envio dos dados.(Caso possua dúvidas em relação a como identificar os nomes lógicos e demais parâmetros, sugerimos que retorne a seção de informações importantes).

Obs.: Só é possível integrar dados relacionados a entidade lead.

Na utilização deste método para requisição via Postman, os dados são enviados no params, ou seja, na URL da requisição.

Atenção! : A CRM não disponibiliza / desenvolve formulários personalizados.

Informação a ser enviada no params:

Exemplo 1:

Formato
Nome_do_Campo=Valor&Nome_do_Campo2=Valor

\n\n

Exemplo
cad_cpf=123.456.789-00&cad_datanascimento=01/01/2015

\n\n

Exemplo completo.
https://XXXapi.crmeducacional.com/api/IntegracaoFormularioInteresse/SalvarDados?cad_cpf=272.622.110-64&cad_datanascimento=01/01/2015

\n\n

Equipe ou Usuário

É possível a criação do mesmo lead em mais de uma Unidade de Negócio, para isso, deverá ser informado o parâmetro Equipe ou Usuário (ver exemplo abaixo). Tanto o nome da equipe quanto o usuário devem está cadastrados no CRM.

\n\n

Exemplo 2 e 3:

Exemplo parâmetro	Exemplo da URL requisição
usuario=CRMEducacional	https://XXXapi.crmeducacional.com/api/IntegracaoFormularioInteresse/SalvarDados?cad_cpf=272.622.110-64&cad_datanascimento=01/01/2015&usuario=CRMEducacional
equipe=Comercial	https://XXXapi.crmeducacional.com/api/IntegracaoFormularioInteresse/SalvarDados?cad_cpf=272.622.110-64&cad_datanascimento=01/01/2015&equipe=Comercial

\n\n

Possíveis Retornos:

Status: 200

{\n    \"Status\": \"Sucesso\", \n    \"Mensagem\": \"Dados criados/atualizados com sucesso.\",\n    \"InteressadoID\": \"a11a1111-aa11-a111-111a-111a1aa111a2\"\n}\n\n

Status: 500

{\n     \"Status\": \"Falha\",\n     \"Mensagem\":\"O Lead não foi salvo pois XXXXXX. Detalhes: YYYYYY.\"\n}\n\n

Regras de Atualização e Criação de Registros:

• Caso seja informado um CPF inexistente na base e um e-mail também inexistente, o Lead será criado com os dados enviados.

• Caso seja informado um CPF já existente na base e um e-mail ainda inexistente, o Lead será encontrado pelo CPF e seu e-mail e demais dados enviados serão alterados.

• Caso seja informado um CPF não existente na base e um e-mail existente, o Lead será encontrado pelo e-mail e seu CPF e demais dados enviados serão alterados.

• Caso seja informado um CPF existente na base e um e-mail também existente (em um mesmo Lead), o Lead terá os dados enviados alterados.

• Caso seja informado um CPF existente na base, e-mail e ID também existentes (em Leads diferentes), nenhum dos dados será alterado nos Leads e será gerado um Log informando a inconsistência e os valores dos campos enviados na requisição;

• Caso seja informado um responsável e não seja informado um CPF e/ou um e-mail na criação, o Lead será criado com os dados informados (Captação para Colégios);

• Na atualização, caso não tenha sido enviado nem o e-mail e nem o CPF do Lead, o Lead será buscado pelo ID. (Captação para Colégios);

• Todos os campos que exigem algum tipo de validação serão verificados segundo as regras da Ficha de Inscrição, caso não atendam aos requisitos não serão salvos e será gerado um Log informativo.

Exemplo de código

public static void PostarDadosFormInteresse(string urlPost, Dictionary camposValores)\n{\n    string parametros = \"\";\n    bool incluirEComercial = false;\nforeach (KeyValuePair campoInterno in camposValores)\n{\n    if (incluirEComercial)\n    parametros += \"&\";\n    else\n    incluirEComercial = true;\n    parametros += string.Format(\"{0}={1}\", campoInterno.Key, campoInterno.Value);\n}\nSystem.Net.ServicePointManager.Expect100Continue = false;\nHttpWebRequest req = (HttpWebRequest)WebRequest.Create(urlPost);\nreq.Method = \"POST\";\nreq.ContentType = \"application/x-www-form-urlencoded\";\nbyte[] byteArray = Encoding.UTF8.GetBytes(parametros);\nreq.ContentLength = byteArray.Length;\nStream streamOut = req.GetRequestStream();\nstreamOut.Write(byteArray, 0, byteArray.Length);\nstreamOut.Close();\ntry\n{\nStreamReader streamIn = new StreamReader(req.GetResponse().GetResponseStream());\nstring res = streamIn.ReadToEnd();\nstreamIn.Close();\n}\ncatch (Exception e)\n{\nstring descricaoErro = string.Format(\"ERROR {0} - {1} - {2} - {3}\", e.InnerException, e.Message, e.StackTrace, e.Source);\n}\n}\n\n

Visualização dos logs

Caso ocorra alguma divergência no momento da integração, será gerado um Log informando o motivo. Esses logs poderão ser visualizados no CRM, na entidade Logs do Sistema que fica localizado no menu lateral direito do aplicativo CRM Educacional - Administração.

\n\n

Exemplo:

\n\n

","urlObject":{"protocol":"https","path":["api","IntegracaoFormularioInteresse","SalvarDados"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[{"id":"cc4efeb0-0326-4cdd-aaae-a69189e7d0aa","name":"Exemplo 1 - Envio de Campos","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer IJjrtChsl8pPMeD8aFxleRojnBjwA7HGD2_tWSgdzduieIYy_zO605IFxheaoul4vagW6jJHqpVqmocey95B1lG8mqnFm6WBa5OyxW9GWnGQasYaNxHTIzjYJ2dIz-QWJ7a_7uIq2dbzoIzWpUDM7zshqHBRyEL6XQmcKr3H0d80HPf5uV4SAg5pAbNOyODsy6RcBm33U6rXbcoJNhP7DRRJLrJEsa8yO--eijr_MbTmye8HjEEaLgc8lPBoZscO","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":{"raw":"https://XXXapi.crmeducacional.com/api/IntegracaoFormularioInteresse/SalvarDados?cad_cpf=123.456.789-00&cad_datanascimento=01/01/2015","protocol":"https","host":["XXXapi","crmeducacional","com"],"path":["api","IntegracaoFormularioInteresse","SalvarDados"],"query":[{"key":"cad_cpf","value":"123.456.789-00"},{"key":"cad_datanascimento","value":"01/01/2015"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"53cd8e19-477f-4d69-8851-6b0bf3d4b6f2","name":"Exemplo 2 - Envio de Dados - Com Usuário","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer IJjrtChsl8pPMeD8aFxleRojnBjwA7HGD2_tWSgdzduieIYy_zO605IFxheaoul4vagW6jJHqpVqmocey95B1lG8mqnFm6WBa5OyxW9GWnGQasYaNxHTIzjYJ2dIz-QWJ7a_7uIq2dbzoIzWpUDM7zshqHBRyEL6XQmcKr3H0d80HPf5uV4SAg5pAbNOyODsy6RcBm33U6rXbcoJNhP7DRRJLrJEsa8yO--eijr_MbTmye8HjEEaLgc8lPBoZscO","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":{"raw":"https://XXXapi.crmeducacional.com/api/IntegracaoFormularioInteresse/SalvarDados?cad_cpf=272.622.110-64&cad_datanascimento=01/01/2015&usuario=CRMEducacional","protocol":"https","host":["XXXapi","crmeducacional","com"],"path":["api","IntegracaoFormularioInteresse","SalvarDados"],"query":[{"key":"cad_cpf","value":"272.622.110-64"},{"key":"cad_datanascimento","value":"01/01/2015"},{"key":"usuario","value":"CRMEducacional"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"47bc1b37-d243-4de9-a199-19ad2340b4ab","name":"Exemplo 3 - Envio de dados - Com Equipe","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer IJjrtChsl8pPMeD8aFxleRojnBjwA7HGD2_tWSgdzduieIYy_zO605IFxheaoul4vagW6jJHqpVqmocey95B1lG8mqnFm6WBa5OyxW9GWnGQasYaNxHTIzjYJ2dIz-QWJ7a_7uIq2dbzoIzWpUDM7zshqHBRyEL6XQmcKr3H0d80HPf5uV4SAg5pAbNOyODsy6RcBm33U6rXbcoJNhP7DRRJLrJEsa8yO--eijr_MbTmye8HjEEaLgc8lPBoZscO","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":{"raw":"https://XXXapi.crmeducacional.com/api/IntegracaoFormularioInteresse/SalvarDados?cad_cpf=272.622.110-64&cad_datanascimento=01/01/2015&equipe=Comercial","protocol":"https","host":["XXXapi","crmeducacional","com"],"path":["api","IntegracaoFormularioInteresse","SalvarDados"],"query":[{"key":"cad_cpf","value":"272.622.110-64"},{"key":"cad_datanascimento","value":"01/01/2015"},{"key":"equipe","value":"Comercial"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"389a3212-46ee-4fb9-a6e6-c2712be9b01d"}],"id":"ce98f148-375a-4fcc-b144-80fa24276dff","_postman_id":"ce98f148-375a-4fcc-b144-80fa24276dff","description":""},{"name":"HubSpot - através de formulários - API V2","item":[],"id":"ee86e7a1-2d97-467b-a9b6-ef0c5d3cd096","description":"

Objetivo

O objetivo desta integração é poder alterar o estágio do funil do Lead na HubSpot de acordo com as alterações do Lead na Ficha de Inscrição ou no CRM.

Nesta integração também tem como o objetivo que o lead seja criado através de Direct Traffic e, que durante a criação do lead, a sua origem seja especificada com o valor CRM Educacional.

Quando o candidato completar a inscrição pela ficha de inscrição, o estado do Lead na HubSpot será alterado para Opportunity.

Para utilizar esta integração é necessário criar um formulário no HubSpot, pois para esta integração é necessário especificar Portal ID e o Guid do formulário do Hubspot, além do ID do cliente.

Criando um Formulário no HubSpot
No menu Superior >> Contatos >> Formulários. Depois que acessar, clicar no botão (Criar formulário).

Após criado o formulário, você será redirecionado para um link do qual você deverá guardar os seguintes valores. 1 - Portal ID e 2 - Guid do formulário do Hubspot

Será preciso também, preencher os campos ID Cliente HubSpot e Segredo Cliente HubSpot no CRM, além de também ser necessário preencher o campo Portal ID e Guid do formulário do HubSpot em CONFIGURAÇÕES – CRM Educacional. Quando utilizada a integração por Formulário, também existem alguns campos opcionais que podem ser específicados, assim serão preenchidos alguns campos customizados do HubSpot com os valores respectivos vindos do CRM durante a inscrição do candidato, sendo eles: Campo Customizado Nome Campo Customizado Sobrenome Campo Customizado E-mail Campo Customizado CPF Campo Customizado Serviço Educacional Campo Customizado Primeira Opção de Curso Campo Customizado Linha de Negócio Celular - HubSpot Telefone - HubSpot CEP - HubSpot Forma de Ingresso - HubSpot Categoria (Campus / Polo) - HubSpot Turno - HubSpot Semestre - HubSpot Data da Prova - HubSpot (Campo enviado no formato texto. Ex: 14/10/2019) Hora da Prova - HubSpot Ano do Enem - HubSpot Nota Final do Enem - HubSpot Instituição de Origem - HubSpot Curso de Origem - HubSpot Ano de Formação - HubSpot Ano de Ingresso - HubSpot Semestre Atual - HubSpot Situação no Funil Interessado - Hubspot Oferta Tradicional - HubSpot Oferta Enem - HubSpot Oferta Agendado - HubSpot Oferta PROUNI - HubSpot Oferta Pós-Graduação - HubSpot Oferta Cursos Livres - HubSpot Oferta Transferência - HubSpot Oferta Diploma - HubSpot Oferta Medicina - HubSpot Oferta Redação Online - HubSpot Situação Concurso Tradicional - HubSpot Situação Concurso Enem - HubSpot Situação Concurso Agendado - HubSpot Situação Concurso PROUNI - HubSpot Situação Concurso Pós-Graduação - HubSpot Situação Concurso Cursos Livres - HubSpot Situação Concurso Transferência - HubSpot Situação Concurso Diploma - HubSpot Situação Concurso Medicina - HubSpot Situação Concurso Redação Online - HubSpot Mais abaixo será demonstrado como criar os campos customizados no hubspot.

\n\n

Exemplo

\n\n

Para encontrar seu ID do Cliente e seu Segredo do Cliente, basta logar na sua conta de desenvolvedor da HubSpot, acessar o aplicativo que deseja utilizar na integração e copiar os valores.

Exemplo

\n\n

Geração de Token de Autenticação

\n\n

Para Gerar o Token, deve ser acessado o Portal da CRM (https://portal.crmeducacional.com/), clicar em Captação, depois em Integrações, aba de Integrações e selecionar a Integração com HubSpot. Lá terá o botão demostrado abaixo, que realizará a geração do token.

\n\n

Deve ser informado o ID do Cliente no campo, realizar um clique em Gerar Token e permitir o acesso à sua aplicação na janela que será aberta.

\n\n

\\\\*Atenção: Ao clicar no botão, o token de acesso será atualizado no seu CRM.

\n\n

Em caso de sucesso, você será redirecionado para uma página com a seguinte mensagem:

\n\n

Caso o Lead ainda não exista na HubSpot. O CRM Educacional disponibiliza a opção de criar um novo Lead na HubSpot. Para isso é necessário marcar SIM no campo Criar Candidatos na Empresa de Inbound na entidade CRM Educacional

Exemplo

\n\n

Abaixo o exemplo de criação do Lead no Hubspot, este processo será executado pela ficha de inscrição durante o processo de criação do Lead no CRM e, após a criação do mesmo no HubSpot este será marcado como Oportunidade.

Exemplo

\n\n

Quando a situação do candidato no concurso mudar para Matriculado, será executado o processo CRM Educacional :: Atualizar Lead Inbound Marketing que irá atualizar a situação do Lead na HubSpot para Cliente.

Exemplo

\n\n

Configurações do CRM

Para utilizar a integração com HubSpot você deverá selecionar a opção HubSpot no Pick List Integração Inbound Marketing nas configurações do concurso no CRM em CAPTAÇÃO – Concursos.

Exemplo

\n\n

Também será preciso definir em qual momento os leads serão enviados para o HubSpot, cujas opções são: Criação da Inscrição ou Conversão.

Para que os leads sejam enviados para um formulário específico de cada concurso, será preciso preencher o Portal ID e o Guid do Formulário HubSpot em cada concurso. Caso não seja preenchido no concurso, os leads serão enviados para o Guid do Formulário HubSpot que consta da entidade CRM Educacional.

Logs de Integração Inbound Marketing

Caso por algum motivo em algum momento a integração falhar, será gerado um log informando o que ocorreu. Esses Logs poderão ser visualizados no CRM em Local de Trabalho – Atividades – Log Genérico – Logs de Integração Inbound Marketing.

\n\n

Exemplo

\n\n

Campo Customizado da Oferta

É possível criar um campo customizado na HubSpot para salvar o Alias do Serviço Educacional da oferta selecionada para primeira opção de curso pelo candidato. Para isso basta criar um campo customizado na HubSpot e informar seu nome no campo Campo Customizado da Oferta na entidade CRM Educacional conforme imagem à baixo:

\n\n

Exemplo

\n\n

Observação:

Para que a integração funcione corretamente é necessário que as ofertas possuam um Serviço Educacional vinculado a elas com o campo Alias preenchido.

\n\n

Campo Customizado Linha de Negocio

É possível criar um campo customizado na HubSpot para salvar a Linha de Negócio do concurso da inscrição do candidato. Preencha o campo Campo Customizado Linha de Negocio com o mesmo nome do campo criado dentro do ambiente da HubSpot

\n\n

Exemplo

\n\n

Para que a integração funcione corretamente é necessário informar o nome do campo Linha de Negócio do concurso no campo Nome do Campo Linha de Negócio da entidade CRM Educacional.

\n\n

Exemplo

\n\n

Exemplo do campo no ambiente da HubSpot

\n\n

Como marcar Leads como Perdidos na HubSpot

Foi criado um processo no CRM chamado “CRM Educacional :: Marcar Leads como Lost na ferramenta de inbound”. Este fluxo pode ser executado sob demanda a partir de qualquer concurso. Ao ser executado, os leads de todos os candidatos que estão com a situação no concurso diferente de “Matriculado” terão seu \"Lifecycle stage\" alterado de volta para \"Sales Qualified Lead\" se existirem na HubSpot.

","_postman_id":"ee86e7a1-2d97-467b-a9b6-ef0c5d3cd096"},{"name":"Integração com SMS","item":[],"id":"9db7cc00-9b31-432a-8f00-015afc53fcf6","description":"

Objetivo

\n\n

Descrever como realizar as configurações necessárias para realização do envio de SMS pela CRM Educacional, bem como a sua utilização.

Estão disponíveis para utilização as seguintes empresas de SMS:

Marktel (Online e On Premises)
Globecall (Somente On Premises)
Movile (Online e On Premises)
Outros Provedores (Online e On Premises)

Existem duas modalidades para o envio de SMS, sendo uma padrão e outra para que seja possível selecionar de qual integração será enviado o SMS, para casos em que existam mais de uma integração de SMS configurada no ambiente.

Primeiramente, iremos abordar as configurações para o envio padrão de SMS:

1º Passo : Acessar a entidade CRM Educacional, para isso clique em configurações no menu lateral esquerdo, posteriormente clique na entidade CRM Educacional.

$\"Exemplo$

2º Passo : Selecione a integração padrão desejada para o envio de SMS na guia Captação, seção Provedor de envio de SMS's

$\"Exemplo$

Preencha os campos de cada integração com os dados de acesso para as mesmas. Os campos disponíveis são:

Usuário (SMS)
Senha (SMS)
Token
Id do Cliente
Id da Conta

Cada Empresa (SMS) possuí seus respectivos campos:

Marktel (Online e On Premises)\n
- Usuário (SMS):O campo usuário deverá ser preenchido com o valor informado no campo Usuário webservices proveniente das configurações originadas da Marktel
- Senha (SMS): O campo senha deverá ser preenchido com o token gerado no campo Webservices token proveniente das configurações originadas da Marktel\n
\n
Globecall (Somente On Premises)\n
- Usuário (SMS)
- Senha (SMS)\n
\n
Movile (Online e On Premises)\n
- Usuário (SMS)
- Senha (SMS)
- Token\n
\n
Outros Provedores (Online e On Premises)\n
- Integração (SMS) (Nesse caso, deverá vincular a Integração configurada no Marketplace e lá preencher os campos abaixo)
- URL (Obrigatório)
- Token (Opcional)
\n

Adicionando mais de uma empresa de envio de SMS

\n\n

Para incluir novas empresas de envio de SMS, acesse os Usuários de Integração por meio do menu Configurações no menu lateral esquerdo e clique no botão de criar.

$\"Exemplo$

Ao inserir um novo Usuário de Integração, defina seu tipo como Envio SMS:

$\"Exemplo$

No momento em que definir o tipo como Envio SMS, irá aparecer o campo de Empresa (SMS) e a partir da escolha desse campo, irão ser apresentados os respectivos campos da integração.

Definindo a Conta de Envio da SMS

\n\n

Podemos definir se queremos que uma SMS seja enviada utilizando a integração de SMS padrão (definida na entidade CRM Educacional) ou se irá utilizar alguma das outras integrações de SMS cadastradas nos Usuários de Integração.

Para definir que uma SMS será enviada por algum Usuário de Integração, devemos preencher o campo Conta de Envio.

Para definir que uma SMS será enviada pela integração padrão, devemos deixar o campo Conta de Envio vazio.

$\"Exemplo$

Integração com Outros Provedores

\n\n

A integração com Outros Provedores permite ao cliente implementar uma integração com qualquer provedor de envio de SMS de sua preferência.

Para isso deve-se selecionar a opção Outros Provedores nas configurações realizadas acima e informar uma configuração realizada no Marketplace da CRM Educacional.

$\"Exemplo$

Lá, um cartão do tipo SMS, dedicado à Outros Provedores, possui um botão Detalhes que, ao ser clicado, abre uma nova janela com detalhes do serviço e um botão Obter agora. Após adquirida, é necessário configurá-la com o preenchimento dos campos:\n

URL (Obrigatório): URL para qual enviaremos a requisição contendo o JSON referente ao SMS a ser enviado;\n
Token (Opcional): caso o token seja informado iremos enviar o parâmetro Authorization no hearder da requisição com o valor: \"Base {Token}\";

Feito isso, toda vez que um SMS for enviado pelo CRM enviaremos a seguinte requisição:

URL: URL informada na configuração do Marketplace;
Http Method: POST
Content Type: application/json
Conteúdo do Body: JSON informado no quadro abaixo

\n\n\n\n\n\n\n

Exemplo do JSON enviado nessa requisição
\n\n `{ \n \"Token\":\"token\",\n \"SmsId\":\"b3b6f9f8-a14c-e911-9635-000d3ac046b2\",\n \"TelefoneCelular\":\"31999999999\",\n \"Mensagem\":\"mensagem\"\n}\n`

\n\n\n\n\n

A API desenvolvida pelo cliente deverá devolver o seguinte JSON de retorno:

\n\n\n\n\n\n\n

Exemplo do JSON enviado nessa requisição
\n\n `{ \n \"IdConsulta\":\"id-consulta-123\",\n \"Status\":200,\n \"Mensagem\":\"mensagem de retorno\"\n}\n \n`

\n\n

Todo retorno que recebermos, iremos salvar no campo Retorno dentro do registro de SMS no CRM.

O campo \"IdConsulta\" do JSON acima será salvo no campo \"ID de Consulta\" do registro de SMS no CRM.

Importante: todas as requisições estão progamadas com um Time-out de 3 segundos. Faz-se necessáiro levar isso em consideração na hora de desenvolver sua integração, sugerimos que armazene o JSON recebido para processar a integração com seu provedor em um segundo momento e retorne imediatamente para nossa API saber que receberam a requisição com sucesso.

\n","_postman_id":"9db7cc00-9b31-432a-8f00-015afc53fcf6"},{"name":"Omnichannel - Genérico","item":[{"name":"Integração Omnichannel - Genérico","id":"7c19f0f5-cbd2-43af-a423-f5d9fe1a59dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"DadosOmniGenerico\": {\r\n \"Nome\": \"Aluna Teste\",\r\n \"Email\": \"aluna.teste@teste.com.br\",\r\n \"Telefone\": \"5531975459156\",\r\n \"CPF\": \"767.351.750-77\",\r\n \"Atendente\": \"Juliano Serra\",\r\n \"EmailAtendente\": \"juliano_atendimento@crmeducacional.com\",\r\n \"Media\": \"WHATSAPP\",\r\n \"Id\": null,\r\n \"HashInteracao\": \"\",\r\n \"Browser\": \"\",\r\n \"SistemaOperacional\": \"\",\r\n \"Ip\": \"\",\r\n \"Messages\": [\r\n {\r\n \"Dataehora\": \"2021-12-21T14:03:49.000Z\",\r\n \"Mensagem\": \"Ok\",\r\n \"Remetente\": \"CLIENT\"\r\n },\r\n {\r\n \"dataehora\": \"2021-12-21T14:05:02.000Z\",\r\n \"mensagem\": \"Informe sua idade \",\r\n \"remetente\": \"AGENT\"\r\n },\r\n {\r\n \"dataehora\": \"2021-12-21T14:05:09.000Z\",\r\n \"mensagem\": \"18\",\r\n \"remetente\": \"CLIENT\"\r\n },\r\n {\r\n \"dataehora\": \"2021-12-21T14:05:17.000Z\",\r\n \"mensagem\": \"Obrigado\",\r\n \"remetente\": \"AGENT\"\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://XXXapi.crmeducacional.com/api/IntegracaoOmnichannel/SalvarHistoricoGen","description":"

Objetivo

O objetivo dessa integração é explicar como configurar uma integração entre o CRM Educacional com sistemas omnichannel genéricos, permitindo a criação e busca de Leads, bem como o o salvamento do histórico das conversas realizadas pela ferramenta.

O chatBot poderá ser incorporado à Ficha de Inscrição, recuperando dados do candidato antes do ínicio da inscrição.

Parâmetros obrigatórios
Nome Email EmailAtendente Media Messages

\n\n

Regras para Criação dos Registros

• Caso seja informado um e-mail inexistente, o Lead será criado com os dados enviados.

• Caso seja informado um e-mail existente, o registro da Atividade será cadastrada no respectivo Lead do E-mail informado.

• Caso seja informado um CPF inexistente na base e um e-mail também inexistente, o Lead será criado com os dados enviados.

• Caso seja informado um CPF já existente na base e um e-mail ainda inexistente, o Lead será encontrado pelo CPF e seu e-mail e demais dados enviados serão alterados.

• Caso seja informado um CPF não existente na base e um e-mail existente, o Lead será encontrado pelo e-mail e seu CPF e demais dados enviados serão alterados.

• Caso seja informado um CPF existente na base e um e-mail também existente (em um mesmo Lead), o Lead terá os dados enviados alterados.

• Caso seja informado um CPF existente na base, e-mail e ID também existentes (em Leads diferentes), nenhum dos dados será alterado nos Leads e será gerado um Log informando a inconsistência e os valores dos campos enviados na requisição;

• Caso seja informado um responsável e não seja informado um CPF e/ou um e-mail na criação, o Lead será criado com os dados informados (Captação para Colégios);

Mensagens de Retornos:

Sucesso: \"Omnichannel criado/atualizado com sucesso\"
Erro e respectivos campos:\n Mídia: { \"Midia é um campo obrigatório\"},
Canal{\"Não foi possível recuperar o canal da mensagem.\"},
E-mai: { \"Não foi possível recuperar o parâmetro 'email'\"}
\"Message\": \"O histórico não foi enviado.\"

Histórico da Conversa

A atividade será criada no respectivo lead informado.

Exemplo:

\n\n

Para acessar as demais informações da conversa, acesse a guia Mensagens

","urlObject":{"protocol":"https","path":["api","IntegracaoOmnichannel","SalvarHistoricoGen"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7c19f0f5-cbd2-43af-a423-f5d9fe1a59dc"}],"id":"80cdc79e-13bd-40dd-b567-d9bcc9d47c2a","_postman_id":"80cdc79e-13bd-40dd-b567-d9bcc9d47c2a","description":""}],"id":"5a30de35-5f0c-403f-b5f0-d27db1e4124c","_postman_id":"5a30de35-5f0c-403f-b5f0-d27db1e4124c","description":""},{"name":"Integração Genérica - Cadastro de Leads e Inscrições","item":[{"name":"Integração Genérica - Cadastro de Lead e Inscrição","item":[{"name":"API Genérica Cadastro Inscrição","id":"3dcf53ba-625c-4886-9c82-4f507631ad40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"bearer 9eUcpwK9aHiA0bxkmu-SlYBPxz5c8rcyWhYQp4GC0h2LK_pyKWKezpR39STbOQRFJm5YHbqbDetVSyomzc9RxRtU9GdnDFgIn5_H6d7ohNjeAc5A0SGK7PZ718Jb8W2MhiS3ii42F04q6zzc-vYos1jG9KTSGADuQrtzRyOm0yMPx0WXFDF9NtI7otg4gq7E8s5d_YOMmmmPVIKVSM3F9hGmPrIW74_rOYPHRlAlTwlXwrAxkvMok20EMjhwIS8g"}],"body":{"mode":"raw","raw":"{\r\n \"concurso\": {\r\n \"attributes\": {\r\n \"cad_codigo\": 10098\r\n }\r\n },\r\n \"lead\": {\r\n \"attributes\": {\r\n \"cad_cpf\": \"111.111.111-11\",\r\n \"emailaddress1\": \"crmeducacional@crmeducacional.com\",\r\n \"firstname\": \"CRM\",\r\n \"lastname\": \"Educacional\",\r\n \"mobilephone\": \"(12) 11111-1111\"\r\n }\r\n },\r\n \"inscricao\": {\r\n \"attributes\": {\r\n \"cad_situacao\": 2,\r\n \"cad_codigoconsultor\": \"119288f8-adc7-ec11-a7b5-002248d30698\"\r\n }\r\n },\r\n \"categoria\": {\r\n \"attributes\": {\r\n \"cad_identificadorcategoria\": \"CRM Educacional\",\r\n \"cad_name\": \"Minas Gerais\",\r\n \"cad_exibenaoferta\": true\r\n }\r\n },\r\n \"oferta\": {\r\n \"attributes\": {\r\n \"cad_identificadoroferta\": \"MedicinaBeloHorizonte\",\r\n \"cad_nome\": \"Medicina\",\r\n \"cad_quantidadevagas\": 100\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://XXXapi.crmeducacional.com/api/IntegracaoGenericaClientes/CadastroInscricao","description":"

Esse endpoint é usado para criar um novo Lead e/ou inscrição no Wakeme. Ele permite o envio de um código do Concurso, as informações do Lead, da inscrição, categoria e oferta!

Parâmetros de entrada

Concurso: Parâmetro sempre obrigatório!

Só pode conter o atributo \"cad_codigo\" indicando a qual concurso a Inscrição será vinculada

Se o Concurso não existir, o Lead e a Inscrição não serão criados

Se a Inscrição informada no payload já existir no CRM, o Concurso será ignorado na atualização dessa Inscrição

Lead: Ao menos um dos atributos \"cad_cpf\" ou \"emailaddress1\" é necessário. A API vai tentar encontrar o Lead por uma dessas duas chaves, ele será atualizado e vinculado à Inscrição. Caso não exista um Lead com esse CPF ou E-mail, a API tenta criar um Lead novo, mas nesse caso, será necessário informar também, ao menos os atributos \"firstname\" e \"lastname\"Qualquer atributo a mais enviado também será salvo no CRM, para isso, o nome do atributo deve ser exatamente igual ao nome do campo no Dynamics

Categoria: Ao menos o atributo \"cad_identificadorcategoria\" é necessário. A API vai tentar encontrar a categoria pelo identificador e utiliza-la para a criação da Oferta. Caso não exista, uma nova categoria será criada, mas para isso será necessário informar também, ao menos o campo \"cad_name\"

Qualquer atributo a mais enviado também será salvo no CRM, para isso, o nome do atributo deve ser exatamente igual ao nome do campo no Dynamics

Se já existir a categoria, a mesma não será atualizada

Se a Oferta informada no payload já existir no CRM, a Categoria será ignorada

Oferta: Ao menos o atributo \"cad_identificadoroferta\" é necessário. A API vai tentar encontrar a oferta pelo identificador e vincular à Inscrição. Caso não exista, uma nova oferta será criada, mas para isso será necessário informar também, ao menos o campo \"cad_nome\"

Qualquer atributo a mais enviado também será salvo no CRM, para isso, o nome do atributo deve ser exatamente igual ao nome do campo no Dynamics

Se já existir a oferta, a mesma **não será atualizada

Inscrição:** A API vai verificar se já existe uma inscrição pelo atributo \"cad_identificadorinscricao\" se ele for informado ou para o Lead e Concursos informados caso no payload não tenha o atributo \"cad_identificadorinscricao\", caso a inscrição exista, ela será atualizada e caso contrário uma nova inscrição será criada e vinculada ao Lead, Concurso e Oferta informados

Qualquer atributo a mais enviado também será salvo no CRM, para isso, o nome do atributo deve ser exatamente igual ao nome do campo no Dynamics

Options: É possível também enviar um parâmetro Options para informar que deseja enviar somente o Lead.

\"options\": {
\"somente_lead\": true
}

Regras de Duplicidade:

Lead:

Se um dos dados (CPF, Email e Telefone) for encontrado em apenas um Lead, os dados enviados serão atualizados no Lead encontrado;
\n
Se os dados (CPF, Email e Telefone) forem encontrados em leads diferentes, é retornado que foram encontrados leads diferentes com os dados enviados;
\n
Se nenhum dos dados (CPF, Email e Telefone) for encontrado, um novo lead será criado.
\n

Inscrição:

Se uma inscrição com o mesmo lead, concurso e oferta for encontrada, com status diferente de Matriculado ou Desistente, a inscrição encontrada será atualizada;
\n
Se no payload da inscrição for enviado o campo de Consultor (afiliado), consultamos o campo Prioridade da classe do consultor.
\n
- Se a prioridade da classe enviada for menor do que a prioridade da classe atualmente cadastrada na inscrição, não alteramos o consultor (afiliado)
  \n
- Se a prioridade da classe enviada for maior ou igual do que a prioridade da classe atualmente cadastrada na inscrição, alteramos o consultor (afiliado) para o novo consultor (afiliado) enviado
  \n
\n
Se nenhuma inscrição com o mesmo lead, concurso e oferta com status diferente de Matriculado for encontrada, criamos uma nova inscrição
\n

Observação

Se o Lead possuir CPF e possuir uma inscrição com status de Matriculado, não é atualizado e nem criado um novo lead.

Formato da Requisição

HTTP Method: POST
Content-Type: application/json

Estrutura do corpo:

O corpo da requisição deve um objeto JSON que contenha as seguintes chaves:

concurso: .
\n
- attributes: Contains contest-specific attributes.
  \n
  - cad_codigo: (int) Código do Concurso
  \n
\n
lead: .
\n
- attributes: Atributos do lead.
  \n
  - cad_cpf: (string) CPF do lead
    \n
  - emailaddress1: (string) E-mail do Lead
    \n
  - firstname: (string) Primeiro nome do lead.
    \n
  - lastname: (string) Último nome do Lead.
    \n
  - mobilephone: (string) Número de Celular do Lead
    \n
  - ...
    \n
  \n
\n
inscricao:
\n
- attributes: Atributos da inscrição
  \n
  - cad_situacao: (integer) Situação da inscrição
    \n
  - cad_codigoconsultor: (string) Código do consultor
    \n
  - ...
    \n
  \n
\n
categoria:
\n
- attributes: Atributos da Categoria.
  \n
  - cad_identificadorcategoria: (string) Identificador da Categoria
    \n
  - cad_name: (string) Nome da Categoria.
    \n
  - cad_exibenaoferta: (boolean) Campo Exibe na Oferta.
    \n
  - ...
    \n
  \n
\n
oferta:.
\n
- attributes: Atributos da Oferta
  \n
  - cad_identificadoroferta: (string) Identificador da Oferta.
    \n
  - cad_nome: (string) Nome da Oferta.
    \n
  - cad_quantidadevagas: (integer) Campo Quantidade de vagas.
    \n
  - ...
    \n
  \n
\n

Códigos de retorno

202 - Accepted

Requisição aceita e será processada de forma assíncrona

400 – Bad Request

Dados enviados de forma incorreta ou fora do padrão

500 – Internal Server Error

Erro interno, verificar mensagens de erro no corpo da resposta

Notificação ao fim do processamento assíncrono

Configuração CRM Educacional:

Na entidade CRM Educacional, será configurado os campos \"URL POST Cadastro Inscrição (obrigatório)\", \"Usuário Cadastro Inscrição (opcional)\" e \"Senha Cadastro Inscrição (opcional)\"

Ao final do processamento assíncrono, o sistema irá enviar uma requisição POST com o resultado do processamento

JSON no corpo da requisição:

Sucesso: { \"TrackId\": \"7215609d-945c-4f93-ac25-083ea96a0e8a\", \"Status\": 200, \"NumeroInscricao\": \"CAN-123456-CRM\", \"Erros\": [] }

Falha: { \"TrackId\": \"7215609d-945c-4f93-ac25-083ea96a0e8a\", \"Status\": 400, \"Erros\": [ \"Mensagem de erro.\" ] }

Autorização:

Se os campos \"Usuário Cadastro Inscrição\" e \"Senha Cadastro Inscrição\" forem configurados. O sistema irá enviar o parâmetro a \"Authorization\" no header da requisição no formato:

string.Format(\"Basic {0}\", Convert.ToBase64String(Encoding.UTF8.GetBytes(string.Format(\"{0}:{1}\", usuario, senha))));

\n","urlObject":{"protocol":"https","path":["api","IntegracaoGenericaClientes","CadastroInscricao"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3dcf53ba-625c-4886-9c82-4f507631ad40"}],"id":"462a5b25-2b50-4e38-907a-9e8da9a6436c","_postman_id":"462a5b25-2b50-4e38-907a-9e8da9a6436c","description":""}],"id":"8f7b3dc8-ae1d-4952-8956-a6cea7c9d8db","_postman_id":"8f7b3dc8-ae1d-4952-8956-a6cea7c9d8db","description":""},{"name":"Avaliações - Notas - Classificações","item":[{"name":"Atualizar Avaliação Do Candidato No CRM","id":"230bdd0f-9df3-40ed-9e6a-e3d166e5d24a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer IJjrtChsl8pPMeD8aFxleRojnBjwA7HGD2_tWSgdzduieIYy_zO605IFxheaoul4vagW6jJHqpVqmocey95B1lG8mqnFm6WBa5OyxW9GWnGQasYaNxHTIzjYJ2dIz-QWJ7a_7uIq2dbzoIzWpUDM7zshqHBRyEL6XQmcKr3H0d80HPf5uV4SAg5pAbNOyODsy6RcBm33U6rXbcoJNhP7DRRJLrJEsa8yO--eijr_MbTmye8HjEEaLgc8lPBoZscO","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"IdentificadorFator\": \"@REDENEM\",\n\t\"ListaInscricoes\": [\"CAN-000000-CRM@100@Avaliado\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://XXXapi.crmeducacional.com/api/AtualizarAvaliacaoCandidatoCRM","description":"

Objetivo

Este método atualiza os campos “valor” e “valor por extenso” da avaliação cujo identificador do fator de avaliação seja o recebido como parâmetro e o tipo seja “Informado”.

O método irá percorrer a “lista de inscrições” recebida como parâmetro atualizando a avaliação correspondente de cada uma com os valores também passados no parâmetro “lista de inscrições”.

Será registrado um log para o processamento de cada inscrição passada na “lista de inscrições”, este log pode ser acessado através do menu “Logs do Sistema”.

\n","urlObject":{"protocol":"https","path":["api","AtualizarAvaliacaoCandidatoCRM"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"230bdd0f-9df3-40ed-9e6a-e3d166e5d24a"},{"name":"Atualizar Nota Do Candidato No CRM","id":"e31a056e-a05d-40b9-8749-2f753cb9b61f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer IJjrtChsl8pPMeD8aFxleRojnBjwA7HGD2_tWSgdzduieIYy_zO605IFxheaoul4vagW6jJHqpVqmocey95B1lG8mqnFm6WBa5OyxW9GWnGQasYaNxHTIzjYJ2dIz-QWJ7a_7uIq2dbzoIzWpUDM7zshqHBRyEL6XQmcKr3H0d80HPf5uV4SAg5pAbNOyODsy6RcBm33U6rXbcoJNhP7DRRJLrJEsa8yO--eijr_MbTmye8HjEEaLgc8lPBoZscO","type":"text"}],"body":{"mode":"raw","raw":"{\n\t \"ControleApuracao\": \"Nota\",\n \"LoteApuracao\": \"Segundo\",\n \"NumeroInscricao\": \"CAN-00000-CRM\",\n \"ApuracaoParcial\": \"9\",\n \"Pontuacao\": 100\n}","options":{"raw":{"language":"json"}}},"url":"https://XXXapi.crmeducacional.com/api/AtualizaNotaCandidatoCRM","description":"

Objetivo

Este método tem como objetivo enviar a pontuação atualizada do candidato para o CRM.

O método retorna um boolean (TRUE) ou (FALSE). \nRetorna um boolean TRUE quando a pontuação é atualizada com sucesso ou FALSE quando ocorre algum erro na atualização da pontuação.

Parâmetros de Entrada

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Parâmetro	Tipo	Obrigatório
ControleApuracao	STRING	SIM
LoteApuracao	STRING	SIM
NumeroInscricao	STRING	SIM
ApuracaoParcial	STRING	SIM
Pontuacao	DECIMAL	SIM
Token	STRING	SIM

\n\n\n

Mensagem de Retorno

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Situação	Retorno	Tipo
Sucesso	TRUE	BOOLEAN
Falha	FALSE	BOOLEAN

","urlObject":{"protocol":"https","path":["api","AtualizaNotaCandidatoCRM"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e31a056e-a05d-40b9-8749-2f753cb9b61f"},{"name":"Enviar Classificação","id":"8d1fbb5d-095a-44b3-bb6e-579bae9105a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"CodigoConcurso\": 3011,\n \"NomeChamada\": \"Chamada Teste\",\n \"Classificacao\": [{\n \"Situacao\": 2,\n \"Posicao\":3,\n \"PontuacaoFinal\":700,\n \"NumeroInscricao\":\"CAN-004703-CRM\",\n \"ClassificacaoChamada\" : 5,\n \"ClassificacaoOferta\" : 9\n }]\n}","options":{"raw":{"language":"json"}}},"url":"https://XXXapi.crmeducacional.com/api/EnviarClassificacao","description":"

Objetivo

Este método cria um registro na entidade classificação do candidato para cada classificação enviada.

Recebe como parâmetro o código do concurso, o nome da chamada e um contrato de dados chamado CLASSIFICACAO, este objeto é um agrupador e tem 6 propriedades, que são: Situacao, Posicao, PontuacaoFinal, NumeroInscricao e os campos da Inscrição do Candidato: ClassificacaoChamada e ClassificacaoOferta.

A propriedade Situação é um enumerator do tipo SituacaoInscricaoChamada.

Se o concurso ou a chamada não existirem o método retorna falso.

Se uma das classificações não possuírem posição ou pontuação final ou se a situação for diferente das especificadas abaixo essa classificação não é gerada, as demais não são impactadas.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Possíveis valores	Descrição	Tipo	Obrigatório
Código do Concurso			INT	SIM
Nome da Chamada			STRING	SIM
Classificações			ARRAY CLASSIFICACAO	SIM
Situação	1 2 3 4	Aprovado Classificado Desclassificado Ausente	ENUMERATOR	SIM
Posição			INT	SIM
Pontuação Final			DECIMAL	SIM
Número de Inscrição			STRING	SIM
Token			STRING	SIM
ClassificacaoChamada			INT	NÃO
ClassificacaoOferta			INT	NÃO

Mensagem de Retorno

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Situação	Retorno	Tipo
Sucesso	TRUE	BOOLEAN
Falha	FALSE	BOOLEAN

","urlObject":{"protocol":"https","path":["api","EnviarClassificacao"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8d1fbb5d-095a-44b3-bb6e-579bae9105a6"}],"id":"a75704ec-231f-4ef9-a6a8-fdf07e95b111","_postman_id":"a75704ec-231f-4ef9-a6a8-fdf07e95b111","description":""},{"name":"Boleto Matrícula","item":[{"name":"Atualizar Inscrição Registrar Boleto Matrícula","id":"1bedd2e3-7f46-47fa-994d-c1dfa36da816","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"access_token","type":"text","value":""},{"key":"token_type","type":"text","value":""},{"key":"Authorization","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"NumeroInscricao\":\"CAN-000000-CRM\",\r\n\t\"DataVencimentoBoletoMatricula\":\"11/03/2025\",\r\n \"SituacaoPagamentoBoletoMatricula\":\"6\",\r\n \"DataPagamentoBoletoMatricula\":\"11/03/2020\",\r\n \"URLBoletoMatricula\":\"www.crmeducacional.com\",\r\n \"ValorBoletoMatricula\":\"700,00\",\r\n \"LinhaDigitavelBoletoMatricula\": \"123456\"\r\n}\r\n"},"url":"https://XXXapi.crmeducacional.com/api/IntegracaoClientes/AtualizarInscricaoRegistrarBoletoMatricula","description":"

Objetivo

Como descrito na introdução desta seção, este método realiza modificações nos campos Data Vencimento Boleto Matrícula, Situação do Pagamento Boleto Matrícula, Data do Pagamento Boleto Matrícula, URL Boleto Matrícula, Valor Boleto Matrícula e Linha Digitável Boleto Matricula, todos relacionados as informações do boleto matrícula dispostas no registro de Inscrição associada.

\n\n

Um ponto importante deste método é que quando utilizado ocorre a integração de todos os parâmetros e isso é aplicado em dois cenários possíveis: criação e atualização. Para atualização de informações não é recomendado caso exista a necessidade de atualizar dentre as opções disponíveis os campos de forma individual. Caso deseje realizar este processo, é recomendado a utilização do método Atualizar Inscricao Sessão Boleto Matrícula.

Obs.: A inscrição do candidato poderá ser identificada utilizando somente um dos campos:
NumeroInscricao ou IDInscricao, ou seja, pelo menos um deverá ser informado na requisição.

\n\n

Os valores informados deverão obedecer o padrão monetário brasileiro. Onde se utiliza a vírgula para separação decimal e o ponto para as centenas.

\n\n

Ex.: 100,00 (Cem reais) ou 10.000,26 (Dez mil reais e vinte e seis centavos)

\n\n

Nome Lógico	Nome do Campo Correspondente no CRM	Possíveis valores	Descrição	Tipo	Obrigatório
`NumeroInscricao`	Número da Inscrição			STRING	SIM\\\\\\\\*
`IDInscricao`	Id do Número da Inscrição			STRING	SIM\\\\\\\\*
`DataVencimentoBoletoMatricula`	Data Vencimento Boleto Matrícula			DATETIME	SIM
`SituacaoPagamentoBoletoMatricula`	Situação do Pagamento Boleto Matrícula	1 2 3 4 5 6 7 8 9 10	Ativo Inativo Reprovado Cancelado Em Aberto Aguardando Em Análise Aprovado Pago Isento	ENUMERATOR	SIM
`DataPagamentoBoletoMatricula`	Data do Pagamento Boleto Matrícula			DATETIME	NÃO
`URLBoletoMatricula`	URL Boleto Matrícula			STRING	NÃO
`ValorBoletoMatricula`	Valor Boleto Matrícula			DECIMAL	SIM
`LinhaDigitavelBoletoMatricula`	Linha Digitavel Boleto Matricula			STRING	SIM
`Token`				String	SIM

\n\n

Possíveis retornos

Código	Descrição
`200`	Inscrição: {NumeroInscricao} foi atualizada com sucesso.
`400`	Número da Inscrição ou ID da Inscrição deverá ser informado.
`400`	A Inscrição do Candidato (Número da Inscrição: {NumeroInscricao}) não foi localizada pelo Número da Inscrição informado.
`400`	A Inscrição do Candidato (ID da Inscrição: {IDInscricao})não foi localizada pelo Número da Inscrição informado.
`400`	Data Vencimento do Boleto de Matrícula deverá ser informado.
`400`	Situação do Boleto de Matrícula deverá ser informado.
`400`	Valor do Boleto de Matrícula deverá ser informado.
`400`	O Boleto de Matrícula ainda não foi registrado na Inscrição: {insc.NumeroInscricao}, gentileza utilizar o método 'AtualizarInscricaoRegistrarBoletoMatricula'.
`400`	Inscrição: {insc.NumeroInscricao} não pode ser atualizada. Consultar Log's Genéricos do CRM.
`401`	Authorization has been denied for this request.
`500`	Erro ao atualizar a inscrição, verifique se os valores dos campos enviados estão de acordo com a documentação.

","urlObject":{"protocol":"https","path":["api","IntegracaoClientes","AtualizarInscricaoRegistrarBoletoMatricula"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1bedd2e3-7f46-47fa-994d-c1dfa36da816"},{"name":"Atualizar Inscrição Sessão Boleto Matricula","id":"d76447c0-ffc9-420a-9cf0-7e4189988709","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"access_token","type":"text","value":""},{"key":"token_type","type":"text","value":""},{"key":"Authorization","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"NumeroInscricao\":\"CAN-000000-CRM\", \r\n\t\"DataVencimentoBoletoMatricula\":\"01/01/2025\",\r\n\t\"SituacaoPagamentoBoletoMatricula\":\"1\",\r\n\t\"DataPagamentoBoletoMatricula\":\"02/02/2020\",\r\n\t\"URLBoletoMatricula\":\"www.crmeducacional.com\",\r\n\t\"ValorBoletoMatricula\":\"1.250,00\",\r\n\t\"LinhaDigitavelBoletoMatricula\":\"123456780009\"\r\n}"},"url":"https://XXXapi.crmeducacional.com/api/IntegracaoClientes/AtualizarInscricaoSessaoBoletoMatricula","description":"

Objetivo

Este método é uma variação do Atualizar Inscrição Registrar Boleto Matricula, ele também realiza modificações nos campos Data Vencimento Boleto Matrícula, Situação do Pagamento Boleto Matrícula, Data do Pagamento Boleto Matrícula, URL Boleto Matrícula, Valor Boleto Matrícula e Linha Digitável Boleto Matricula, todos relacionados as informações do boleto matrícula dispostas no registro de Inscrição associada.

\n\n

Um ponto importante deste método é que quando utilizado ocorre a integração somente do(s) parâmetro(s) que for(em) preenchido(s) na requisição.

\n\n

Obs.: A inscrição do candidato poderá ser identificada utilizando somente um dos campos:
NumeroInscricao ou IDInscricao, ou seja, pelo menos um deverá ser informado na requisição.

\n\n

StartFragment

Os valores informados deverão obedecer o padrão monetário brasileiro. Onde se utiliza a vírgula para separação decimal e o ponto para as centenas.

Ex.: 100,00 (Cem reais ou 10.000,26 (Dez mil reais e vinte e seis centavos)

EndFragment

Parâmetros de Entrada

Nome Lógico	Nome do Campo Correspondente no CRM	Possíveis valores	Descrição	Tipo	Obrigatório
`NumeroInscricao`	Número da Inscrição			STRING	SIM\\\\*
`IDInscricao`	Id do Número da Inscrição			STRING	SIM\\\\*
`DataVencimentoBoletoMatricula`	Data Vencimento Boleto Matrícula			DATETIME	SIM
`SituacaoPagamentoBoletoMatricula`	Situação do Pagamento Boleto Matrícula	1 2 3 4 5 6 7 8 9 10	Ativo Inativo Reprovado Cancelado Em Aberto Aguardando Em Análise Aprovado Pago Isento	ENUMERATOR	SIM
`DataPagamentoBoletoMatricula`	Data do Pagamento Boleto Matrícula			DATETIME	NÃO
`URLBoletoMatricula`	URL Boleto Matrícula			STRING	NÃO
`ValorBoletoMatricula`	Valor Boleto Matrícula			DECIMAL	SIM
`LinhaDigitavelBoletoMatricula`	`Linha Digitavel Boleto Matricula`			STRING	SIM
`Token`				String	SIM

\n\n

Possíveis retornos

Código	Descrição
`200`	Inscrição: {NumeroInscricao} foi atualizada com sucesso.
`400`	Número da Inscrição ou ID da Inscrição deverá ser informado.
`400`	A Inscrição do Candidato (Número da Inscrição: {NumeroInscricao}) não foi localizada pelo Número da Inscrição informado.
`400`	A Inscrição do Candidato (ID da Inscrição: {IDInscricao})não foi localizada pelo Número da Inscrição informado.
`400`	Data Vencimento do Boleto de Matrícula deverá ser informado.
`400`	Situação do Boleto de Matrícula deverá ser informado.
`400`	Valor do Boleto de Matrícula deverá ser informado.
`400`	O Boleto de Matrícula ainda não foi registrado na Inscrição: {insc.NumeroInscricao}, gentileza utilizar o método 'AtualizarInscricaoRegistrarBoletoMatricula'.
`400`	Inscrição: {insc.NumeroInscricao} não pode ser atualizada. Consultar Log's Genéricos do CRM.
`401`	Authorization has been denied for this request.
`500`	Erro ao atualizar a inscrição, verifique se os valores dos campos enviados estão de acordo com a documentação.

","urlObject":{"protocol":"https","path":["api","IntegracaoClientes","AtualizarInscricaoSessaoBoletoMatricula"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d76447c0-ffc9-420a-9cf0-7e4189988709"}],"id":"b71b8c0f-f7d4-429c-bdba-7c0a4d9398b5","description":"

Esta seção contém os métodos AtualizarInscricaoegistrarBoletoMatricula e AtualizarInscricaoSessaoBoletoMatricula que realizam modificações relacionadas ao boleto de matrícula nos registros da inscrição do candidato .

É indicado para quando a Instituição gerencia o recebimento de pagamentos da taxa de matrícula em sistemas externos e deseja enviar posteriormente tais dados para a CRM, possibilitando assim a unificação das informações.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"51ed0004-ae6d-49e5-85f9-0f26d1597218"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"cc858638-458a-4e5d-8162-fe65dcb49d5d"}}],"_postman_id":"b71b8c0f-f7d4-429c-bdba-7c0a4d9398b5"},{"name":"Calendário de Provas","item":[{"name":"Criar Calendário de Prova","id":"a2c03cdd-acac-4706-8b13-13cce42d2eeb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"bearer YeeP3qHsbL57J53d1hSbKo9-YcNJFps8YH72WzGrj77nxeOxx09wWEzLzEKXPg2Uiaevlj6ZvhxHO9N-QD8RBeZ5X3lOZpNyRpaKIWQAC1w1mQWAh-X5eZcjPr3bc0ZXIEwhg9g-G6QhmxKHYaolISz7oPKdK2nYQSavoqULzGDuxasjzufX9aL1SXwlRPTuMDMgoiTtEcAN7dXrWVb6KqPyi3wWCPC7_XJ9-ZwCLJmzi9TciXS7wKfgyT21uDm4","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n\r\n \"Codigo\": \"CP001\",\r\n \"Nome\": \"NOME CALENDÁRIO DE PROVA XYZ\",\r\n \"Data\": \"01/03/2019\",\r\n \"Hora\": \"14\",\r\n \"Minutos\": \"30\",\r\n \"VagaDisponivel\": \"true\",\r\n \"ConcursoCodigo\": \"3011\",\r\n \"CategoriaNome\": \"Categoria não Repetida\",\r\n \"IdentificadorCategoria\": \"abc123\",\r\n \"SalaNome\": \"Especial Concurso\",\r\n \"PrecoNome\": \"Concurso Agendado\",\r\n \"DataInicio\": \"01/02/2019 00:00\",\r\n \"DataFim\": \"28/02/2019 23:45\"\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"https://XXXapi.crmeducacional.com/api/CriarCalendarioProva","description":"

Objetivo

Permitir a criação de um Calendário de Provas no CRM, já o vinculando a um Concurso, Categoria e se aplicável, a uma Sala e Preço.

\n\n

Observações:

1 - O nome dos campos à esquerda: (chaves/parâmetro) deve ser igual aos nomes citados na tabela abaixo;

2 - O nome dos campos à esquerda: (chaves/parâmetro) personalizados deve ser igual ao nome do campo no CRM;

3 - Para os parâmetros referentes às entidades Concurso, Categoria, Sala e Preço o método irá realizar uma consulta de acordo com as informações passadas para relacioná-los com o registro de Data de Calendário a ser inserido. Desta forma, esta consulta poderá retornar mais de um registro. Para estes casos, será considerado o primeiro item da lista retornada.

\n\n

Exemplo de Informação a ser enviada

Chave do Campo	Exemplo	Tipo	Possíveis valores	Obrigatório	Descrição
Codigo	CP001	String		Sim	Código do calendário de prova que está sendo incluído. O código não pode ser vazio.
Nome	NOME CALENDÁRIO DE PROVA XYZ	String		Sim	Nome do calendário de prova que está sendo incluído. O nome não pode ser vazio.
Data	01/02/2019	DateTime		Sim	Data de Prova do Calendário. O valor não pode ser nulo.
Hora	14	Enum Hora	0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23	Sim	Horário de Prova do Calendário. O campo é um Enumerador Hora e não pode ser vazio.
Minutos	30	Enum Hora	0 10 15 20 30 40 50	Sim	Minutos do horário de prova do calendário. O campo é um Enumerador MinutosCalendario e não pode ser vazio.
VagaDisponivel	true	Boolean?	true false	Sim	Boolean contendo informação se há ou não vagas disponíveis. O campo não pode ser nulo.
ConcursoCodigo	2407	String		Sim	Código do concurso a ser vinculado no calendário de prova. O valor não pode ser vazio.
CategoriaNome	Categoria não Repetida	String		Obrigatório caso o parâmetro IdentificadorCategoria não seja informado	Nome da categoria a ser vinculada no calendário de prova. O valor é obrigatório caso o parâmetro IdentificadorCategoria não seja informado e opcional caso o Identificador seja preenchido.
IdentificadorCategoria	abc123	String		Obrigatório caso o parâmetro CategoriaNome não seja informado	Identificador da categoria a ser vinculada no calendário de prova. O valor é obrigatório caso o NomeCategoria não seja informado e opcional caso o Nome seja preenchido.
SalaNome	Especial Concurso	String		Não	Nome da sala a ser vinculada no calendário de prova. O campo é opcional.
PrecoNome	Concurso Agendado	String		Não	Nome do preço a ser vinculado no calendário de prova. O campo é opcional.
DataInicio	01/02/2019 00:00	DateTime?		Sim, caso o parâmetro DataFim seja informado.	Data e Hora de início da exibição do calendário de prova. Caso a hora não seja informada, será preenchida a default '00:00'. O valor é obrigatório caso o parâmetro DataFim seja preenchido. Para este caso, valor da DataInicio deverá ser inferior ou igual ao campo DataFim.
DataFim	28/02/2019 23:00	DateTime?		Não	Data e Hora de início da exibição do calendário de prova. Caso a hora não seja informada, será preenchida a default '00:00'. O valor deste campo deverá ser superior ao valor do parâmetro DataInicio e inferior ou igual ao valor do campo Data.

\n\n

*Possíveis retornos:__*

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Retorno	Descrição	Tipo
0	Calendário criado com sucesso	INT
1	Código de identificação do calendário não informado	INT
2	Nome do calendário não informado	INT
3	Opção de vagas disponíveis não informada	INT
4	Data do calendário não informada	INT
6	Categoria não informada	INT
7	Concurso não encontrado	INT
8	Sala não encontrada	INT
9	Preço não encontrado	INT
10	Erro no Insert	INT
11	Erro na conversão de dados	INT
12	Erro genérico	INT

Código	Descrição
200	\"{\\\"Status\\\":\\\"Sucesso\\\",\\\"Mensagem\\\":\\\"Calendário de Prova criado com sucesso.\\\"}\".
500	{\"Status\":\"Falha\",\"Mensagem\":\"Erro inesperado ao salvar dados: XXXX.\"}

","urlObject":{"protocol":"https","path":["api","CriarCalendarioProva"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a2c03cdd-acac-4706-8b13-13cce42d2eeb"},{"name":"Atualizar Calendário de Prova","id":"52804a4a-8b69-4edc-b57d-bdec9664d20f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"access_token","value":"","type":"text"},{"key":"token_type","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n \"Codigo\": \"CP001\",\r\n \"Nome\": \"NOME CALENDÁRIO DE PROVA XYZ\",\r\n \"Data\": \"01/03/2019\",\r\n \"Hora\": \"14\",\r\n \"Minutos\": \"30\",\r\n \"VagaDisponivel\": \"true\",\r\n \"ConcursoCodigo\": \"2407\",\r\n \"CategoriaNome\": \"Categoria não Repetida\",\r\n \"IdentificadorCategoria\": \"abc123\",\r\n \"SalaNome\": \"Especial Concurso\",\r\n \"PrecoNome\": \"Concurso Agendado\",\r\n \"DataInicio\": \"01/02/2019 00:00\",\r\n \"DataFim\": \"28/02/2019 23:45\"\r\n}"},"url":"https://XXXapi.crmeducacional.com/api/IntegracaoClientes/AtualizarCalendarioProva","description":"

Objetivo

Permitir a alteração dos dados de um Calendário de Provas no CRM.

\n\n

Observações:

1 - Para alteração do Calendário deverá ser passado o Nome ou Código válido. Caso seja passado os dois campos na requisição, será realizada uma consulta com ambos e caso não encontre, será realizada a tentativa de encontrar o registro por um dos dois campos (Nome ou Código);

2 - O nome dos campos à esquerda: (chaves/parâmetro) deve ser igual aos nomes citados na tabela abaixo;

3 - Além dos campos obrigatórios conforme tabela de exemplo abaixo, podem ser atualizados tanto outros campos do produto quanto demais campos criados pelo cliente. Neste caso deverá ser adicionado o nome lógico do campo cadastrado no CRM. (Veja Exemplo)

4 - Para os parâmetros referentes às entidades Concurso, Categoria, Sala e Preço o método irá realizar uma consulta de acordo com as informações passadas para relacioná-los com o registro de Data de Calendário a ser inserido. Desta forma, esta consulta poderá retornar mais de um registro. Para estes casos, será considerado o primeiro item da lista retornada.

7 - Na atualização, caso algum campo já preenchido não seja informado, o mesmo permanecerá com o valor cadastrado na inclusão. Para exclusão do valor, o usuário deverá remover diretamente no CRM: Captação - Calendário de Prova.

\n\n

Exemplo de Informação a ser enviada

Chave do Campo	Exemplo	Tipo	Possíveis valores	Obrigatório	Descrição
Codigo	CP001	String		Não	Código do calendário de prova que está sendo alterado. Campo obrigatório apenas se o parâmetro Nome não for informado ou se o Código for atualizado. Para este caso, o nome deverá ser informado corretamente.
Nome	NOME CALENDÁRIO DE PROVA XYZ	String		Não	Nome do calendário de prova que está sendo alterado. Campo obrigatório apenas se o parâmetro Código não for informado ou se o Nome for atualizado. Para este caso, o código deverá ser informado corretamente.
Data	01/02/2019	DateTime		Não	Data de Prova do Calendário. O campo é opcional.
Hora	14	Enum Hora	0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23	Não	Horário de Prova do Calendário. O campo é um Enumerador Hora.
Minutos	30	Enum MinutosCalendario	0 10 15 20 30 40 50	Não	Minutos do horário de prova do calendário. O campo é um Enumerador MinutosCalendario. O campo é opcional.
VagaDisponivel	true	Boolean?	true false	Não	Boolean contendo informação se há ou não vagas disponíveis. O campo é opcional.
ConcursoCodigo	2407	String		Não	Código do concurso a ser vinculado no calendário de prova. O campo é opcional.
CategoriaNome	Categoria não Repetida	String		Não	Nome da categoria a ser vinculada no calendário de prova. O campo é opcional.
IdentificadorCategoria	abc123	String		Não	Nome da categoria a ser vinculada no calendário de prova. O campo é opcional.
SalaNome	Especial Concurso	String		Não	Nome da sala a ser vinculada no calendário de prova. O campo é opcional.
PrecoNome	Concurso Agendado	String		Não	Nome do preço a ser vinculado no calendário de prova. O campo é opcional.
DataInicio	2019-02-01 00:00	DateTime?		Sim, caso o parâmetro DataFim seja informado.	Data e Hora de início da exibição do calendário de prova. Caso a hora não seja informada, será preenchida a default '00:00'. O campo é opcional.
DataFim	2019-02-28 23:00	DateTime?		Não	Data e Hora de início da exibição do calendário de prova. Caso a hora não seja informada, será preenchida a default '00:00'. O campo é opcional.

","urlObject":{"protocol":"https","path":["api","IntegracaoClientes","AtualizarCalendarioProva"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[{"id":"09441120-a0d9-412e-97e1-e7cd3fd30d85","name":"Atualizar Calendário de Prova","originalRequest":{"method":"POST","header":[{"key":"access_token","value":""},{"key":"token_type","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \r\n \"Codigo\": \"CP001\",\r\n \"Nome\": \"NOME CALENDÁRIO DE PROVA XYZ\",\r\n \"Data\": \"01/03/2019\",\r\n \"Hora\": \"14\",\r\n \"Minutos\": \"30\",\r\n \"VagaDisponivel\": \"true\",\r\n \"ConcursoCodigo\": \"2407\",\r\n \"CategoriaNome\": \"Categoria não Repetida\",\r\n \"IdentificadorCategoria\": \"abc123\",\r\n \"SalaNome\": \"Especial Concurso\",\r\n \"PrecoNome\": \"Concurso Agendado\",\r\n \"DataInicio\": \"01/02/2019 00:00\",\r\n \"DataFim\": \"28/02/2019 23:45\",\r\n \"cad_campotestecalendarioapi\": \"teste\" //Campo personalizado //poderá ser removido\r\n}","options":{"raw":{"language":"json"}}},"url":"https://XXXapi.crmeducacional.com/api/IntegracaoClientes/AtualizarCalendarioProva"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"52804a4a-8b69-4edc-b57d-bdec9664d20f"}],"id":"a32bd686-3bfa-449e-90da-143eec2016cd","_postman_id":"a32bd686-3bfa-449e-90da-143eec2016cd","description":""},{"name":"Categoria da Oferta","item":[{"name":"Enviar Categoria","id":"55a5f071-177e-4bf8-8834-0edbff596a7d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"access_token","value":"","type":"text"},{"key":"token_type","value":"","type":"text"}],"body":{"mode":"raw","raw":" {\r\n \"IdentificadorCategoria\": \"\",\r\n \"Nome\":\"Nome da categoria\",\r\n \"ExibeNaOferta\":true,\r\n \"ExibeNoCalendario\":true,\r\n \"TipoCategoria\":0,\r\n \"UnidadeCertificadoraNome\":\"Nome da Unidade Certificadora\",\r\n \"IdentificadorPolo\": \"\",\r\n \"IdentificadorUnidadeCertificadora\": \"\"\r\n}"},"url":"https://XXXapi.crmeducacional.com/api/IntegracaoClientes/EnviarCategoria","description":"

Objetivo

Este método recebe uma Categoria no formato JSON para ser criada e/ou atualizada (caso já exista) no CRM

\n\n

Observações:

\n\n

Para que ocorra o correto funcionamento e vinculação, o registro da entidade conta ( unidade certificadora) deverá ter como configuração no campo \"tipo de relação\" o valor de \"unidade certificadora\".

\n\n

Já para o polo a conta deverá possuir o campo tipo de relação como Polo juntamente com o

\n\n

campo Identificador da conta preenchido.

\n\n

-Quando o IdentificadorCategoria é informado, a categoria é localizada por ele ao invés do Nome

\n\n

Parâmetros de Entrada

Campo	Possíveis valores	Descrição	Tipo	Obrigatório
IdentificadorCategoria		Quando informado, utilizado para localizar a categoria	STRING	NÃO
Nome		Utilizado para localizar a categoria quando o campo IdentificadorCategoria não é informado	STRING	SIM
ExibeNaOferta			BOOL	SIM
ExibeNoCalendario			BOOL	NÃO
TipoCategoria	0 1	Proprio Terceirizado	ENUMERATOR	NÃO
UnidadeCertificadoraNome		Utilizado para localizar a Unidade Certificadora quando o campo IdentificadorUnidadeCertificadora não é informado.	STRING	NÃO
IdentificadorPolo		Utilizado para localizar uma conta do tipo Polo	STRING	NÃO
IdentificadorUnidadeCertificadora		Utilizado para localizar uma conta do tipo Unidade Certificadora	STRING	NÃO

\n\n

Possíveis Retornos

Código	Status	Mensagem
200	Sucesso	Categoria criada com sucesso
200	Sucesso	Categoria atualizada com sucesso
500	Falha	Motivo da falha

","urlObject":{"protocol":"https","path":["api","IntegracaoClientes","EnviarCategoria"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"55a5f071-177e-4bf8-8834-0edbff596a7d"}],"id":"80f170dd-0350-4337-8fa1-13f8a08d614d","_postman_id":"80f170dd-0350-4337-8fa1-13f8a08d614d","description":""},{"name":"Concurso","item":[{"name":"Atualizar Vigência Do Concurso","id":"8e351c81-9715-4dcc-a611-b9f8b79815d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer IJjrtChsl8pPMeD8aFxleRojnBjwA7HGD2_tWSgdzduieIYy_zO605IFxheaoul4vagW6jJHqpVqmocey95B1lG8mqnFm6WBa5OyxW9GWnGQasYaNxHTIzjYJ2dIz-QWJ7a_7uIq2dbzoIzWpUDM7zshqHBRyEL6XQmcKr3H0d80HPf5uV4SAg5pAbNOyODsy6RcBm33U6rXbcoJNhP7DRRJLrJEsa8yO--eijr_MbTmye8HjEEaLgc8lPBoZscO","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"CodigoConcurso\": 6,\n \"DataInicial\": \"01/01/2021\",\n \"DataFinal\": \"02/04/2025\",\n \"DataProva\": \"02/03/2023\",\n \"HoraProva\": \"12\",\n \"MinutoProva\": \"00\"\n}","options":{"raw":{"language":"json"}}},"url":"https://XXXapi.crmeducacional.com/api/AtualizarVigenciaConcurso","description":"

Objetivo

O objetivo deste método é permitir a atualização do período de vigência e data da prova de um determinado
concurso, alterando a data de início, data de fim, data da prova, hora da prova e minuto da prova do mesmo.

Parâmetro de Entrada

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório
Código do Concurso	INT	SIM
Data Inicial	DATETIME (MM/DD/AA)	SIM
Data Final	DATETIME (MM/DD/AA)	SIM
Data da Prova	DATETIME (MM/DD/AA)	SIM
Hora da Prova	INT	SIM
Minuto da Prova	INT	SIM
Token	STRING	SIM

Caso as propriedades hora, minuto e segundo do campo Data Final sejam iguais a 0, o serviço irá salvar no CRM a data enviada com a hora 23:59:59, indicando que o concurso estará ativo até o fim do dia enviado. Caso o campo Data Final tenha valor diferente de 0 em alguma destas propriedades, o valor persistido no CRM será o recebido.

Campo	Descrição	Tipo
0	Concurso atualizado com sucesso.	INT
1	Concurso não encontrado.	INT
2	Erro ao atualizar as datas do concurso.	INT
3	Erro na conversão de dados.	INT
4	Erro genérico.	INT
5	Hora da Prova inválida. O valor deve ser entre 0 e 23.	INT
6	Minuto da Prova inválido. O valor deve ser entre 0 e 59.	INT

","urlObject":{"protocol":"https","path":["api","AtualizarVigenciaConcurso"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8e351c81-9715-4dcc-a611-b9f8b79815d2"},{"name":"Criar Cópia De Concurso","id":"34583894-827c-4704-8df3-32edba3aded5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer IJjrtChsl8pPMeD8aFxleRojnBjwA7HGD2_tWSgdzduieIYy_zO605IFxheaoul4vagW6jJHqpVqmocey95B1lG8mqnFm6WBa5OyxW9GWnGQasYaNxHTIzjYJ2dIz-QWJ7a_7uIq2dbzoIzWpUDM7zshqHBRyEL6XQmcKr3H0d80HPf5uV4SAg5pAbNOyODsy6RcBm33U6rXbcoJNhP7DRRJLrJEsa8yO--eijr_MbTmye8HjEEaLgc8lPBoZscO","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"CodigoConcursoOriginal\": 5,\n \"NovoCodigoConcurso\": 6,\n \"NomeConcurso\": \"concurso teste\",\n \"DataInicialConcurso\": \"02/02/2028\",\n \"DataFinalConcurso\": \"02/02/2029\",\n \"PeriodoLetivoConcurso\": \"Segundo\",\n \"DataProva\": \"02/02/2028\",\n \"HoraProva\": 12,\n \"MinutoProva\": 00,\n \"CopiarOfetas\": true,\n \"CopiarFormulario\": false,\n \"CopiarModalidades\": true,\n \"CopiarSalas\": true,\n \"CopiarCategoria\": false,\n \"CopiarVinculoOfertas\": true,\n \"CopiarMensagens\": false,\n \"AnoOferta\": 2028,\n \"DataInicialOferta\": \"02/02/2028\",\n \"DataFinalOferta\": \"02/02/2029\",\n \"PeriodoOferta\": 2,\n \"PossuiPagamento\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://XXXapi.crmeducacional.com/api/CriarCopiaDeConcurso","description":"

Objetivo:

Criar um registro do tipo Cópia de Concurso por meio de integrações externas.

Observações:

StartFragment

Caso algum dos parâmetros opcionais não sejam enviados, o sistema irá utilizar os dados do Concurso Original.

EndFragment

Parâmetro de Entrada

Parâmetro	Tipo	Obrigatório
Código do Concurso Original	INT	SIM
Novo Código de Concurso	INT	SIM
Nome do Concurso	STRING	SIM
Data Inicial do Concurso	DATETIME (MM-DD-AA HH-MM-SS)	NÃO
Data Final do Concurso	DATETIME (MM-DD-AA HH-MM-SS)	NÃO
Período Letivo do Concurso	STRING	NÃO
Data da Prova	DATETIME (MM-DD-AAAA)	NÃO
Hora da Prova	INT	NÃO
Minuto da Prova	INT	NÃO
Copiar Ofertas	BOOLEAN	SIM
Copiar Formulário	BOOLEAN	SIM
Copiar Modalidades	BOOLEAN	SIM
Copiar Salas	BOOLEAN	SIM
Copiar Categoria	BOOLEAN	SIM
Copiar Vínculo Ofertas	BOOLEAN	SIM
Copiar Mensagens	BOOLEAN	SIM
Ano Oferta	INT	SIM
Data Inicial Oferta	DATETIME (MM-DD-AAAA)	SIM
Data Final Oferta	DATETIME (MM-DD-AAAA)	SIM
Periodo Oferta	INT	SIM
PossuiPagamento	BOOLEAN	SIM
Token	STRING	SIM

Mensagem de Retorno

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição	Tipo
0	Registro criado com sucesso.	INT
1	Id do concurso original não encontrado	INT
2	Id do novo concurso já pertence a outro concurso	INT
3	Id do novo concurso deve ser maior que 0	INT
4	Nome do concurso deve ser preenchido	INT
5	Hora da Prova Inválida. Informe um valor entre 0 e 23	INT
6	Minuto da Prova Inválido. Informe um valor entre 0 e 59	INT

","urlObject":{"protocol":"https","path":["api","CriarCopiaDeConcurso"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"34583894-827c-4704-8df3-32edba3aded5"},{"name":"Criar Chamada","id":"86f87dae-d227-4af1-9792-c26ca42b0ec3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"CodigoConcurso\": 6,\n \"NomeChamada\": \"Chamada Automatica de API\",\n \"NumeroOpcao\": 1,\n \"TodasOfertas\": true,\n \"ChamadaAutomatica\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://XXXapi.crmeducacional.com/api/EnviarChamada","description":"

Objetivo

Este método cria uma chamada no CRM em concurso ativo

Observações:

Se já existir uma chamada com o mesmo nome passado no parâmetro será retornado falso e nada é feito, caso contrário cria uma chamada com esse nome.

Se o parâmetro Número de Opções for diferente de 1,2 ou 3 o método retorna falso.

Campo	Possíveis valores	Descrição	Tipo	Obrigatório
Código do Concurso			INT	SIM
Nome da Chamada			STRING	SIM
Número de opções	1 2 3	1ª Opção de curso 2ª Opção de curso 3ª Opção de curso	INT	SIM
TodasOfertas			BOOLEAN	SIM
ChamadaAutomatica			BOOLEAN	SIM
Token			STRING	SIM

\n\n

Mensagem de Retorno

\n\n

Situação	Retorno	Tipo
Sucesso	TRUE	BOOLEAN
Falha	FALSE	BOOLEAN

","urlObject":{"protocol":"https","path":["api","EnviarChamada"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"86f87dae-d227-4af1-9792-c26ca42b0ec3"}],"id":"5192cd46-3f40-4993-8fac-3cf23595b268","_postman_id":"5192cd46-3f40-4993-8fac-3cf23595b268","description":""},{"name":"Conta","item":[{"name":"Enviar Conta","id":"873b7359-e21c-4bae-ab5c-34e275f6cf74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"access_token","value":"","type":"text"},{"key":"token_type","value":"","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n \"IdentificadorConta\": \"\",\r\n \"IdentificadorCategoria\": \"\",\r\n \"Nome\": \"\",\r\n \"EmailAutenticacao\":\"\",\r\n \"Senha\":\"\",\r\n \"TipoRelacao\": \"\",\r\n \"EmailContato\": \"\",\r\n \"PermitirArquivoRetorno\":true,\r\n \"PermitirRelatorios\": true,\r\n \"PermitirUploadProva\":true,\r\n \"Endereco\": \"\",\r\n \"Telefone\": \"\",\r\n \"Fax\": \"\",\r\n \"Site\": \"\",\r\n \"StatusConta\": \"Ativo\",\r\n \"ContaReferencia\": true,\r\n \"FiltroConta\" : {\r\n \"Nome\": \"Filtro Conta API\",\r\n \"IdentificadorFiltro\": \"Filtro Conta API\"\r\n }\r\n}"},"url":"https://XXXapi.crmeducacional.com/api/IntegracaoClientes/EnviarConta","description":"

Objetivo

A API de integração do CRM Educacional disponibiliza o método \"EnviarConta\",
esse que recebe uma Conta no formato JSON para ser criada ou atualizada (caso já exista) no CRM.

\n\n

Informações Importantes:

O campo StatusConta recebe os valores \"Ativo\" ou \"Inativo\"

O campo \"ContaReferencia\" recebe os valores \"true\" ou \"false\", utilizados para informar se aquela conta deve ser salva no Filtro informado.

O objeto FiltroConta tem os seguintes campos string:

Nome

IdentificadorFiltro

Parâmetros de Entrada

\n\n

Campo	Possíveis valores	Descrição	Tipo	Obrigatório
IdentificadorConta			STRING	SIM
IdentificadorCategoria			STRING	NÃO
Nome			STRING	SIM
EmailAutenticacao			STRING	NÃO
Senha			STRING	NÃO
TipoCategoria	9 15 5 12 4 13 6 7 11 10 2 1 8 3 14	Revendedor UnidadeCertificadora Parceiro Outro Investidor InstituicaoEnsino Influenciador Imprensa FornecedorServicos Fornecedor Consultor Concorrente ClientePotencial Cliente Cidade	ENUMERATOR	NÃO
EmailContato		Busca o primeiro contato encontrado com o e-mail informado	STRING	NÃO
PermitirArquivoRetorno			BOOL	NÃO
PermitirRelatorios			BOOL	NÃO
PermitirUploadProva			BOOL	NÃO
Endereco			STRING	NÃO
Telefone			STRING	NÃO
Fax			STRING	NÃO
Site			STRING	NÃO
Site			STRING	NÃO

\n\n

Possíveis Retornos

Código	Status	Mensagem
200	Sucesso	Conta criada com sucesso
200	Sucesso	Conta atualizada com sucesso
400	Falha	Motivo da falha

","urlObject":{"protocol":"https","path":["api","IntegracaoClientes","EnviarConta"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"873b7359-e21c-4bae-ab5c-34e275f6cf74"}],"id":"d387d8cd-47fa-43b0-a721-59e3a808ec08","_postman_id":"d387d8cd-47fa-43b0-a721-59e3a808ec08","description":""},{"name":"Cupom de Desconto","item":[{"name":"Enviar Cupom","id":"647dbe14-f7dc-47f5-bb3e-69098109fc70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer IJjrtChsl8pPMeD8aFxleRojnBjwA7HGD2_tWSgdzduieIYy_zO605IFxheaoul4vagW6jJHqpVqmocey95B1lG8mqnFm6WBa5OyxW9GWnGQasYaNxHTIzjYJ2dIz-QWJ7a_7uIq2dbzoIzWpUDM7zshqHBRyEL6XQmcKr3H0d80HPf5uV4SAg5pAbNOyODsy6RcBm33U6rXbcoJNhP7DRRJLrJEsa8yO--eijr_MbTmye8HjEEaLgc8lPBoZscO","type":"text"}],"body":{"mode":"raw","raw":"{\n \"CodigoCupom\": \"Ativo Teste\",\n \"PecentualDesconto\": 70,\n \"CupomUsoUnico\": false,\n \"DataInicial\": \"05/27/2025\",\n \"DataFinal\": \"06/05/2025\",\n \"CupomUtilizado\": false,\n \"TipoCupomDesconto\": 0,\n \"EstadoObjeto\": 0,\n \"Descricao\": \"Olá\",\n \"CodigoCupomSGA\": \"Cupom Novo SGA\"\n}","options":{"raw":{"language":"json"}}},"url":"https://XXXapi.crmeducacional.com/api/EnviarCupom","description":"

Objetivos:

Criar cupons de descontos.

Importante: Os campos Data Inicial e Data Final devem possuir o seguinte formato:
MM/DD/YYYY

Caso o campo \"Código de integração SGA\" seja enviado, ele será a chave de busca para alteração de um cupom já existente.
\n
Caso o o campo \"Código de integração SGA\" não seja enviado, a busca será pelo \"Código do Cupom\"
\n

Requisitos:

O Concurso informado no JSON da requisição, precisa estar ATIVO.

O campo TipoCupomDesconto aceita os seguintes valores: 0, 1 e 2 sendo que:

0 = Campanha

1 = Pontualidade

2 = Voucher

O campo EstadoObjeto aceita os seguinte valores: 0 e 1 sendo que:

0 = ativo

1 = inativo

Requisitos:

O Concurso informado no JSON da requisição, precisa estar ATIVO.

Retorno:

Campo	Descrição	Tipo
0	Falha inesperada	INT
1	Cupom enviado com sucesso.	INT
2	É necessário enviar um cupom.	INT
3	É necessário informar um código para o cupom.	INT
4	O valor do campo Percentual de Desconto deve estar entre 0 e 100.	INT
5	Cupom enviado já existe no CRM.	INT
6	O Código do cupom deve conter no máximo 100 caracteres	INT
7	Não existe concurso com o código informado.	INT

","urlObject":{"protocol":"https","path":["api","EnviarCupom"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"647dbe14-f7dc-47f5-bb3e-69098109fc70"}],"id":"6bca8ce5-b99a-46a7-bf89-087803700300","_postman_id":"6bca8ce5-b99a-46a7-bf89-087803700300","description":""},{"name":"Inscrição do Candidato","item":[{"name":"Atualizar Campos Customizados Da Inscrição","id":"e0699b80-d705-41d6-8e40-c09373c2332c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"access_token","value":"","type":"text"},{"key":"token_type","value":"","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://XXXapi.crmeducacional.com/api/IntegracaoClientes/AtualizarInscricao?cad_numeroinscricao=CAN-000000-CRM&valor_campo_teste=123","description":"

Objetivo

Permitir o envio de dados a serem atualizados na Inscrição do Candidato no CRM, porém, somente serão atualizados os campos customizados existentes no ambiente do cliente.

Observações:

\n\n

O nome do campo informado (parâmetro) deve ser exatamente igual ao nome lógico do campo no CRM.
\n
Somente serão atualizados os campos que não são do produto, ou seja, somente os campos criados pelo cliente.

Parâmetros de Entrada

Campo	Tipo
NumeroInscricao	String
\"Campo do Cliente\"	\"Campo do cliente em questão a ser atualizado\".

\n\n

Possíveis Retornos

Código	Descrição
200	Inscrição: {NumeroInscricao} foi atualizada com sucesso.
400	Não foi possível localizar a Inscrição, o Número da Inscrição ({NumeroInscricao}) não foi informado. Nenhum dado foi atualizado.
400	Não foi possível localizar a Inscrição pelo Número da Inscrição ({numeroInscricao}) informado. Nenhum dado foi atualizado.
400	Dados não foram atualizados na Inscrição: {NumeroInscricao}, gentileza realizar procedimento novamente.
400	Nenhum campo enviado pode ser atualizado.
401	Authorization has been denied for this request.
500	Ocorreu uma inconsistência ao 'AtualizarInscricao/MontarListaCamposInscricao'

","urlObject":{"protocol":"https","path":["api","IntegracaoClientes","AtualizarInscricao"],"host":["XXXapi","crmeducacional","com"],"query":[{"key":"cad_numeroinscricao","value":"CAN-000000-CRM"},{"key":"valor_campo_teste","value":"123"}],"variable":[]}},"response":[],"_postman_id":"e0699b80-d705-41d6-8e40-c09373c2332c"},{"name":"Alterar Inscrição e Interessado para Pré-Matriculado","id":"9caf8728-506a-4f3a-8b65-fd55d0f0acc3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"access_token","value":"","type":"text"},{"key":"token_type","value":"","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n \"NumeroInscricao\" : \"Numero da inscrição\",\r\n \"IdentificadorOferta\": \"Identificador da Oferta\",\r\n \"ChaveOferta\": \r\n {\r\n \"CodEscola\":\"\",\r\n\t\t\t\"Ano\":\"\",\r\n\t\t\t\"Regime\":\"\",\r\n\t\t\t\"CodCurso\":\"\",\r\n\t\t\t\"CodCampus\":\"\",\r\n\t\t\t\"CodCurriculo\":\"\",\r\n\t\t\t\"Periodo\":\"\",\r\n\t\t\t\"CodTurno\":\"\"\r\n }\r\n}"},"url":"https://XXXapi.crmeducacional.com/api/IntegracaoClientes/AlteraInteressadoParaPreMatriculado","description":"

Objetivo

Este método permite informar a Oferta que o candidato foi pré matriculado. Sendo assim, tanto o lead quando a inscrição terão o campo pré-matriculado alterados para sim.

\n\n

Funcionamento:

\n\n

O método recebe um Número de Inscrição do CRM, o campo Identificador Oferta (opcional) e o objeto ChaveOferta (opcional) para serem atualizado no CRM.

\n\n

Caso os campos opcionais não sejam informados, o ele irá apenas irá atualizar a flag \"Pré-Matriculado\" da Inscrição e do lead para \"Sim\".

\n\n

Observação:

\n\n

A condição de pré-matriculado do interessado pode parecer não sincronizada para aqueles com múltiplas inscrições.
O parâmetro null deverá ser informado campos que não possuem valores.

Parâmetros

Campo	Tipo	Descrição
NumeroInscricao	string	Número da Inscrição no CRM
IdentificadorOferta	string	Identificador da Oferta que será vinculada a Inscrição. Parâmetro Opcional.
ChaveOferta	object	Combinação de Informações para localização da Oferta que será vinculada na Inscrição. Objeto Opcional.
token	string	token de autenticação

\n\n

Possíveis retornos

\n\n

Status	Descrição
200	OK
400	API: AlteraInteressadoParaPreMatriculado. Mensagem: Número da Inscrição não foi informado. Para realização da integração deverá ser informado o Número da Inscrição.
400	API: AlteraInteressadoParaPreMatriculado. Mensagem: Número da Inscrição: {Número da Inscrição} não foi localizado no CRM. Para realização da integração deverá ser informado o Número da Inscrição existente.
400	API: AlteraInteressadoParaPreMatriculado. Mensagem: Identificador da Oferta: {IdentificadorOferta} informado não retornou uma Oferta para o Concurso: {Concurso}. Não será possível alterar a Inscrição {Número da Inscrição} para Pré Matriculada.
400	API: AlteraInteressadoParaPreMatriculado. Mensagem: Identificador da Oferta: {IdentificadorOferta} informado retornou mais de uma Oferta para o Concurso: {Concurso}. Não será possível alterar a Inscrição {Número da Inscrição} para Pré Matriculada.
400	API: AlteraInteressadoParaPreMatriculado. Mensagem: ChaveOferta informada não retornou uma Oferta para o Concurso: {Concurso}. Não será possível alterar a Inscrição {Número da Inscrição} para Pré Matriculada.
400	API: AlteraInteressadoParaPreMatriculado. Mensagem: ChaveOferta informada retornou mais de uma Oferta para o Concurso: {Concurso}. Não será possível alterar a Inscrição {Número da Inscrição} para Pré Matriculada.
401	Authorization has been denied for this request.
500	API: AlteraInteressadoParaPreMatriculado. Erro Genérico: {Detalhes do Erro}

","urlObject":{"protocol":"https","path":["api","IntegracaoClientes","AlteraInteressadoParaPreMatriculado"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9caf8728-506a-4f3a-8b65-fd55d0f0acc3"},{"name":"Alterar Situação Candidato Para Inscrito","id":"db447782-47f9-4ac6-b18f-b135867daaa1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer IJjrtChsl8pPMeD8aFxleRojnBjwA7HGD2_tWSgdzduieIYy_zO605IFxheaoul4vagW6jJHqpVqmocey95B1lG8mqnFm6WBa5OyxW9GWnGQasYaNxHTIzjYJ2dIz-QWJ7a_7uIq2dbzoIzWpUDM7zshqHBRyEL6XQmcKr3H0d80HPf5uV4SAg5pAbNOyODsy6RcBm33U6rXbcoJNhP7DRRJLrJEsa8yO--eijr_MbTmye8HjEEaLgc8lPBoZscO","type":"text"}],"url":"https://XXXapi.crmeducacional.com/api/AlterarSituacaoCandidatoParaInscrito?numeroInscricao=123","description":"

Objetivo

O método tem o objetivo de alterar a situação do candidato no Concurso da Inscrição recebida para “Inscrito” e libera 1 vaga nas Ofertas do Candidatos.\nEsta alteração só será realizada se a situação atual do candidato for \"Convocado\" ou \"Matriculado\".

Parâmetros de Entrada

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Parâmetro	Tipo	Obrigatório
NumeroInscricao	String	SIM
Token	String	SIM

\n\n

Mensagem de Retorno

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Valor	Descrição	Tipo
0	A situação no concurso do candidato foi alterada com sucesso para 'Inscrito' e foi liberada 1 vaga na oferta.'.	INT
1	A situação no concurso do candidato foi alterada com sucesso para 'Inscrito', mas não foi possível acrescentar 1 vaga na oferta. Verifique se o campo 'Quantidade de Vagas' tem valor e se 'Vagas Disponíveis' na oferta é menor que 'Quantidade de Vagas'.	INT
2	A situação no concurso do candidato foi alterada com sucesso para 'Inscrito', mas não foi possível acrescentar 1 vaga na oferta pois não foram encontradas ofertas para o candidato.	SIM
3	A situação no concurso do candidato foi alterada com sucesso para 'Inscrito', mas não foi liberada nenhuma vaga na oferta porque não foi encontrada classificação com o status 'Convocado'.	INT
4	A situação no concurso do candidato não foi alterada e não foi liberada nenhuma vaga na oferta pois a situação no concurso não é 'Convocado' nem 'Matriculado'.	INT
5	Falha ao tentar atualizar a situação no concurso do candidato para 'Inscrito'. Nenhuma vaga foi liberada na oferta.	INT
6	Inscrição não encontrada.	SIM
7	Falha inesperada.	SIM

","urlObject":{"protocol":"https","path":["api","AlterarSituacaoCandidatoParaInscrito"],"host":["XXXapi","crmeducacional","com"],"query":[{"key":"numeroInscricao","value":"123"}],"variable":[]}},"response":[],"_postman_id":"db447782-47f9-4ac6-b18f-b135867daaa1"},{"name":"Alterar Situação Para Desistente","id":"3fe9ff3f-8efe-460c-99d0-0f0755a317e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer IJjrtChsl8pPMeD8aFxleRojnBjwA7HGD2_tWSgdzduieIYy_zO605IFxheaoul4vagW6jJHqpVqmocey95B1lG8mqnFm6WBa5OyxW9GWnGQasYaNxHTIzjYJ2dIz-QWJ7a_7uIq2dbzoIzWpUDM7zshqHBRyEL6XQmcKr3H0d80HPf5uV4SAg5pAbNOyODsy6RcBm33U6rXbcoJNhP7DRRJLrJEsa8yO--eijr_MbTmye8HjEEaLgc8lPBoZscO","type":"text"}],"url":"https://XXXapi.crmeducacional.com/api/AlterarSituacaoParaDesistente?numeroInscricao=123","description":"

Objetivo

Este método possui a finalidade de informar ao CRM que o candidato desistiu da vaga. Ele altera a situação do candidato no Concurso da Inscrição recebida de \"Convocado\" para “Desistente” e libera 1 vaga na Oferta do Candidato.

Parâmetros de Entrada

\n\n

Parâmetro	Tipo	Obrigatório
NumeroInscricao	String	SIM
Token	String	SIM

\n\n

Mensagem de Retorno

\n\n

Situação	Retorno	Tipo
Sucesso	TRUE	BOOLEAN
Falha	FALSE	BOOLEAN

","urlObject":{"protocol":"https","path":["api","AlterarSituacaoParaDesistente"],"host":["XXXapi","crmeducacional","com"],"query":[{"key":"numeroInscricao","value":"123"}],"variable":[]}},"response":[],"_postman_id":"3fe9ff3f-8efe-460c-99d0-0f0755a317e8"},{"name":"Atualizar RA, Senha e Maioridade SGA","id":"e5c33135-2923-4203-8714-0f7eb8bab7bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"access_token","value":"","type":"text"},{"key":"token_type","value":"","type":"text"}],"body":{"mode":"raw","raw":" { \r\n \"NumeroInscricao\" : \"NumeroInscricao\",\r\n \"RA\": \"RA 1234\",\r\n \"SenhaRA\": \"Senha do RA\",\r\n \"MaioridadeRA\" : false\r\n}"},"url":"https://XXXapi.crmeducacional.com/api/IntegracaoInterna/PreencheRASenhaSGA","description":"

Objetivo

Este método recebe um número de inscrição do CRM e os campos RA, Senha RA e Maioridade para serem atualizado no CRM.

\n\n

Parâmetros de Entrada

Campo	Tipo	Descrição
NumeroInscricao	string	Número da Inscrição no CRM
RA	string	Registro Acadêmico da Inscrição
SenhaRA	string	Senha Registro Acadêmico da Inscrição
MaioridadeRA	bool	Registro Acadêmico é de Maioridade?

\n\n

Possíveis retornos

\n\n

\"Inscrição atualizada\"

\n\n

\"Inscrição não encontrada\"

\n\n

\"Erro ao atualizar a inscrição, verifique se os valores dos campos enviados estão de acordo com a documentação.\"

","urlObject":{"protocol":"https","path":["api","IntegracaoInterna","PreencheRASenhaSGA"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e5c33135-2923-4203-8714-0f7eb8bab7bc"},{"name":"Atualizar Sala do Candidato","id":"0d9e3556-f31e-4fdf-89f9-6c2dd53fbead","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer IJjrtChsl8pPMeD8aFxleRojnBjwA7HGD2_tWSgdzduieIYy_zO605IFxheaoul4vagW6jJHqpVqmocey95B1lG8mqnFm6WBa5OyxW9GWnGQasYaNxHTIzjYJ2dIz-QWJ7a_7uIq2dbzoIzWpUDM7zshqHBRyEL6XQmcKr3H0d80HPf5uV4SAg5pAbNOyODsy6RcBm33U6rXbcoJNhP7DRRJLrJEsa8yO--eijr_MbTmye8HjEEaLgc8lPBoZscO","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"CodigoConcurso\":39,\n\t\"Inscricoes\": [\"CAN-002157-DEV@2\"],\n\t\"Nomelocalavaliacao\": \"Homologação Sala exemplo criação\",\n\t\"NomeSala\": \"Homologação Sala exmplo criação\"\n}","options":{"raw":{"language":"json"}}},"url":"https://XXXapi.crmeducacional.com/api/AtualizaSalaCandidato","description":"

Objetivo

Atualizar a sala e o número da carteira dos candidatos no CRM.

Regras do Método

O parâmetro (inscrições) pode ser passado de duas maneiras:

A primeira forma é passando apenas um array de números de inscrições.
Já na segunda forma é possível passar um array no formato (inscricao@carteira - exemplo: CAN-00001-CRM@1. Isso significa que o candidato CAN-00001-CRM está na carteira 1).

O método tentará encontrar um local de avaliação existente buscando pelo parâmetro nomelocalavaliacao.

Caso encontre um local de avaliação, ele será vinculado a sala informada por parâmetro
Caso não encontre um local de avaliação, será criado um novo local de avaliação com o nome informado por parâmetro.

O método sempre tentará encontrar uma sala existente buscando pela “chave composta” (nomelocalavaliacao + nomesala).

Caso encontre uma sala, a mesma será vinculada ao concurso, inscrições e local de avaliação informados nos parâmetros.
Caso não encontre uma sala, o método irá criar uma nova sala com o nome informado por parâmetro e a mesma será vinculada ao concurso, inscrições e local de avaliação informados nos parâmetros.

Observação

Se um dos parâmetros (local de avaliação ou sala) for vazio ou nulo e o outro não, o método retorna falso.
Se ambos os parâmetros (local de avaliação e sala) forem vazios ou nulos, a sala e o número da carteira dos candidatos são limpados no CRM (atualizada sem sala e sem número de carteira).

StartFragment

Parâmetro de Entrada

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório
Código do Concurso	INT	SIM
Inscrições	ARRAY STRING	SIM
Nome do local de avaliação	STRING	NÃO
Nome da Sala	STRING	NÃO
Token	STRING	SIM

Mensagem de Retorno

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Situação	Retorno	Tipo
Sucesso	TRUE	BOOLEAN
Falha	FALSE	BOOLEAN

","urlObject":{"protocol":"https","path":["api","AtualizaSalaCandidato"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[{"id":"69c7a473-9a9d-4215-91ea-fda2e43dc828","name":"Exemplo 1","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"CodigoConcurso\":39,\n\t\"Inscricoes\": [\"CAN-002157-DEV@2\"],\n\t\"Nomelocalavaliacao\": \"Homologação Sala\",\n\t\"NomeSala\": \"Homologação Sala\"\n}","options":{"raw":{"language":"json"}}},"url":"https://XXXapi.crmeducacional.com/api/AtualizaSalaCandidato"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"83936cff-17c0-4e44-9e3c-bb6dc53c8c30","name":"Exemplo 2","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"CodigoConcurso\":1,\n\t\"Inscricoes\": [\"CAN-002157-DEV\", \"40\"],\n\t\"Nomelocalavaliacao\": \"Homologação Sala\",\n\t\"NomeSala\": \"Homologação Sala\"\n}","options":{"raw":{"language":"json"}}},"url":"https://XXXapi.crmeducacional.com/api/AtualizaSalaCandidato"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"0d9e3556-f31e-4fdf-89f9-6c2dd53fbead"},{"name":"Alterar Situação Funil Para Matriculado","id":"8ed8c7c8-766f-4698-b301-672bd214a775","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer IJjrtChsl8pPMeD8aFxleRojnBjwA7HGD2_tWSgdzduieIYy_zO605IFxheaoul4vagW6jJHqpVqmocey95B1lG8mqnFm6WBa5OyxW9GWnGQasYaNxHTIzjYJ2dIz-QWJ7a_7uIq2dbzoIzWpUDM7zshqHBRyEL6XQmcKr3H0d80HPf5uV4SAg5pAbNOyODsy6RcBm33U6rXbcoJNhP7DRRJLrJEsa8yO--eijr_MbTmye8HjEEaLgc8lPBoZscO","type":"text"}],"body":{"mode":"raw","raw":"{\n \"NumeroInscricao\": \"123\",\n \"DataMatricula\": \"01/01/2021\", \n \"ChaveOferta\": {\n \t \"CodEscola\":1,\n \"Ano\":2021,\n \"Regime\":1,\n \"Periodo\":1,\n \"CodCurso\":1,\n \"CodCurriculo\":1,\n \"CodCampus\":1,\n \"CodTurno\":1,\n \"PeriodoIngresso\" : 1,\n \"PeriodoAcademico\" : 1\n },\n \"BolsaOuFinanciamento\":1\n}","options":{"raw":{"language":"json"}}},"url":"https://XXXapi.crmeducacional.com/api/AlteraSituacaoFunilParaMatriculado/","description":"

Objetivo

Este método informa ao CRM que o candidato se encontra com sua matrícula devidamente efetivada no SGA, permitindo desta forma a realização de campanhas de marketing de boas-vindas.

Ele irá alterar a SITUAÇÃO NO FUNIL e a SITUAÇÃO NO CONCURSO do candidato para Matriculado.

Além disso, irá atualizar os dados de Matrícula do candidato de acordo com os parâmetros:

Data da Matrícula, (formato americano (mês/dia/ano))
Chave da Oferta
Bolsa ou Financiamento.

Caso algum desses três parâmetros seja passado como (null), à respectiva informação será resetada no CRM.

Parâmetros de Entrada

StartFragment

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Possíveis valores	Descrição	Tipo	Obrigatório
Número de Inscrição			STRING	SIM
Data da Matrícula			DATETIME	SIM
Chave da Oferta	Código da Escola Ano Regime Período Código do Curso Código do Currículo Código do Campus Código do Turno Periodo Ingresso Periodo Academico		CHAVEOFERTA INT INT INT INT INT INT INT INT	SIM SIM SIM SIM SIM SIM SIM SIM SIM SIM SIM
Bolsa ou Financiamento	1 2	Bolsa Financiamento	ENUMERATOR	SIM
Token			STRING	SIM

Mensagem de Retorno

\n\n

Valor	Descrição	Tipo
0	Situação no Funil Atualizada com Sucesso, e os dados da Matrícula foram resetados.	INT
1	Situação no Funil e Dados de Matrícula atualizados com sucesso.	INT
2	Erro. O parâmetro 'numeroInscricao' deve ser preenchido.	INT
3	Erro. Inscrição não encontrada.	INT
4	Erro. Não foi encontrada nenhuma oferta no concurso desta inscrição com a 'chaveOferta' informada.	INT
5	Erro. Existem mais de uma oferta no concurso desta inscrição com a 'chaveOferta' informada.	INT
6	Erro Genérico.	INT

","urlObject":{"protocol":"https","path":["api","AlteraSituacaoFunilParaMatriculado",""],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8ed8c7c8-766f-4698-b301-672bd214a775"},{"name":"Buscar Anexos da Inscrição","id":"36396179-4335-4349-8d67-42386918452d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://XXXapi.crmeducacional.com/api/IntegracaoClientes/BuscarAnexosPorInscricao?numeroInscricao=CAN-000000-CRM","description":"

Objetivo

A API de integração do CRM Educacional disponibiliza o método \"Buscar Anexos Por Inscricao\", esse que recebe um Número da Inscrição e então retorna um Json contendo todos os anexos da inscrição informada.

Para utilizar este método é necessário fazer uma requisição GET, passando o parâmetro numeroInscricao no params da requisição:

O corpo do arquivo está armazenado no dynamics utilizando uma BASE64 e pode ser convertido em arquivo da seguinte forma:

   var path = @\"c:\\caminhoParaSalvar\\\";\n                            foreach(var anexo in listaAnexos)\n                            {\n                                Byte[] bytes = Convert.FromBase64String(anexo.CorpoArquivo);\n                                File.WriteAllBytes($\"{path}{anexo.NomeArquivo}\", bytes);\n                            }\n\n

Possíveis retornos:

Sucesso:

[
{
\"Assunto\":\"Assunto\",
\"NomeArquivo\":\"arquivo.txt\",
\"CorpoArquivo\":\"corpo do arquivo em base64\",
\"MimeType\":\"text/plain\"
}
]

Retorno falha.

Retorno 500 - Verifique se o numeroInscricao foi informado corretamente.

\n","urlObject":{"protocol":"https","path":["api","IntegracaoClientes","BuscarAnexosPorInscricao"],"host":["XXXapi","crmeducacional","com"],"query":[{"key":"numeroInscricao","value":"CAN-000000-CRM"}],"variable":[]}},"response":[],"_postman_id":"36396179-4335-4349-8d67-42386918452d"},{"name":"Cancelar Matricula","id":"49a4d99f-f1d8-47ac-b367-d3cfb53199c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"token_type","value":"","type":"text"},{"key":"access_token","value":"","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://XXXapi.crmeducacional.com/api/IntegracaoClientes/CancelarMatricula?numeroInscricao=numaro da inscricao","description":"

Objetivo

Este método tem a finalidade de informar o cancelamento de uma inscrição que está com o Status de Matriculada.

\n\n

Funcionamento:

\n\n

Este método recebe o Número de Inscrição por parâmetro, atualizando o campo \"Matrícula Cancelada\" na Inscrição do Candidato no CRM e retorna a vaga para a Oferta Matriculada ou para a Primeira Opção de Oferta, caso o campo Oferta Matriculada esteja vazio.

\n\n

Parâmetros de Entrada

\n\n

Campo	Descrição	Tipo	Obrigatório
Número da Inscrição	Número da Incrição do candidato dentro do CRM	STRING	SIM
token			SIM

\n\n

Possíveis retornos

\n\n

Status	Descrição
200	OK
200	A inscrição foi atualizada, mas a vaga não foi retornada para a oferta. Verifique a configuração de 'Quantidade de Vagas' e 'Vagas Disponíveis' na Oferta {Nome da Oferta}
400	A situação no concurso da inscrição não é 'Matriculado'
400	A inscrição já se encontra com a matrícula cancelada
400	Inscrição não encontrada. Verifique se o 'Numero de Inscricao' foi informado corretamente. Número de Inscrição: '{Número da Inscrição enviado}'
500	Erro genérico! '{Detalhes do Erro}'

","urlObject":{"protocol":"https","path":["api","IntegracaoClientes","CancelarMatricula"],"host":["XXXapi","crmeducacional","com"],"query":[{"key":"numeroInscricao","value":"numaro da inscricao"}],"variable":[]}},"response":[],"_postman_id":"49a4d99f-f1d8-47ac-b367-d3cfb53199c0"}],"id":"8da9e826-0d3c-48e6-bbb3-ff57e3fc38df","_postman_id":"8da9e826-0d3c-48e6-bbb3-ff57e3fc38df","description":""},{"name":"Lead","item":[{"name":"Buscar Leads Sem Inscrição","id":"220a58e3-ac8b-4de3-9816-94b9393938cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer IJjrtChsl8pPMeD8aFxleRojnBjwA7HGD2_tWSgdzduieIYy_zO605IFxheaoul4vagW6jJHqpVqmocey95B1lG8mqnFm6WBa5OyxW9GWnGQasYaNxHTIzjYJ2dIz-QWJ7a_7uIq2dbzoIzWpUDM7zshqHBRyEL6XQmcKr3H0d80HPf5uV4SAg5pAbNOyODsy6RcBm33U6rXbcoJNhP7DRRJLrJEsa8yO--eijr_MbTmye8HjEEaLgc8lPBoZscO","type":"text"}],"url":"https://XXXapi.crmeducacional.com/api/BuscarLeadsSemInscricao?dataInicial=2023-03-22&dataFinal=2023-03-20","description":"

Objetivos:

Este método é responsável por retornar os Leads ainda não Inscritos, ou seja, com Situação no Funil igual a \"Potencial\".
A pesquisa é realizada através do range de datas de criação recebido.

Parâmetros:

Parâmetro	Tipo	Obrigatório
Data Inicial	DATETIME (AAAA-MM-DD)	SIM
Data Final	DATETIME (AAAA-MM-DD)	SIM

\n\n

Campo	Descrição	Tipo
List	Lista com os Leads encontrados pela pesquisa.	LIST

\n\n

Exemplo de retorno:

 {\n        \"CamposFormulario\": [],\n        \"Nome\": \"Luana\",\n        \"ConcursoOrigem\": {\n            \"Nome\": null,\n            \"DataProva\": null,\n            \"HoraProva\": null,\n            \"Codigo\": null,\n            \"TamanhoAnexo\": null,\n            \"IdConcurso\": \"00000000-0000-0000-0000-000000000000\",\n            \"MinutoProvaValue\": -1\n        },\n        \"ConcursoReferencia\": null,\n        \"ConcursoAtual\": null,\n        \"ConcursoAtualReferencia\": null,\n        \"OfertaAtual\": null,\n        \"OfertaAtualReferencia\": null,\n        \"InscricaoAtual\": null,\n        \"InscricaoAtualReferencia\": null,\n        \"ProprietarioReferencia\": {\n            \"Id\": \"20f94496-8687-ed11-81ad-000d3a88e678\",\n            \"Nome\": \"# Usuário Teste Performance\",\n            \"NomeLogico\": \"systemuser\"\n        },\n        \"New_Sexo\": null,\n        \"EquipeReferencia\": null,\n        \"Equipe\": null,\n        \"UsuarioReferencia\": {\n            \"Id\": \"20f94496-8687-ed11-81ad-000d3a88e678\",\n            \"Nome\": null,\n            \"NomeLogico\": \"systemuser\"\n        },\n        \"Usuario\": null,\n        \"Email\": \"luana_ass@outlook.com\",\n        \"SobreNome\": \"Alves\",\n        \"NomeCompleto\": \"Luana Alves\",\n        \"NumeroInscricao\": null,\n        \"NecessidadesEspeciais\": null,\n        \"SituacaoFunil\": 1,\n        \"TelefoneCelular\": \"+5524992032994\",\n        \"CPF\": null,\n        \"PreMatriculado\": false,\n        \"CampaignSource\": null,\n        \"CampaignMedium\": null,\n        \"CampaignTerm\": null,\n        \"CampaignContent\": null,\n        \"CampaignName\": null,\n        \"UrlCancelamentoContatos\": null,\n        \"DataNascimento\": null,\n        \"OrigemClientePotencial\": 809220002,\n        \"Inscricoes\": null,\n        \"RetornoSistemaExterna\": null,\n        \"ServicoEducacionalInboundReferencia\": null,\n        \"CEP\": null,\n        \"EnderecoEstado\": null,\n        \"EnderecoCidade\": null,\n        \"EnderecoRua\": null,\n        \"EnderecoNumero\": null,\n        \"EnderecoBairro\": null,\n        \"PrimeiraSugstTesteVocacionalReferencia\": null,\n        \"PrimeiraSugstTesteVocacional\": null,\n        \"SegundaSugstTesteVocacionalReferencia\": null,\n        \"SegundaSugstTesteVocacional\": null,\n        \"TerceiraSugstTesteVocacionalReferencia\": null,\n        \"TerceiraSugstTesteVocacional\": null,\n        \"TipoLicencaBearings\": null,\n        \"SincronizarBearings\": false,\n        \"SincronizadoPlanetaY\": false,\n        \"ObservacoesChatPlanetaY\": null,\n        \"EnderecoComplemento\": null,\n        \"NomeSocial\": null,\n        \"PossuiNomeSocial\": false,\n        \"TelefoneComercial\": \"+5524992032994\",\n        \"Telefone2\": null,\n        \"Telefone3\": null,\n        \"Telephone3\": null,\n        \"Telephone2\": null,\n        \"AnoFormacao\": null,\n        \"RG\": null,\n        \"ModificadoPorCallCenterReferencia\": null,\n        \"ResponsavelReferencia\": null,\n        \"ModificadoPorCallCenter\": null,\n        \"CamposCustomizados\": null,\n        \"TipoInteressado\": 0,\n        \"UltimoLoginRealizado\": null,\n        \"CodigoPessoaFisicaContrato\": null,\n        \"AceitouLgpd\": false,\n        \"IpAceiteLgpd\": null,\n        \"DataAceiteLgpd\": null,\n        \"TokenRecuperarSenha\": null,\n        \"PreferenciaContato\": 1,\n        \"UnidadeInteresse\": null,\n        \"SerieInteresse\": null,\n        \"ContaReferencia\": null,\n        \"Descricao\": null,\n        \"UUID\": \"a14621c7-e094-423a-adb8-e1a6a5cfdddf\",\n        \"OrigemRD\": \"#1724 [2023/1] [Cadastro] [Graduação Presencial] Vestibular 2023\",\n        \"CorRaca\": null,\n        \"EstadoCivil\": null,\n        \"PreferenciaContatoColetada\": false,\n        \"IpPreferenciaContato\": null,\n        \"DataEnvioPreferenciaContato\": null,\n        \"EnderecoCountry\": null,\n        \"AtividadesDoPolo\": null,\n        \"GrauInstrucao\": null,\n        \"ClassificacaoGrau\": null,\n        \"PerfilPrimario\": null,\n        \"PerfilSecundario\": null,\n        \"CursoSugerido\": null,\n        \"CursoUmSelecionado\": null,\n        \"CursoDoisSelecionado\": null,\n        \"ClassificacaoLead\": null,\n        \"DataUltimaAtividade\": null,\n        \"NivelEnsino\": null,\n        \"ModalidadeEnsino\": null,\n        \"CodigoDoConsultor\": null,\n        \"Id\": \"56317d14-17c6-ed11-b597-000d3a88e678\",\n        \"DataCriacao\": \"2023-03-19T05:30:00Z\",\n        \"DataModificacao\": \"2023-03-19T05:30:32Z\"\n    }\n\n

\n","urlObject":{"protocol":"https","path":["api","BuscarLeadsSemInscricao"],"host":["XXXapi","crmeducacional","com"],"query":[{"key":"dataInicial","value":"2023-03-22"},{"key":"dataFinal","value":"2023-03-20"}],"variable":[]}},"response":[],"_postman_id":"220a58e3-ac8b-4de3-9816-94b9393938cd"}],"id":"ff9c5b8f-0271-469a-bf62-c0450054f7f6","_postman_id":"ff9c5b8f-0271-469a-bf62-c0450054f7f6","description":""},{"name":"Oferta","item":[{"name":"Criar Oferta","id":"8f8f9381-4631-4f3f-9823-a60b8ffb3dc6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"access_token","value":"","type":"text"},{"key":"token_type","value":"","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"\"E/46K+9DfXvc8LXOX/48z0XbrbHGCZ8M/2loPi0bw90Wu2pnEtylnqtT7eDmRTLY7ZJIoWNMSWRpdS0CZbyu6w==\"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"Oferta\":\r\n {\r\n \"DataFinal\":\"05-30-2025\",\r\n \"Nome\":\"Enfermagem\",\r\n \"TurnoOfertado\":\"Noite\",\r\n \"SemestreOfertado\":\"Segundo\",\r\n \"ConcursoReferencia\":\"\",\r\n \"ServicoEducacionalReferencia\":\"\",\r\n \"IdentificadorOferta\": \"enfermagem\",\r\n \"CategoriaReferencia\": \"\",\r\n \"Segmento\": \"Saude\",\r\n \"PublicoRestrito\": \"SomenteEnfermagem\"\r\n },\r\n \"CodigoConcurso\":\"123\",\r\n \"NomesCategoria\":\r\n [\r\n \"CRM Educacional - Brasil\"\r\n ],\r\n \"NomeServicoEducacional\":\"Enfermagem\",\r\n \"IdentificadorConta\" : \"CRMEducacional\"\r\n}"},"url":"https://XXXapi.crmeducacional.com/api/CriarOferta","description":"

Objetivo

Este método realiza a criação de uma ou mais Ofertas no CRM.

\n\n

Caso o campo IdentificadorOferta seja informado, ele será concatenado com o Identificador da Categoria. Serão removidos todos os espaços em branco e acentos e serão separados por \"|\".

\n\n

Se for passado uma oferta com o

IdentificadorOferta = 100 e a categorias com o Identificador 1, o IdentificadorOferta ficará como 100|1.

\n\n

Observações:

1 - O nome dos campos à esquerda: (chaves/parâmetro) deve ser igual ao nome do campo no CRM

2 - Além dos campos obrigatórios conforme tabela de exemplo acima, podem ser atualizados tanto outros campos do produto quanto demais campos criados pelo cliente.

3 - Para criar múltiplas ofertas, é necessário informar os nomes das categorias em array de strings/formato json no campo \"nomeCategorias\".

4 - As categorias informadas já devem existir no CRM e precisam conter chave única informada no campo Identificador Categoria no CRM.

5 - Para campos picklist, deverá ser informado sempre o \"Value\" correspondente da opção, conforme exemplo do campo cad_turnoequivalente.

\n\n

Parâmetros de Entrada

Campo	Tipo	Obrigatório	Descrição
Ofertas	Oferta	Sim	Objeto do tipo Oferta e que contem diversas propriedades: - DataFinal (Data final de vigência da oferta no formato MM/DD/YYYY HH:MM:SS caso não seja informada a hora, por padrão será inserido 23:59:59.), - Nome (Nome da oferta a ser criada.), - TurnoOfertado (Turno ofertado conforme padrão do cliente.), - SemestreOfertado (Semestre ofertado conforme concurso informado.), - ConcursoReferencia (Concurso referência associado a oferta.), - ServicoEducacionalReferencia (Nome do serviço Educacional a ser associado a oferta.), - IdentificadorOferta (Identificador da oferta.). - Segmento. - PublicoRestrito.
CodigoConcurso	INT	Sim	Codigo que identifica o concurso.
NomesCategoria	Array[] String	Sim	Array com nome de categorias existentes no CRM. Será criada uma oferta, para cada categoria válida informada neste campo. Considera-se categoria válida apenas categorias cujo campo Identificador Categoria esteja preenchido no CRM.
NomeServicoEducacional	String	Sim	Nome do Serviço Educacional a ser associado a oferta.
IdentificadorConta	String	Não	Valor do campo \"Identificador da conta\" da tabela \"Conta\" que será preenchida no campo \"Parceiro\"

\n\n

Possíveis retornos:

Status	Descrição
0	Ofertas criadas com sucesso.
1	Nome da oferta não informado.
2	Categorias não informadas.
3	Uma ou mais categorias da lista de nomes enviada não foram encontradas.
4	Concurso não encontrado.
5	Serviço Educacional não Encontrado.
6	Erro ao criar as ofertas.
7	Erro na conversão de dados.
8	Erro genérico.
9	O IdentificadorOferta gerado para uma das ofertas já existia no CRM e por isso nenhuma oferta foi criada.
10	Turno da oferta não informado.
11	Semestre da oferta não informado.
12	Oferta não informada.
500	\"Erro inesperado ao salvar dados: \" XXXXX

","urlObject":{"protocol":"https","path":["api","CriarOferta"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8f8f9381-4631-4f3f-9823-a60b8ffb3dc6"},{"name":"Atualizar Oferta","id":"2039a83c-32af-46e4-bcd0-07053032a13c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"access_token","value":"","type":"text"},{"key":"token_type","value":"","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"filtros\": [\r\n \"codigoConcurso\",\r\n \"cad_codcurso\"\r\n ],\r\n \"codigoConcurso\": \"123\",\r\n \"cad_codcurso\": \"1\",\r\n \"cad_datainicial\": \"04/03/2025\",\r\n \"cad_datafinal\": \"31/12/2025\",\r\n \"IdentificadorConta\": \"CRMEducacional\",\r\n \"cad_segmento\": \"Administração\",\r\n \"cad_publicorestrito\": \"Público Restrito\"\r\n}"},"url":"https://XXXapi.crmeducacional.com/api/IntegracaoClientes/AtualizarOferta","description":"

Objetivo

Permitir a atualização de um ou mais campos de uma oferta no CRM, utilizando a chave Identificador da Oferta.
\n
Permitir a atualização de múltiplas ofertas, utilizando como filtros obrigatórios os campos Concurso e Curso.
\n
Permitir incrementar e decrementar quantidade de vagas e vagas disponíveis para uma ou mais ofertas.
Observação: Ofertas vinculadas á chamadas automáticas e chamadas em andamento, não terão os campos de vagas atualizados.
\n

Exemplos de entrada

Chave do Campo	Exemplo	Tipo	Obrigatório	Descrição
cad_datainicial	01/01/2018	String	Não	Data inicial de vigência da oferta no formato DD/MM/YYYY HH:MM:SS, caso não seja informada a hora, será usado valor defautl 00:00:00.
cad_datafinal	31/01/2018 23:59:59	String	Não	Data final de vigência da oferta no formato DD/MM/YYYY HH:MM:SS caso não seja informada a hora, por padrão será inserido 23:59:59.
cad_turnoofertado	Noturno	String	Não	Turno ofertado conforme padrão do cliente.
cad_turnoequivalente	0	Numérico	Não	Código do turno equivalente conforme domínio do produto no CRM: Manha = 0, Tarde = 1, Noite = 2, Integral = 3
cad_semestreofertado	2024/1	String	Não	Semestre ofertado conforme concurso informado.
cad_vagasdisponiveis	70	Numérico	Não	Quantidade de vagas disponíveis para a oferta. Esse campo não pode ser alterado isoladamente, deve ser enviado em conjunto com campo Quantidade Vagas e ele será calculado conforme regras aplicadas ao valor informado no campo cad_quantidadevagas. Observação: Campo não sofrerá alteração quando a oferta estiver vinculada á chamadas automáticas ou chamadas com status Em Processamento e Em Publicacao.
cad_quantidadevagas	70	Numérico	Não	Quantidade de vagas disponibilizadas para a oferta. Quando informado, será utilizado para cálculo da quantidade de vagas disponíveis para a Oferta e será informado valor final no Result do método. Observação: Campo não sofrerá alteração quando a oferta estiver vinculada á chamadas automáticas ou chamadas com status EmProcessamento e EmPublicacao.
cad_identificadoroferta	99A	String	Sim	Identificador da oferta. O código deverá ser enviado quando necessário atualização de uma única oferta. Caso não seja informado, serão utilizados os valores do campo \"filtros\" para busca de ofertas a serem alteradas.
codigoConcurso	999.999	Numérico	Não	Código de Identificação do concurso no CRM. É obrigatório informar o campo, caso seja utilizado a opção \"filtros\".
cad_codcurso	200	Numérico	Não	Código do Curso. Campo obrigatório quando informada chave \"filtros\" para atualização de múltiplas ofertas.
filtros	\"filtros\": [ \"codigoConcurso\", \"cad_codcurso\" ]	String	Não	Campo obrigatório para atualização de múltiplas ofertas. Observar que os valores dos campos devem ser informados no json principal.
nomeServicoEducacional	Sistemas de Informação	String	Não	Alterar o Serviço Educacional a ser associado a oferta.
cad_codigoocde	146F27	String	Não\\\\\\\\\\\\\\\\\\\\\\*	Campo destinado para armazenar o código OCDE (Organização de Cooperação e de Desenvolvimento Económico).
cad_codigodomec	121370	Numérico	Não\\\\\\\\\\\\\\\\\\\\\\*	Campo destinado para armazenar o código do curso cadastrado no MEC (Ministério da Educação).
IdentificadorConta	CRMEducacional	String	Não	Valor do campo \"Identificador da conta\" da tabela \"Conta\" que será preenchida no campo \"Parceiro\"
cad_segmento	Segmento	String	Não
cad_publicorestrito	Público Restrito	String	Não

\n\n

Observações:
1 - O nome dos campos à esquerda: (chaves/parâmetro) deve ser exatamente igual ao nome do campo no CRM (exceto para a chave \"filtros\").

2 - Podem ser atualizados campos do produto e demais campos criados pelo cliente.

3 - Para alterar múltiplas ofertas, não informar o campo cad_identificadoroferta e informar a chave \"filtros\" contendo um array com dois valores \"codigoConcurso, cad_codcurso\". Ainda, os campos \"codigoConcurso, cad_codcurso\" devem ser informados no objeto json principal, com seus respectivos valores de referência.

ATENÇÂO: Todas as ofertas encontradas para esse filtro serão atualizadas.

4 - A categoria de uma oferta não pode ser atualizada via método api.

5 - Para campos picklist, deverá ser informado sempre o \"Value\" correspondente da opção, conforme exemplo do campo cad_turnoequivalente.

6 - Para alteração do campo Quantidade Vagas e Vagas Disponíveis, serão retornados no Result do método, os valores finais calculados para os campos, conforme regras do Produto.

7- Assim que receber a solicitação o método verifica se a oferta está vinculada a alguma chamada marcada como automática, se estiver, não haverá alteração dos campos:

Quantidade Vagas e Vagas Disponíveis e retornaremos um erro para a oferta específica -

Status: ParcialVagasNaoAlteradas. Os demais campos enviados serão devidamente alterados.

Será validado também se a oferta está vinculada a alguma chamada que esteja em status parcial (ou seja, em andamento), se estiver, não haverá também alteração dos campos: Quantidade Vagas e Vagas Disponíveis e retornaremos um erro para a oferta específica -

Status: ParcialVagasNaoAlteradas. Os demais campos enviados serão devidamente alterados.

8- Regras do cálculo de vagas disponíveis. Exemplo: O campo Quantidade de Vagas tem valor 50. Enviado o novo valor 60: Quantidade de Vagas ficará com 60 e Vagas Disponíveis terá o valor original acrescido de 10. Enviado o novo valor 40: Quantidade de Vagas ficará com 40 e Vagas Disponíveis terá o valor original subtraído em 10. Caso o novo número de vagas seja menor que a quantidade de candidatos já convocados para a oferta ou vagas disponíveis fique com valor negativo, não teremos alteração de dados e retornaremos um erro com status: ParcialVagasNaoAlteradas.

O não envio destes campos, impacta diretamente nos Modelos de Predição para Captação.

Possíveis retornos:

Exemplo de retorno:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status Code:	Result:
200	Status: \"Sucesso\",\"IdentificadorOferta\":\"91
200	Result (sem alteração de quantidade de vagas): \"[{\"Status\":\"ParcialVagasNaoAlteradas\",\"IdentificadorOferta\":\"91
200	Result (com alteração de quantidade de vagas): \"[{\"Status\":\"Sucesso\",\"IdentificadorOferta\":\"91
500	Message: \"Erro inesperado ao salvar dados: \" XXXXX

","urlObject":{"protocol":"https","path":["api","IntegracaoClientes","AtualizarOferta"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2039a83c-32af-46e4-bcd0-07053032a13c"},{"name":"Atualizar Vigência da Oferta","id":"4304a166-5a1a-4483-b663-698a68fead4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer IJjrtChsl8pPMeD8aFxleRojnBjwA7HGD2_tWSgdzduieIYy_zO605IFxheaoul4vagW6jJHqpVqmocey95B1lG8mqnFm6WBa5OyxW9GWnGQasYaNxHTIzjYJ2dIz-QWJ7a_7uIq2dbzoIzWpUDM7zshqHBRyEL6XQmcKr3H0d80HPf5uV4SAg5pAbNOyODsy6RcBm33U6rXbcoJNhP7DRRJLrJEsa8yO--eijr_MbTmye8HjEEaLgc8lPBoZscO","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"CodigoConcurso\": 999,\n \"CodigoCurso\": 25,\n \"DataInicial\": \"03/03/2020\",\n \"DataFinal\": \"03/05/2025\"\n}","options":{"raw":{"language":"json"}}},"url":"https://XXXapi.crmeducacional.com/api/AtualizarVigenciaOferta","description":"

Objetivos:

Realizar a alteração da vigência de uma determinada oferta.

Observação:

Atenção no campo CodigoCurso, se ele não está duplicado em ofertas do mesmo concurso, pois caso isso seja afirmativo, todas as ofertas com o mesmo CódigoCurso serão atualizadas

Parâmetro de Entrada

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório
Código do Concurso	INT	SIM
Código do Curso	INT	SIM
Data Inicial	DATETIME	SIM
Data Final	DATETIME	SIM
Token	STRING	SIM

Caso as propriedades hora, minuto e segundo do campo Data Final sejam iguais a 0, o serviço irá salvar no
CRM a data enviada com a hora 23:59:59, indicando que a oferta estará ativa até o fim do dia enviado. Caso o campo Data Final tenha valor diferente de 0 em alguma destas propriedades, o valor persistido no CRM será o recebido.

Retornos:

Campo	Descrição	Tipo
0	Oferta atualizada com sucesso.	INT
1	Concurso não encontrado.	INT
2	Oferta não encontrada.	INT
3	Erro ao atualizar as datas da oferta.	INT
4	Erro na conversão de dados.	INT
5	Erro genérico.	INT
6	Não foi possível atualizar as datas de todas as ofertas.	INT

","urlObject":{"protocol":"https","path":["api","AtualizarVigenciaOferta"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4304a166-5a1a-4483-b663-698a68fead4a"},{"name":"Decrementar Vagas Disponíveis SGA","id":"887e689f-700f-4ec5-9729-ced01fb72b47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"CXEL4wppSYaSdDan-Q7QTIuT8xfQk1BqypoirU9VOFm-EfyFZ_yWAwU5NkmafGJVf3v1N_pQ3FLEMr7vo8SkMU6xTYkJSSdtYrpSesoiJAiyn2cM5kjatyOFOIVBVYOfSWXZdhZmbTd9ENmZmKY-7_5uDT5ghktBY3-cCX5SzCn1G_3nuxo-x8bHyB-vpscHRa8MBMIvAZiAbwMYPLRgjwQa8TWsa78TVTQtAkkvfT35DGbpFaVmDdWX2xUlhhUL","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"Ano\": 2023,\n \"Periodo\": 2,\n \"CodCurriculo\": 2,\n \"CodCampus\": 2,\n \"CodTurno\": 2,\n \"CodConcursos\": [110],\n \"NumeroInscricao\":\"CAN-010542-DEV\"\n}","options":{"raw":{"language":"json"}}},"url":"https://XXXapi.crmeducacional.com/api/DecrementarVagasDisponiveis","description":"

Objetivo

O método tem como objetivo decrementar em 1 no CRM o número de vagas disponíveis para o SGA (cad_vagasdisponveissga) em determinada oferta. Após decrementar a vaga é gerado o log por inscrição

Parâmetros de Entrada

\n\n

Parâmetro	Tipo	Obrigatório
Ano	INT	SIM
Período	INT	SIM
Código do Currículo	INT	SIM
Código do Campus	INT	SIM
Código do Turno	INT	SIM
Token	STRING	SIM

\n\n

Mensagem de Retorno

\n\n

Situação	Retorno	Tipo
Sucesso	TRUE	BOOLEAN
Falha	FALSE	BOOLEAN

","urlObject":{"protocol":"https","path":["api","DecrementarVagasDisponiveis"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"887e689f-700f-4ec5-9729-ced01fb72b47"},{"name":"Incrementar Vagas Disponíveis SGA","id":"2c0cf5f2-d6e6-4e2a-9075-4c25d3b2e73f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"0pDqy7G9zeMwBnnpqGzyhPRBl59_3CCQeAWBRjyOIK5moZiciOsen9DxJLeQO-PFMiALJsDeS1T49QnZ_DNd-RY8z_D9DW4hidmE7xoWykkAhWx8hc98Rq2FbJHGpKEDK-i0-dje6YdEPI4VHEgLULPv388_cBqSxQKxZeVwJXoyyvI4muW4EyEo4SkaPvg_yqYNos0EosVcb7_cSCBKd5V7ThFlIBU4IjTCyiKVXTtLkoWMDIUSCqnb8kteUuqa","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"Ano\": 2023,\n \"Periodo\": 2,\n \"CodCurriculo\": 2,\n \"CodCampus\": 2,\n \"CodTurno\": 2,\n \"CodConcursos\": [110],\n \"NumeroInscricao\":\"CAN-010542-DEV\"\n}","options":{"raw":{"language":"json"}}},"url":"https://XXXapi.crmeducacional.com/api/IncrementarVagasDisponiveis","description":"

Objetivo

O método incrementa em 1 no CRM o número de vagas disponíveis para o SGA (cad_vagasdisponveissga) em determinada oferta. Após incrementar a vaga é gerado o log por inscrição.

Parâmetros de Entrada

\n\n

Parâmetro	Tipo	Obrigatório
Ano	INT	SIM
Período	INT	SIM
Código do Currículo	INT	SIM
Código do Campus	INT	SIM
Código do Turno	INT	SIM
Token	String	SIM

\n\n

Mensagem de Retorno

\n\n

Valor	Descrição	Tipo
TRUE	Vaga disponível incrementada corretamente.	BOOL
FALSE	Vaga disponível não foi incrementada corretamente.	BOOL

","urlObject":{"protocol":"https","path":["api","IncrementarVagasDisponiveis"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2c0cf5f2-d6e6-4e2a-9075-4c25d3b2e73f"},{"name":"Retorna Vagas Disponiveis SGA","id":"01c88f71-1b7e-49dc-8488-1388ee55ff4e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"CXEL4wppSYaSdDan-Q7QTIuT8xfQk1BqypoirU9VOFm-EfyFZ_yWAwU5NkmafGJVf3v1N_pQ3FLEMr7vo8SkMU6xTYkJSSdtYrpSesoiJAiyn2cM5kjatyOFOIVBVYOfSWXZdhZmbTd9ENmZmKY-7_5uDT5ghktBY3-cCX5SzCn1G_3nuxo-x8bHyB-vpscHRa8MBMIvAZiAbwMYPLRgjwQa8TWsa78TVTQtAkkvfT35DGbpFaVmDdWX2xUlhhUL","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"Ano\": 2021,\n \"Periodo\": 2,\n \"CodCurriculo\": 2,\n \"CodCampus\": 2,\n \"CodTurno\": 2,\n \"CodConcursos\": [30,10],\n \"NumeroInscricao\":\"123\"\n}","options":{"raw":{"language":"json"}}},"url":"https://XXXapi.crmeducacional.com/api/RetornaVagasDisponiveisSGA","description":"

Objetivo

StartFragment

Ao utilizar este método, a entidade oferta pode obter a quantidade de vagas SGA disponíveis. Isso permite que a instituição crie uma maneira para que os usuários possam pesquisar o número de vagas sem precisar
acessar o CRM. Além disso, usuários que não têm acesso ao cadastro de ofertas, mas realizam matrículas de alunos, também podem usar este método. Se a oferta não for encontrada, o resultado será \"-1\", caso
contrário, o número de vagas disponíveis será retornado.

Parâmetros de Entrada

\n\n

Parâmetro	Tipo	Obrigatório
Ano	INT	SIM
Período	INT	SIM
Código do Currículo	INT	SIM
Código do Campus	INT	SIM
Código do Turno	INT	SIM
Código do Concurso	ARRAY INT	SIM
Token	STRING	SIM

\n\n

Mensagem de Retorno

\n\n

Situação	Retorno	Tipo
Qtd de vagas disponíveis	Se não houver ofertas: (-1) / Se houver vagas: (n) -> sendo \"n\" o número de vagas disponíveis	INT

","urlObject":{"protocol":"https","path":["api","RetornaVagasDisponiveisSGA"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"01c88f71-1b7e-49dc-8488-1388ee55ff4e"}],"id":"8fa283c1-d5a3-43bc-bc00-4140845352c7","_postman_id":"8fa283c1-d5a3-43bc-bc00-4140845352c7","description":""},{"name":"Pagamentos","item":[{"name":"Recebe Pagamento SGA","id":"f362e243-47fe-487b-a6b1-d6f6c8c0ae6b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"NomePreco\": \"Pagamento-SGA\",\r\n \"Inscricao\": \"CAN-00000-CRM\",\r\n \"ValorPago\": 10.00,\r\n \"DataPagamento\": \"01/01/2021\",\r\n \"FormaPagamento\": \"BoletoBancario\",\r\n \"IdTransacao\": \"112233445566\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://XXXapi.crmeducacional.com/api/RecebePagamentoSGA","description":"

Objetivo

Esse método é responsável por criar um registro de pagamento para um candidato, usando os seguintes parâmetros: Nome do Preço, Número de Inscrição, Valor Pago, Data do Pagamento, Forma de Pagamento e ID da Transação. O método procura um preço correspondente no CRM e o associa ao pagamento que está sendo criado. Se algum desses parâmetros for inválido, o método retornará falso. Além disso, se o candidato já tiver um pagamento com a situação \"pago\", o método também retornará falso.

Parâmetros de Entrada

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Possíveis valores	Descrição	Tipo	Obrigatório
Nome do Preço			STRING	SIM
Número da Inscrição			STRING	SIM
Valor Pago			DECIMAL	SIM
Data do Pagamento		MM/DD/AAAA	DATETIME	SIM
Forma de Pagamento	0 1 2 3	BoletoBancario CartaoDeCredito CartaodeDebito Caixa	ENUMERATOR	SIM
ID da Transação			STRING	SIM
Token			STRING	SIM

Requisitos:

Inscrição do Candidato

Precisa estar \"Ativa\"

Mensagem de Retorno

\n\n

Situação	Retorno	Tipo
Sucesso	TRUE	BOOLEAN
Falha	FALSE	BOOLEAN

","urlObject":{"protocol":"https","path":["api","RecebePagamentoSGA"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f362e243-47fe-487b-a6b1-d6f6c8c0ae6b"}],"id":"1b53d902-619d-4ba8-923b-2d67f9181c59","_postman_id":"1b53d902-619d-4ba8-923b-2d67f9181c59","description":""},{"name":"Preço","item":[{"name":"Enviar Preço","id":"cdd63110-bad7-4435-9d0d-3192839cca90","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer exemplo","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"IdentificadorPreco\": \"PRC-23\",\n \"ConcursoCodigo\": 123,\n \"Nome\": \"Preço CRM Educacional\",\n \"Valor\": 1500.00,\n \"EstadoObjeto\": 1,\n \"DataInicio\": \"2025-07-17\",\n \"DataFim\": \"2025-12-31\",\n \"UtilizaIntegracao\": 1,\n \"OpcoesPagamento\": [\n {\n \"OpcoesPagamento\": \"pix\",\n \"NomePlano\": \"Plano PIX\",\n \"QuantidadeMaxParcelas\": 3,\n \"Parcelas\": [\n {\n \"Numero\": 1,\n \"Valor\": 1500.00\n },\n {\n \"Numero\": 2,\n \"Valor\": 750.00\n },\n {\n \"Numero\": 3,\n \"Valor\": 500.00\n }\n ]\n },\n {\n \"OpcoesPagamento\": \"boleto_bancario\",\n \"NomePlano\": \"Plano Boleto\",\n \"QuantidadeMaxParcelas\": 2,\n \"Parcelas\": [\n {\n \"Numero\": 1,\n \"Valor\": 1500.00\n },\n {\n \"Numero\": 2,\n \"Valor\": 1500.00\n }\n ]\n },\n {\n \"OpcoesPagamento\": \"cartao_credito\",\n \"NomePlano\": \"Cartão à Vista/Parcelado\",\n \"QuantidadeMaxParcelas\": 6,\n \"Parcelas\": [\n {\n \"Numero\": 1,\n \"Valor\": 1500.00,\n \"Juros\": 0.00\n },\n {\n \"Numero\": 2,\n \"Valor\": 775.00,\n \"Juros\": 25.00\n },\n {\n \"Numero\": 3,\n \"Valor\": 525.00,\n \"Juros\": 75.00\n }\n ]\n },\n {\n \"OpcoesPagamento\": \"cartao_credito_recorrente\",\n \"NomePlano\": \"Recorrência Cartão\",\n \"QuantidadeMaxParcelas\": 3,\n \"Parcelas\": [\n {\n \"Numero\": 1,\n \"Valor\": 500.00,\n \"Juros\": 0.00\n },\n {\n \"Numero\": 2,\n \"Valor\": 500.00,\n \"Juros\": 0.00\n },\n {\n \"Numero\": 3,\n \"Valor\": 500.00,\n \"Juros\": 0.00\n }\n ]\n },\n {\n \"OpcoesPagamento\": \"empenho\",\n \"NomePlano\": \"Empenho Público\",\n \"QuantidadeMaxParcelas\": 4,\n \"Parcelas\": [\n {\n \"Numero\": 1,\n \"Valor\": 375.00\n },\n {\n \"Numero\": 2,\n \"Valor\": 375.00\n },\n {\n \"Numero\": 3,\n \"Valor\": 375.00\n },\n {\n \"Numero\": 4,\n \"Valor\": 375.00\n }\n ]\n },\n {\n \"OpcoesPagamento\": \"transferencia\",\n \"NomePlano\": \"Transferência Bancária\",\n \"QuantidadeMaxParcelas\": 6,\n \"Parcelas\": [\n {\n \"Numero\": 1,\n \"Valor\": 250.00\n },\n {\n \"Numero\": 2,\n \"Valor\": 250.00\n },\n {\n \"Numero\": 3,\n \"Valor\": 250.00\n },\n {\n \"Numero\": 4,\n \"Valor\": 250.00\n },\n {\n \"Numero\": 5,\n \"Valor\": 250.00\n },\n {\n \"Numero\": 6,\n \"Valor\": 250.00\n }\n ]\n }\n ],\n \"Ofertas\": [\n \"oferta1\",\n \"oferta2\"\n ]\n}"},"url":"https://XXXapi.crmeducacional.com/api/IntegracaoClientes/EnviarPreco","description":"

Este endpoint recebe um objeto Preço completo (incluindo identificação, vigência, valor, meios de pagamento e ofertas) e cria ou atualiza um registro no Dynamics CRM.

Na inclusão, todos os campos obrigatórios devem ser informados.
\n
Na alteração, a busca é feita pelo IdentificadorPreco; só é permitido alterar vigência, status e plano, não o valor.
\n

Veja abaixo o JSON completo de requisição. Atenção especial aOpcoesPagamento, que deve seguir o enum:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Valor	Descrição
`pix`	Pagamento via PIX
`boleto_bancario`	Pagamento via Boleto Bancário
`cartao_credito`	Cartão de Crédito à vista/parcelado
`cartao_credito_recorrente`	Cartão de Crédito Recorrente
`empenho`	Empenho Público
`transferencia`	Transferência Bancária

Em cada objeto de pagamento:

NomePlano: rótulo do plano.
\n
QuantidadeMaxParcelas: número máximo de parcelas.
\n
Parcelas: array com exatamente esse número de itens; cada item:
\n
- Numero: índice (1..N)
  \n
- Valor: valor da parcela
  \n
- Juros: obrigatório apenas para cartões (cartao_credito e cartao_credito_recorrente)
  \n
\n

\n","urlObject":{"protocol":"https","path":["api","IntegracaoClientes","EnviarPreco"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"cdd63110-bad7-4435-9d0d-3192839cca90"}],"id":"091c041d-b0de-450c-8a46-fad6881193c5","_postman_id":"091c041d-b0de-450c-8a46-fad6881193c5","description":""},{"name":"Telefonema","item":[{"name":"Atualizar Telefonema","id":"2e47e26a-c4fa-4ba8-95ad-1a23413fd3d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"66f12cc3-e0a7-ed11-aad0-000d3a88f247\",\r\n \"Campos\": {\r\n \"subject\": \"Teste API\",\r\n \"cad_direcao\": true,\r\n \"cad_telefonemaimediatoevolux\": \"true\",\r\n \"crm_resultado_ligacaoid\":{ \r\n \"Valor\": \"c8aa59c2-cedd-ec11-bb3c-00224836cf94\",\r\n \"NomeLogico\": \"crm_resultado_ligacao\"\r\n \r\n //Esse valor é de um enumerator de dentro do CRM, na entidade Telefonemas.\r\n \r\n } \r\n }\r\n}"},"url":"https://XXXapi.crmeducacional.com/api/AtualizarTelefonema","description":"

Objetivo

A API de integração do CRM Educacional disponibiliza o método \"AtualizarTelefonema\", esse que recebe um ID referente a um telefonema no CRM e um dicionário de campos do telefonema para ser atualizado no CRM.

Para utilizar este método é necessário fazer uma requisição POST a URL passando os seguintes parâmetros serializados no BODY da requisição:

\"ID\": Código do Telefonema no CRM (STRING)
\"Campos\": Campos com seus respectivos nomes no CRM e valores a serem atualizados no CRM (Dicionário - Chave : Valor)
Além do \"access_token\" e \"token_type\" no cabeçalho de autorização da requisição (Veja aba \"Autenticar\" acima, para maiores detalhes) E do \"Content-Type\" \"application/x-www-form-urlencoded\" no cabeçalho da requisição.

O parâmetro \"Campos\" é um dicionário em que a chave representa o nome do campo no CRM e o valor representa a informação que será atualizada para este campo.

Os campos podem ser de diferentes tipos, por isso seguem as convenções adotadas para os envios:

O Parâmetro \"Campos\" deve utilizar as seguintes convenções para o envio dos campos :

Tipo de dados	Nome no CRM	Exemplo
String	Linha única de texto ou Várias linhas de texto	\"nome_do_campo_no_crm\": \"Teste\"
Boolean	Duas Opções	\"nome_do_campo_no_crm\": true
Object	Conjunto de Opções	\"nome_do_campo_no_crm\":{ \"valor\": 1}
Object	Campo Consulta	\"nome_do_campo_no_crm\":{ \"Id\": \"164801a1-e50f-eb11-a812-000d3ac1779c\", \"NomeLogico\": \"nome_logico_do_campo\"}
DateTime	Date e Hora ou Data	\"nome_do_campo_no_crm\": \"2016-10-07T00:00:00\"
Integer	Inteiro	\"nome_do_campo_no_crm\": 1
Decimal	Decimal	\"nome_do_campo_no_crm\": 1.0

\n\n

Os campos \"Object\" do tipo \"Conjunto de Opções\", devem ser enviados também como Chave e Valor, a string \"valor\" deve ser a chave e o valor deve conter o dado a ser enviado. Para esse tipo de campo, o dado a ser enviado será sempre o código (inteiro) de sua respectiva opção no CRM.

Já para os campo \"Object\" do tipo \"Campo Consulta\", é necessário enviar o Id da entidade (referente ao campo consulta) e também o nome lógico dessa entidade.

\n","urlObject":{"protocol":"https","path":["api","AtualizarTelefonema"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2e47e26a-c4fa-4ba8-95ad-1a23413fd3d6"},{"name":"Criar Telefonema","id":"48fe267e-794f-4227-98b3-ff0120978605","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"00000000-0000-0000-0000-000000000000\",\r\n \"Campos\": {\r\n \"subject\":\"Teste API\",\r\n \"cad_direcao\":true,\r\n\t \"cad_script\":\"Teste\",\r\n \"cad_filaprevista\":{\r\n \"Valor\": \"547aff20-d39b-eb11-b1ac-00224836b4d8\",\r\n \"NomeLogico\": \"queue\"\r\n },\r\n \"crm_resultado_ligacaoid\":{ \r\n \"Valor\": \"6ecaf726-d39b-eb11-b1ac-00224836b4d8\",\r\n \"NomeLogico\": \"crm_resultado_ligacao\"\r\n },\r\n \"crm_detalhe_ligacaoid\":{\r\n \"Valor\":\"7ecaf726-d39b-eb11-b1ac-00224836b4d8\",\r\n \"NomeLogico\": \"crm_detalhe_ligacao\"\r\n }\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://XXXapi.crmeducacional.com/api/CriarTelefonema","description":"

Objetivo

Criação de um telefonema no CRM, com status de concluído no CRM.

Para utilizar esse método é necessário realizar uma requisição do tipo POST, passando os seguintes parâmetros no BODY da requisição:

“ID”: Um valor de id do tipo GUID qualquer, recomendamos que seja o 00000000-0000-0000-0000-000000000000

“Campos”: Campos com seus respectivos nomes no CRM com os valores a serem adicionados no telefonema. Este” é um dicionário em que a chave representa o nome do campo no CRM e o valor representa a informação que será atualizada para este campo.

Os campos podem ser de diferentes tipos, por isso seguem as convenções adotadas para os envios:

Tipo de dados	Nome no CRM	Exemplo
String	Linha única de texto ou Várias linhas de texto	\"nome_do_campo_no_crm\": \"Teste\"
Boolean	Duas Opções	\"nome_do_campo_no_crm\": true
Object	Conjunto de Opções	\"nome_do_campo_no_crm\":{ \"Valor\": \"00000000-0000-0000-0000-000000000000\", \"NomeLogico\": \"NomeLogico\"}
DateTime	Date e Hora ou Data	\"nome_do_campo_no_crm\": \"2016-10-07T00:00:00\"
Integer	Inteiro	\"nome_do_campo_no_crm\": 1
Decimal	Decimal	\"nome_do_campo_no_crm\": 1.0

\n\n

Obervações:

Os valores aceitos para os campos do tipo Object, devem ser enviados com dois valores, sendo o primeiro o nome lógico do campo:

Ex: crm_resultado_ligacaoid

\n\n

O segundo é o valor do GUID e o Nome Lógico da da Entidade consulta que ele pertence. (Caso não conheça o nome da entidade, basta acessar configurações avançadas, depois clicar em personalizar, em seguida personalizar o sistema, expandir \"entidades\" no menu lateral esquedo e por fim clicar na entidade desejada, neste exemplo resultados do contato. Conforme abaixo:

\n\n

(Dica: Você pode consultar na URL do registro o nome da entidade e seu valor, para isso acesse o registro em questão e atente-se ao último parâmetro que compõe a URL)

\n\n

Ficando assim:

\"crm_resultado_ligacaoid\":{\"Valor\": \"c8aa59c2-cedd-ec11-bb3c-00224836cf94\",
\"NomeLogico\": \"crm_resultado_ligacao\" }

Sendo assim, neste exemplo, seria criado um telefonema em que o campo resultado da ligação (crm_resultado_ligacaoid) seria criado com o valor de um registro (GUID) da entidade resultado do contato (campo consulta). Conforme exemplo abaixo:

\n\n

Para os campos do tipo Boolean, o valor \"True\" que é passado logo após o nome lógico é para o valor definido como padrão no CRM:

\n\n

Retornos:

Caso a requisição seja um sucesso, terá a seguinte mensagem de retorno:

\"Telefonema criado com sucesso.\".

Caso a requisição falhe:

\"Erro ao criar o Telefonema, verifique se os valores dos campos enviados estão de acordo com a documentação.\"

\n","urlObject":{"protocol":"https","path":["api","CriarTelefonema"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"48fe267e-794f-4227-98b3-ff0120978605"}],"id":"8aee31e5-8538-4ee5-b41b-9672270e7926","_postman_id":"8aee31e5-8538-4ee5-b41b-9672270e7926","description":""},{"name":"Consultor","item":[{"name":"Enviar Consultor","id":"0482e5b5-7c8f-4847-912b-b11fd0c70481","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Codigo\": \"1\",\r\n \"Nome\": \"Consultor CRM Educacional\",\r\n \"ClasseConsultor\" : {\r\n \"Nome\": \"CRM Educacional\",\r\n \"TipoPessoa\": \"Fisica\",\r\n \"Prioridade\": 1,\r\n \"IdentificadorClasse\": \"Classe\"\r\n },\r\n \"Status\": \"Ativo\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://XXXapi.crmeducacional.com/api/IntegracaoClientes/EnviarConsultor","description":"

Objetivos:

Esta API tem como objetivo possibilitar a criação e atualização de Consultores.

Requisitos:

Os parâmetros de Codigo, Nome, ClasseConsultor (Nome e TipoPessoa) e Status são obrigatórios dentro do corpo da requisição.

O parâmetro TipoPessoa aceita apenas os valores \"Fisica\" e \"Juridica\".

O parâmetro Status aceita apenas os valores \"Ativo\" ou \"Inativo\".

Funcionamento:

Durante a execução da API, é realizado uma consulta para identificar se existe um Consultor com o mesmo Identificador da Classe informado no corpo da requisição, caso exista, é atualizado com as informações enviadas, se não, é realizado a criação de um novo.

Observações:

No processamento, é realizado uma consulta para ver se já existe uma \"Classe de Consultor\" com o mesmo nome da enviada no corpo da requisição. Caso exista, é utilizada a mesma para o vínculo no consultor.

Não é realizado atualização da \"Classe do Consultor\"

\n","urlObject":{"protocol":"https","path":["api","IntegracaoClientes","EnviarConsultor"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0482e5b5-7c8f-4847-912b-b11fd0c70481"}],"id":"57d540bd-6d1a-4f56-b363-fd8d4eae9240","_postman_id":"57d540bd-6d1a-4f56-b363-fd8d4eae9240","description":""},{"name":"Formulário de Orientação Vocacional","item":[{"name":"Integração com formulário de orientação vocacional","id":"2e1835d7-c9d9-48fa-95b9-46800a96242a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"nomeCompleto\": \"Exemplo\",\r\n \"email\": \"exemplo@exemplo.com\",\r\n \"cpf\": \"000.000.000-00\",\r\n \"dataNascimento\": \"00/00/0000\",\r\n \"sexo\": \"Masculino\",\r\n \"cidade\": \"Exemplo\",\r\n \"estado\": \"Exemplo\",\r\n \"telefone\": \"(00)00000-0000\",\r\n \"grauInstrucao\": \"Exemplo\",\r\n \"classificacaoGrau\": \"Exemplo\",\r\n \"perfilPrimario\": \"Exemplo\",\r\n \"perfilSecundario\": \"Exemplo\",\r\n \"classificacaoLead\": \"Exemplo\",\r\n \"cursoSugerido\": \"Exemplo\",\r\n \"cursoUmSelecionado\": \"Exemplo\",\r\n \"cursoDoisSelecionado\": \"Exemplo\",\r\n \"nomeCampanha\": \"Nome Campanha\",\r\n \"origemCampanha\": \"Origem Campanha\",\r\n \"conteudoCampanha\": \"Conteudo Campanha\",\r\n \"termoCampanha\": \"Termo da Campanha\",\r\n \"midiaCampanha\": \"Novo da Campanha\",\r\n \"identificadorServicoEducacional\" : \"CRM\"\r\n}"},"url":"https://XXXapi.crmeducacional.com/api/IntegracaoOrientacaoVocacional/SalvarDados","description":"

Integração com formulário de orientação vocacional

Objetivo

O objetivo desta integração é permitir gravar as informações coletadas do Lead em formulários de orientação vocacional para dentro do CRM.

Os campos modificados nesta integração são:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Nome Lógico	Nome do Campo Correspondente no CRM	Tipo
cad_grau_instrucaoov	Grau Instrução Orientação Vocacional	String
cad_classificacao_grau_instrucaoov	Classificação Orientação Vocacional	String
cad_cursoum_selecionadoov	Primeira Opção Curso Orientação Vocacional	String
cad_cursodois_selecionadoov	Segunda Opção Curso Orientação Vocacional	String
cad_perfil_primarioov	Perfil Primário Orientação Vocacional	String
cad_perfil_secundarioov	Perfil Secundário Orientação Vocacional	String
cad_temperaturaov	Classificação LEAD Orientação Vocacional	String
cad_curso_sugeridoov	Curso Sugerido Orientação Vocacional	String
cad_campaignname	Nome da Campanha	String
cad_campaigncontent	Conteúdo da Campanha	String
cad_campaignterm	Termo da Campanha	String
cad_campaignmedium	Mídia da Campanha	String
cad_campaignsource	Origem da Campanha	String
cad_servicoeducacionalinboundmarketing	Serviço Educacional Inbound Marketing	String

Observações

Caso seja informado um EMAIL inexistente na base, o Lead será criado com os dados enviados.
\n
Caso seja informado um EMAIL já existente na base o Lead será encontrado pelo e-mail e SOMENTE as informações de ORIENTAÇÃO VOCACIONAL serão atualizadas.
\n
Todos os campos que exigem algum tipo de validação serão verificados segundo as regras da Ficha de Inscrição, caso não atendam aos requisitos não serão salvos e será gerado um log informativo.
\n
O campo \"identificadorServicoEducacional\" irá buscar um serviço educacional pelo campo \"Identificador Bearings\" dentro do CRM, caso não encontre um serviço com o identificador enviado, o campo não será salvo, mas caso encontre a informação será registrada no campo \"Serviço Educacional Inbound Marketing\"(cad_servicoeducacionalinboundmarketing).
\n
Casos estes campos estejam já preenchidos no lead, os mesmos não serão atualizados.
\n

\n","urlObject":{"protocol":"https","path":["api","IntegracaoOrientacaoVocacional","SalvarDados"],"host":["XXXapi","crmeducacional","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2e1835d7-c9d9-48fa-95b9-46800a96242a"}],"id":"f94329cc-f0ef-4922-88c1-edfaad9796c2","_postman_id":"f94329cc-f0ef-4922-88c1-edfaad9796c2","description":""}]}