NAV -image
bash javascript

Introduction

Esta é uma API para integração com SESuite Recife.

Documentação para integração referente ao Processo de Crédito Popular da Prefeitura do Recife.


Este documento tem por objetivo definir as especificações e critérios técnicos necessários para a integração de sistemas de informação diversos com o SoftExpert Excellence Suite (SE Suite).

Base URL

http://microcredito.suportegerencial.com.br

Authenticating requests

This API is not authenticated.

Endpoints

api/microcredito/create

Example request:

curl -X POST \
    "http://microcredito.suportegerencial.com.br/api/microcredito/create" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"consusodados":1,"nmsolicitante":"Nome do Solicitante","cpf":"000.000.000-00","relmcrgenero":1,"datanascimento":"1969-12-31","email":"[email protected]","relmcrescolaridade":5,"rendaim":"2000.00","telefone":"(81) 0000-0000","celular":"(81) 90000-0000","cadunico":2,"auxemergencial":1,"cepresidencial":"00000-000","logradourores":"Rua lorem ipsum","numerores":"12A","bairrores":"Boa Viagem","cidaderes":"Recife","ufres":"PE","complementores":"complemento","nmnegocio":"Nome do Neg\u00f3cio","cnpj":"00.000.0000001-00","fatmnegocio":"8000.00","tempoativ":"10 anos","relmcrcategoria":2,"relmcrsetorecon":1,"outsetorecon":"\"\"","relmcracessoc":0,"outacessocred":"\"\"","relmcrobjcred":3,"outobjcred":"\"\"","relmcrcursoemp":0,"outcursoemp":"\"\"","endfixonegocio":1,"cepnegocio":"58000-000","logradouroneg":"Rua da Localiza\u00e7\u00e3o do Neg\u00f3cio","numeroneg":"10","bairronegocio":"Espinheiro","cidadenegocio":"Recife","ufnegocio":"PE","complementoneg":"\"\"","anexos":[{"filename":"Comprovante de Residencia","filetype":"pdf","base64content":"asdtasdb6tdastdas78dtyas"},{"filetype":"pdf","base64content":"asdtasdb6tdastdas78dtyas"}]}'

const url = new URL(
    "http://microcredito.suportegerencial.com.br/api/microcredito/create"
);

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

let body = {
    "consusodados": 1,
    "nmsolicitante": "Nome do Solicitante",
    "cpf": "000.000.000-00",
    "relmcrgenero": 1,
    "datanascimento": "1969-12-31",
    "email": "[email protected]",
    "relmcrescolaridade": 5,
    "rendaim": "2000.00",
    "telefone": "(81) 0000-0000",
    "celular": "(81) 90000-0000",
    "cadunico": 2,
    "auxemergencial": 1,
    "cepresidencial": "00000-000",
    "logradourores": "Rua lorem ipsum",
    "numerores": "12A",
    "bairrores": "Boa Viagem",
    "cidaderes": "Recife",
    "ufres": "PE",
    "complementores": "complemento",
    "nmnegocio": "Nome do Negócio",
    "cnpj": "00.000.000/0001-00",
    "fatmnegocio": "8000.00",
    "tempoativ": "10 anos",
    "relmcrcategoria": 2,
    "relmcrsetorecon": 1,
    "outsetorecon": "",
    "relmcracessoc": 0,
    "outacessocred": "",
    "relmcrobjcred": 3,
    "outobjcred": "",
    "relmcrcursoemp": 0,
    "outcursoemp": "",
    "endfixonegocio": 0,
    "cepnegocio": "58000-000",
    "logradouroneg": "Rua da Localização do Negócio",
    "numeroneg": "10",
    "bairronegocio": "Espinheiro",
    "cidadenegocio": "Recife",
    "ufnegocio": "PE",
    "complementoneg": "",
    "anexos": [
        {
            "filename": "Comprovante de Residência",
            "filetype": "pdf",
            "base64content": "asdtasdb6tdastdas78dtyas"
        }
    ]
}

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

