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

batchImport_1

Request

Importar planilha para preenchimento de valores de contrato

Security
bearerAuth
Bodyapplication/jsonrequired
filestring(binary)

Arquivo CSV

curl -i -X POST \
  https://docs.fundacred.org.br/_mock/renewal-api/s/v1/contrato/valores/importar-lote \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "file": "string"
  }'

Responses

Sucesso ao importar CSV

Body*/*
registrosComSucessointeger(int64)
registrosComErrointeger(int64)
registrosPendentesinteger(int64)
errostring
linhasComErroArray of strings
linhasPendenteFundacredArray of strings
loteinteger(int64)

getComplimentaryData

Request

Buscar dados complementares para compor a planilha

Security
bearerAuth
Bodyapplication/jsonrequired
dataArray of objects(StudentshipCourseDto)
curl -i -X POST \
  https://docs.fundacred.org.br/_mock/renewal-api/s/v1/contrato/valores/dados-complementares \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "data": [
      {
        "cod_bolsa": 0,
        "cod_curso": "string"
      }
    ]
  }'

Responses

Sucesso ao buscar daos

Body*/*
dataArray of objects(ComplimentaryDataOutDto)

[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

[V3] Estudantes

Operations

[V1] api-externa

Operations

contract-fill-values-controller

Operations