API Data

📘

Collection Postman

https://gitlab.com/hub-educacional-public/docs/data-api

With the Data API, it is possible for edtech to have access to the data of a school's ensalement, in a simplified way. This simplification is important for applications that need to have school data in advance.

The returned data will be anonymized according to the settings made by the educational institution. The institution can choose which data will be returned and whether that data will be anonymized.

Data that can be returned or not depending on the configuration that the institution does for the application: Full name, date of birth, social security number, e-mail address, cell phone number.

The configuration that is used for the data return will be returned in the configuration object

{
  "configuracao": {
  	"conjuntoDadosUsuario": {
  		"atributosPermitidos": [
  			"nome_usuario",
  			"idade",
  			"cpf",
  			"email_usuario",
  			"telefone"
  		],
  		"atributosAnonimizados": []
  	}
  }
}

In some cases, intuitions may have a hierarchy with other institutions. With this, the HUB provides the summary, it is a feature of API Data that provides the number of events that occurred for each entity or relationship, according to the event. Along with your payload comes the information from the child institutions, thus giving an overview of the events of all institutions.

To find out more about the summary, see the page on the side.

Authentication

Authentication will take place via api-key, which must be sent in all requests. It must be informed in the header.

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

If the api-key is not sent or is invalid / revoked it will be denied by the platform. If necessary request a new api-key.

Code: 401 - Unauthorized

{"message": "Unauthorized"}

Request

• PROD: GET https://apihub.educacional.com/manager/v1/data/{org_id}
• QA: GET https://qa-apihub.educacional.com/manager/v1/data/{org_id}

Filters:

The date API allows the use of parameters that assist in filtering the data.

All parameters can be used together or not be informed, except org_id which is mandatory.

• min_date : defines the minimum date for inclusion of changes in the result of the requisition
• max_date : defines the maximum date for inclusion of changes in the requisition result
• event : allows you to define a filter of which events should be returned, to return more than one event their
  values must be separated by commas. If nothing is informed, all operations will be returned.
• only : returns only the data of the desired fields. To return more than one object, its values must be separated
  by commas. If not informed, all objects will be returned.
• except : exclude an object from the return. To exclude more than one object, its values must be separated by
  commas. If not informed, all objects will be returned.
• user_id : filter information by user hub. If not informed, all objects will be returned.
• code_term : filter information by period code. If not informed, all objects will be returned.

Possible status code for error and its causes

• Code 400: Bad Request, when the code is not informed
• Code 401: Not Authorized, when the code passed is from an institution not linked to Edtech
• Code 403: The application has no relationship with the school.
• Code 404: Not Found, when the code entered is not in the HUB.