Example response (200, success):

{
    "Status": "SUCCESS",
    "Code": 1,
    "Detail": "Workflow iniciado com sucesso",
    "RecordKey": "0001",
    "RecordID": "000001"
}

Request   

POST api/microcredito/create

Body Parameters

consusodados  integer  
Consentimento de uso de dados. [1 = Aceito; 2 = Não Aceito].

nmsolicitante  string  
Nome completo do solicitante.

cpf  string optional  
CPF do solicitante.

relmcrgenero  integer optional  
Gênero do solicitante. [1 = Masculino; 2 = Feminino; 3 = Outro; 4 = Prefiro não informar]

datanascimento  string optional  
Data de nascimento do solicitante. Formato 'yyyy-MM-dd'

email  string optional  
E-mail do solicitante.

relmcrescolaridade  integer optional  
Escolaridade do solicitante. [1 = Analfabeto; 2 = Até 4ª Série do Ensino Fundamental; 3 = Da 5ª à 8ª Série do Ensino Fundamental; 4 = Ensino Médio Incompleto; 5 = Ensino Médio Completo; 6 = Ensino Superior Incompleto; 7 = Ensino Superior Completo; 8 = Pós-graduação (Mestrado, Doutorado) Incompleto; 9 = Pós-graduação (Mestrado, Doutorado) Completo]

rendaim  numeric optional  
Renda Individual Mensal do solicitante.

telefone  string optional  
Telefone do solicitante.

celular  string optional  
Celular do solicitante.

cadunico  integer optional  
Se o Solicitante possui cadastro no CadÚnico. [2 = Não sabe; 1 = sim; 0 = não].

auxemergencial  integer optional  
Se o solicitante é beneficiário do Auxílio Emergencial. [1 = sim; 0 = não].

cepresidencial  string optional  
CEP residencial do solicitante.

logradourores  string optional  
logradouro residencial do solicitante.

numerores  string optional  
Número residencial do solicitante.

bairrores  string optional  
Bairro residencial do solicitante.

cidaderes  string optional  
Cidade residencial do solicitante.

ufres  string optional  
UF residencial do solicitante.

complementores  string optional  
Complemento residencial do solicitante.

nmnegocio  string optional  
Nome do Negócio.

cnpj  string optional  
CNPJ do Negócio.

fatmnegocio  numeric optional  
Faturamento mensal do negócio.

tempoativ  string optional  
Tempo de atividade do negócio em anos.

relmcrcategoria  integer optional  
Categoria do Negócio. [1 = Potencial Empreendedor (não iniciou a atividade); 2 = Empreendedor (atividade informal); 3 = Micro Empreendedor Individual (MEI); 4 = Microempresário; 5 = Empresário de Pequena Empresa]

relmcrsetorecon  integer optional  
Setor Econômico do Negócio. [1 = Alimentos e Bebidas; 2 = Confecção; 3 = Economia Criativa; 4 = Eventos; 5 = Serviços; 6 = Outro].

outsetorecon  string optional  
Outro Setor Econômico do Negócio, para o caso de Outro deve-se informar qual.

relmcracessoc  integer optional  
Se o solicitante já teve acesso a crédito. [1 = Sim. Banco do Brasil; 2 = sim. Sim. Banco do Nordeste; 3 = Sim. Caixa Econômica; 4 = Sim. Outro Banco; 0 = Não].

outacessocred  string optional  
Outro banco que concedeu acesso a crédito para o caso de 'Sim, outro banco'.

relmcrobjcred  integer optional  
Objetivo do Crédito. [1 = Investimento em Equipamentos e Utensílios; 2 = Capital de Giro; 3 = Contratação de Trabalhadores; 4 = Pagamento de Dívidas; 5 = Outro].

outobjcred  string optional  
Outro Objetivo do Crédito, para o caso de 'Outro'.

