Schools v2

This request provides a detailed list of schools where the EdTech has established links, along with basic school data and datasets, attributes that will be sent and whether they will be sent in a minimized format or not.

By using this API, the application can always ensure that it has the most up-to-date information on the schools it can synchronize data with. Additionally, EdTechs can use this API to automate the registration of schools in their internal systems, making the process more efficient and streamlined.

The main details of the schools that have authorized the requesting EdTech appear listed school by school in the API response.

One of the key properties is the org_id, which allows for data requests to be made for each individual school, thus enabling automation of the integration flow in the following order:

Request the list of schools API Schools /data/schools
Based on the org_id of each school, request data updates via the API Data data/{org_id}
Perform the data integration EdTech Integration

Config
Along with the data for each school, some settings are also returned, indicating the list of periods (terms), list of sections (sections), and the permissions that the school has granted for personal data (users_info).

Return structure

[
    {
        "name": "Educacional Demo",
        "org_id": "ab7d6b89-e6c9-4466-b923-c957328a8916",
        "sin_number": "51885242000140",
        "update_at": "2022-01-07 14:23:05",
        "address": {
            "zip": "81200-100",
            "city": "Curitiba",
            "state": {
                "code": "PR"
            },
            "street": "Rua 1",
            "country": "Brazil",
            "countryCode": "BRA"
        },
        "config": {
            "terms": [
                {
                    "end": "2022-12-31",
                    "code": "1641565404",
                    "name": "2022",
                    "start": "2022-01-01",
                    "status": 1
                }
            ],
            "sections": [
                {
                    "level_name": "1º ano",
                    "stage_name": "Ensino Fundamental 1",
                    "level_code": "FIRST_YEAR",
                    "stage_code": "ELEMENTARY_1"
                },
                {
                    "level_name": "2º ano",
                    "stage_name": "Ensino Fundamental 1",
                    "level_code": "SECOND_YEAR",
                    "stage_code": "ELEMENTARY_1"
                },
                {
                    "level_name": "3º ano",
                    "stage_name": "Ensino Fundamental 1",
                    "level_code": "THIRD_YEAR",
                    "stage_code": "ELEMENTARY_1"
                },
                {
                    "level_name": "4º ano",
                    "stage_name": "Ensino Fundamental 1",
                    "level_code": "FORTH_YEAR",
                    "stage_code": "ELEMENTARY_1"
                }
            ],
            "users_info": {
                "permitted": [
                    "NAME",
                    "BIRTHDAY",
                    "PERSONAL_ID",
                    "EMAIL",
                    "PHONE"
                ],
                "masked": []
            }
        }
    }
]

Request

Mandatory Headers
- Autenticação
Environment

GET PRD https://apihub.educacional.com/manager/v1/data/schools

GET QA https://qa-apihub.educacional.com/manager/v1/data/schools

"x-api-key": "apikey.hubeducacionalpontocom"

Code 401: Not Authorized, when the code passed is from an institution not linked to Edtech
Code 404: Not Found, when the code entered is not in the HUB.
Code 500: Internal Error