Skip to content

Fundacred - OpenApi Specification (1.1)

Documentação para a API renewal-api

Download OpenAPI description
Overview
Infra Fundacred
Languages
Servers
Mock server
https://docs.fundacred.org.br/_mock/renewal-api/
TST
https://tst-api.fundacred.org.br/renewal-api/
HML
https://hml-api.fundacred.org.br/renewal-api/
PRD
https://api.fundacred.org.br/renewal-api/

[V3] Mais Ações

Ações executadas na jornada do estudante

Operations

[V2] VALORES

Operations

[V2] PLANILHAS AUXILIARES

Operations

[V2] MANUTENÇÃO DE VÍNCULO

Operations

[V2] DASHBOARD

Operations

[V2] MATRICULA

Resource para a manipulação da situação da matrícula

Operations

[V2] MAIS AÇÕES

Operations

[V2] JORNADAS

Operations

[V2] TIMELINE

Operations

[V2] NOTIFICAÇÕES

Operations

[V2] NOTIFICAÇÕES IEs

[V1] VALORES

Operations

[V1] TASKS

Operations

[V1] MATRICULA

Resource para a manipulação da situação da matrícula

Operations

[V1] + AÇÕES

Operations

[V1] INCLUIR NA JORNADA

Resource para a manipulação de beneficiarios para inserir nas jornadas

Operations

get_2

Request

Listar beneficiarios disponiveis para inserir na jornada

Security
bearerAuth
Query
paramstringrequired

Parametro de pesquisa (Nome/CPF)

idRenovacaointeger(int64)required

ID da jornada renovação para filtrar beneficiarios

curl -i -X GET \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/v1/insere-jornada?param=string&idRenovacao=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Sucesso ao listar beneficiarios

Body*/*Array [
cpfstring
nomestring
bolsastring
idBolsainteger(int64)
idProcessointeger(int64)
formaturaVencidastring
]

insertInJourney

Request

Incluir beneficiario jornada

Security
bearerAuth
Bodyapplication/jsonrequired
idBolsainteger(int64)
idProcessointeger(int64)
anointeger(int32)
semestreinteger(int32)
novaDataFormaturaobject(GraduationDateInDto)

Dados para atualização de previsão de formatura

curl -i -X POST \
  https://docs.fundacred.org.br/_mock/renewal-api/s/v1/insere-jornada \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "idBolsa": 0,
    "idProcesso": 0,
    "ano": 0,
    "semestre": 0,
    "novaDataFormatura": {
      "month": "string",
      "year": "string",
      "brbId": 0,
      "valores": {
        "brbId": 0,
        "nomeEstudante": "string",
        "qtdParcelasCobertura": 0,
        "qtdCreditos": 0,
        "valorContrato": 0,
        "valorCtrPrestServico": 0,
        "percentualConcedido": 0.1,
        "parcMeses": "string",
        "idCurso": 0,
        "regimeContrato": "string",
        "contratoAnual": "string",
        "motivoReenvio": "string",
        "motivo": "string",
        "serieSemestre": "string"
      }
    }
  }'

Responses

Sucesso ao incluir beneficiario

Body*/*
brbIdinteger(int64)
incluidoJornadaboolean
novaFormaturaEnviadaboolean

[V1] DASHBOARD

Resource para a consulta de dados do Dashboard

update-controller

Operations

contract-status-controller

Operations

locking-enrollment-controller

Operations

user-ies-notifications-controller

Operations

[V2] Notificações IEs

Operations

enrollment-status-controller

Operations

[V1] convenios

Operations

dashboard-controller

Operations

[V3] API EXTERNA

Operations

[V3] Renovação

Operations

[V3] Estudantes

Operations

[V1] api-externa

Operations

contract-fill-values-controller

Operations