e-Schooling API
  1. GETTING STARTED
e-Schooling API
  • e-Schooling API
  • GETTING STARTED
    • Authorization
    • Defaults
  • entities
    • Gets all system entities
      GET
    • Gets a entity from its id
      GET
  • students
    • Gets all system students
      GET
    • Gets a student from its id
      GET
  • tutors
    • Gets all system tutors
      GET
    • Gets a tutor from its id
      GET
  • staffs
    • Gets all system staffs
      GET
    • Gets a staff from its id
      GET
  • teachers
    • Gets all system teachers
      GET
    • Gets a teacher from its id
      GET
  • system
    • Obtain tenant informations
      GET
  • sso
    • Single Sign-On
    • Generate OAuth2 Token
      POST
    • Get user info
      GET
  • Schemas
    • Schemas
      • BadRequestHttpException
      • EntitiesAddresses
      • EntitiesContacts
      • EntityBankAccount
      • EntitiesList
      • EntityIdentificationDocument
      • Entity
      • HttpStatusCode
      • InternalServerErrorHttpException
      • MethodBase
      • EntityIdentificationDocumentInsertRequest
      • NotFoundHttpException
      • NoContent
      • EntityInsertRequest
      • OAuthMeResponse
      • OAuthTokenResponse
      • ProblemDetails
      • Staff
      • StaffIdentificationDocumentInsertRequest
      • StaffInsertRequest
      • StaffsList
      • Student
      • StudentIdentificationDocumentInsertRequest
      • StudentInsertRequest
      • StudentsList
      • SystemStatus
      • Teacher
      • TeacherIdentificationDocumentInsertRequest
      • TeacherInsertRequest
      • TeachersList
      • Tutor
      • TutorIdentificationDocumentInsertRequest
      • TutorInsertRequest
      • TutorsList
  1. GETTING STARTED

Authorization

JWT#

The e-Schooling API uses JWT Bearer as authorization method.

Configure#

To issue a new token the e-Schooling tenant administrator should access the web app and create a token
Navigate to e-Schooling API Tokens page using the menu Configurations -> System -> e-Schooling API Tokens and issue a token.
image.png
Then copy the token and save it to add in every request.
image.png
Example:
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Anything related with token should be managed in the previous web app
Modified at 2025-04-10 08:40:53
Previous
e-Schooling API
Next
Defaults
Built with