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

markViewed

Request

Security
bearerAuth
Path
id-notificacaointeger(int64)required
curl -i -X POST \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/v2/ies/notificacoes/{id-notificacao}/visualizada' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Body*/*
boolean

getHistory

Request

Security
bearerAuth
curl -i -X GET \
  https://docs.fundacred.org.br/_mock/renewal-api/s/v2/ies/notificacoes/historico \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Body*/*Array [
idinteger(int64)
pathstring
emailstring
idNotificacaointeger(int64)
descricaostring
textostring
idUsuarioIesinteger(int64)
grbIdinteger(int64)
perfilstring
primeiroNomestring
fechadoModalstring
Enum"S""N"
visualizadostring
Enum"S""N"
dataNotstring(date-time)
dataInclusaostring(date-time)
dataUltAlteracaostring(date-time)
idModulointeger(int64)
modulostring
idProdutointeger(int64)
produtostring
]

[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