Advanced Search
Search Results
33 total results found
API Parceiros
Bem-vindo à documentação da API de integração com o sistema Crefaz On.A API do Crefaz On pode ser utilizada para o envio e acompanhamento de propostas.A integração com a API é gratuita! Não cobramos taxas ou mensalidades por sua utilização. Atuamos dessa forma...
Automação - Processo de cancelamento
Introdução a API
Autenticação
A API utiliza autenticação através de uma chave de API (apiKey) e credenciais do usuário (login e senha). A apiKey é um requisito fundamental para garantir a segurança das operações e deve ser solicitada ao Supervisor ou Gerente Comercial da empresa. Após a so...
Contexto
Este sistema disponibiliza diversas rotas para acesso a informações relacionadas ao contexto de ocupação, propostas e grau de instrução.
Endereço
Proposta
Contexto
Referência da API Nosso API segue as melhores práticas de integração para uma API RESTful. Todas as requisições que envolvem dados dos usuários devem ser autenticadas com OAuth2. Tokens fornecidos via autenticação OAuth2 possuem validade de 3 horas e devem ...
POST Autenticação - Obtendo token
Introdução A rota permite a autenticação de usuários e retorna um token do tipo bearer, que deve ser utilizado nas demais requisições à API para garantir a segurança e a autenticidade do acesso. Rota /Usuario/login Authorization É necessário um toke...
Informações de Contexto
Contexto Este documento fornece informações sobre as rotas disponíveis para acessar dados relacionados ao contexto de ocupação, propostas e grau de instrução. Rotas Disponíveis [GET] Contexto/OcupacaoLista todas as ocupações disponíveis no contexto. ...
GET Listar Contexto Ocupação
Introdução Retorna uma lista com diversas opções de ocupação, que podem ser utilizadas na proposta. Rota /Contexto/ocupacao Authorization É necessário um token de autorização do tipo Bearer Token. O token deve ser fornecido da seguinte forma: Tok...
GET Listar Contexto Proposta
Introdução Retorna uma lista com diversas opções e diferentes contextos, que podem ser utilizadas na proposta. Rota /Contexto/proposta Authorization É necessário um token de autorização do tipo Bearer Token. O token deve ser fornecido da seguinte forma:...
GET Listar Contexto Grau Instrução
Introdução Retorna uma lista com diversas opções de grau de instrução, que podem ser utilizadas na proposta. Rota /Contexto/grau-instrucao Authorization É necessário um token de autorização do tipo Bearer Token. O token deve ser fornecido da seguinte fo...
Informações de Endereço
Endereço Esta seção descreve as rotas disponíveis para consultar informações sobre endereços. Rotas Disponíveis [POST] Endereco/CidadeLista todas as ocupações disponíveis no contexto. [GET] Endereco/PaisLista as propostas relacionadas ao contexto.
POST Consultar Cidade
Introdução Retorna os dados de uma determinada cidade/UF informada. Rota /Endereco/Cidade Authorization É necessário um token de autorização do tipo Bearer Token. O token deve ser fornecido da seguinte forma: Token eyJ... Headers Request ...
GET Listar Países
Introdução Retorna uma listagem de países e alguns parâmetros relacionados. Rota /Endereco/Pais Authorization É necessário um token de autorização do tipo Bearer Token. O token deve ser fornecido da seguinte forma: Token eyJ... Header...
Informações da Proposta
Proposta Este documento fornece informações sobre as rotas disponíveis para acessar dados relacionados ao contexto de ocupação, propostas e grau de instrução. Rotas Disponíveis [GET] /Proposta/produtos-regiao/:codCidadeIBGE Consulta a disponibilidade...
GET Consultar Disponibilidade Produto
Introdução Retorna uma lista de produtos disponíveis a partir da cidade consultada, informada através do parâmetro "codCidadeIBGECliente". Rota /Proposta/produtos-regiao/:codCidadeIBGE Authorization É necessário um token de autorização do tipo Bearer To...
POST Cadastrar Proposta
Introdução Cadastra uma nova proposta e aciona o motor de crédito. Rota /Proposta Authorization Token eyJ... Headers Request Accept: application/json Content-Type application/json Detalhes da API Campos obrigatórios e...
POST Consultar proposta em andamento
Introdução Cadastra uma nova proposta e aciona o motor de crédito. Rota /Proposta/proposta-em-andamento?cpf={{cliente_cpf}}&loginVendedor={{login}} Authorization Token eyJ... Headers Request Accept application/json Content-Typ...
GET Listar Ofertas
Introdução Retorna uma lista de produtos ofertados para a proposta, juntamente com os valores disponíveis e algumas informações adicionais, necessárias em rotas posteriores. Rota /Proposta/oferta-produto/:propostaId Authorization Token eyJ... ...
POST Calcular Vencimento
Introdução Retorna o vencimento previsto da primeira cobrança para o cliente. Rota /Proposta/calculo-vencimento Authorization Token eyJ... Headers Request Accept application/json Content-Type application/json Detalhes ...
POST Consultar Valor Limite
Introdução Retorna o valor limite que pode ser solicitado e o valor máximo das parcelas. Rota /Proposta/consulta-valor-limite/:propostaId Authorization Token eyJ... Headers Request Accept application/json Content-Type applica...
POST Simular Oferta
Introdução Retorna as opções disponíveis de quantidade de parcelas e valor das respectivas parcelas, com base no valor solicitado. Rota /Proposta/simulacao-valor/:propostaId Authorization Token eyJ... Headers Request Accept applica...
PUT Selecionar Oferta
Introdução Seleciona a oferta de acordo com os parâmetros fornecidos. Rota /Proposta/oferta-produto/:propostaId Authorization Token eyJ... Headers Request Accept application/json Content-Type application/json Detalhes ...
POST Listar Tipos Anexos
Introdução Retorna uma lista contendo os documentos que devem/podem ser enviados, de acordo com o produto selecionado. Rota /Proposta/tipo-anexos Authorization Token eyJ... Headers Request Accept application/json Content-Type ...
PUT Efetuar Upload Arquivos
Introdução Efetua o upload de arquivos em Base64. É necessário utilizar o prefixo "data:image/png;base64," antes do encoded Base64. É necessário efetuar o upload de apenas um arquivo por chamada Rota /Proposta/:propostaId/imagem Authorization ...