Skip to content

Fundacred - OpenApi Specification (1.1)

Documentação para a API renewal-api

Download OpenAPI description
renewal-api.json
renewal-api.yaml
Overview
Infra Fundacred
infra@fundacred.org.br
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

[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

Listar jornada de renovação por filtros

Request

Security
bearerAuth
Query
yearinteger(int32)required

Ano da renovação

Example: year=2025
periodinteger(int32)required

Semestre da renovação (1 ou 2)

Example: period=2
studentshipIdstring

Lista de BOL_ID

Example: studentshipId=1&studentshipId=3&studentshipId=5
instIdstring

Lista de INST_ID

Example: instId=13&instId=45&instId=54
studentshipGroupIdstring

Lista de GRUPO_IES_ID

Example: studentshipGroupId=10&studentshipGroupId=11
curl -i -X GET \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/v3/renovacao/journey?year=2025&period=2&studentshipId=1%2C3%2C5&instId=13%2C45%2C54&studentshipGroupId=10%2C11' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Lista obtida com sucesso

Body*/*Array [
idRenovacaointeger(int64)
yearinteger(int32)
periodinteger(int32)
contractTypestring
renewDescstring
aptosinteger(int64)
emProcessamentointeger(int64)
finalizadosinteger(int64)
semRenovacaointeger(int64)
]

Listar carrossel de renovação

Request

Security
bearerAuth
Query
bolIdstring

Lista de BOL_ID. Ex.: [1,3,5]

Example: bolId=1&bolId=3&bolId=5
groupIesIdstring

Lista de GRUPO_IES_ID. Ex.: [10,11]

Example: groupIesId=10&groupIesId=11
instIdstring

Lista de INST_ID. Ex.: [13,45,54]

Example: instId=13&instId=45&instId=54
yearinteger(int32)

Ano da renovação

Example: year=2025
semesterinteger(int32)

Semestre da renovação (1 ou 2)

Example: semester=2
curl -i -X GET \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/v3/renovacao/carousel?bolId=1%2C3%2C5&groupIesId=10%2C11&instId=13%2C45%2C54&year=2025&semester=2' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Lista obtida com sucesso

Body*/*Array [
renewalYearinteger(int32)
renewalSemesterinteger(int32)
aptosinteger(int64)
emProcessamentointeger(int64)
finalizadosinteger(int64)
semRenovacaointeger(int64)
]

[V3] Estudantes

Operations

[V1] api-externa

Operations

contract-fill-values-controller

Operations