relmcrcursoemp  integer optional  
Se o solicitante já realizou algum curso direcionado para empreendedorismo. [1 = Sim. SEBRAE; 2 = Sim. Outro; 0 = Não].

outcursoemp  string optional  
Outro local onde o solicitante realizou o curso.

endfixonegocio  integer optional  
Se o negócio possui endereço fixo. [1 = Sim; 0 = Não].

cepnegocio  string optional  
CEP do endereço do Negócio.

logradouroneg  string optional  
Logradouro do endereço do Negócio.

numeroneg  string optional  
Número do endereço do Negócio.

bairronegocio  string optional  
Bairro do endereço do Negócio.

cidadenegocio  string optional  
Cidade do endereço do Negócio.

ufnegocio  string optional  
UF do endereço do Negócio.

complementoneg  string optional  
Complemento do endereço do Negócio.

anexos  object[] optional  
Anexos referentes a solicitação.

anexos[].filename  string optional  
Nome do arquivo.

anexos[].filetype  string optional  
Extensão do arquivo. (png; jpeg; pdf; doc; xls; etc)

anexos[].base64content  string optional  
Arquivo convertido em base64.

api/microcredito/edit-status

Example request:

curl -X POST \
    "http://microcredito.suportegerencial.com.br/api/microcredito/edit-status" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"idprocesso":"000001","status":"Em an\u00e1lise"}'

const url = new URL(
    "http://microcredito.suportegerencial.com.br/api/microcredito/edit-status"
);

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

let body = {
    "idprocesso": "000001",
    "status": "Em an\u00e1lise"
}

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

Example response (200, success):

{
    "Status": "SUCCESS",
    "Code": 1,
    "Detail": "O status do processo:000001 foi atualizado para: Em análise"
}

Example response (404, process not found):

{
    "Status": "ERROR",
    "Code": 2,
    "Detail": "O ID do processo:000001 não foi encontrado."
}

Request   

POST api/microcredito/edit-status

Body Parameters

idprocesso  string  
Identificador do Processo cujo status será atualizado.

status  string  
Novo status do processo.

api/microcredito/status

Example request:

curl -X GET \
    -G "http://microcredito.suportegerencial.com.br/api/microcredito/status" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"idprocesso":"000001"}'

const url = new URL(
    "http://microcredito.suportegerencial.com.br/api/microcredito/status"
);

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

let body = {
    "idprocesso": "000001"
}

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

Example response (200, success):

{
    "Status": "SUCCESS",
    "Code": 1,
    "statusProcesso": "Em análise"
}

Example response (404, process not found):

{
    "Status": "ERROR",
    "Code": 2,
    "Detail": "O ID do processo:000001 não foi encontrado."
}

Request   

GET api/microcredito/status

Body Parameters

idprocesso  string  
Identificador do Processo cujo status está buscando.

api/microcredito/getoptions

Example request:

curl -X GET \
    -G "http://microcredito.suportegerencial.com.br/api/microcredito/getoptions" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"lista":"relmcrgenero"}'

const url = new URL(
    "http://microcredito.suportegerencial.com.br/api/microcredito/getoptions"
);

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

let body = {
    "lista": "relmcrgenero"
}

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

Example response (200, success):


{
     "Status":"SUCCESS",
     "Code":1,
     "list":[
         "1":"Masculino",
         "2":"Feminino",
         "3":"Outro",
         "4":"Prefiro não Responder"
     ]
}

Example response (404, list not found):

{
    "Status": "ERROR",
    "Code": 2,
    "notice": "A lista: relmcrgenero não foi encontrada."
}

Request   

GET api/microcredito/getoptions

Body Parameters

lista  string  
Identificador da lista que está buscando. [relmcrgenero = Gênero; relmcrescolaridade = Escolaridade; relmcrcategoria = Categoria; relmcracessocred = Acesso a Crédito; relmcrcursoemp = Curso Empreendedorismo; relmcrobjcred = Objetivo Crédito; relmcrsetorecon = Setor Econômico]

bash javascript