- Script example for authomatization (Using Selenium (https://www.selenium.dev/))
- API authorization and getting info example (using PyJWT (https://pyjwt.readthedocs.io/en/stable/))
- OpenEMIS Core catching example (using Flask (https://flask.palletsprojects.com/en/2.2.x/) and ngrok (https://ngrok.com/))
Run
pip install -r requirements.txt
-
Please write necessary information into config.py
-
If the "chromedriver" file in this folder is incompatible with your version of Chrome, download the compatible version and change path to it in config.py
-
Run open_core_chrome.py
- Create key pair
ssh-keygen -t rsa -b 4096 -m PEM -f jwtRS256.key
# Don't add passphrase
openssl rsa -in jwtRS256.key -pubout -outform PEM -out jwtRS256.key.pub
cat jwtRS256.key
cat jwtRS256.key.pub
a) Create new Credentials in OpenEMIS Core;
b) copy all from jwtRS256.key.pub to Public Key field
c) Copy Client Id from Credentials and paste it to config.py iss variable value
iss = "1661365366-d6277c12d6e9f67a.app"
-
run get_core_assertion.py
-
you can try if the assertion works, using postman or running get_institutions_via_api.py
//curl -i -X GET https://demo.openemis.org/core/restful/User.Users.json
//curl -i -X GET https://demo.openemis.org/core/restful/User.Users.json?_contain=Genders
//curl -i -X GET https://demo.openemis.org/core/restful/User.Users.json?_fields=username,Genders.name&_contain=Genders
//curl -i -X GET https://demo.openemis.org/core/restful/User.Users.json?_order=-first_name,last_name
//curl -i -X GET https://demo.openemis.org/core/restful/User.Users.json?_limit=10&_page=2
| API Name | API Address | Index | View | Add | Edit | Delete |
|---|---|---|---|---|---|---|
| Institutions | Institution.Institutions | 1 | 1 | 1 | 1 | 0 |
| Users | User.Users | 1 | 1 | 1 | 1 | 0 |
| Classes | Institution.InstitutionClasses | 1 | 1 | 0 | 0 | 0 |
| Student Admission | Institution.StudentAdmission | 1 | 1 | 1 | 1 | 0 |
| Gender | Institution.Genders | 1 | 1 | 0 | 0 | 0 |
| Institution Types | Institution.Types | 1 | 1 | 0 | 0 | 0 |
| Institution Providers | Institution.Providers | 1 | 1 | 0 | 0 | 0 |
| Institution Sectors | Institution.Sectors | 1 | 1 | 0 | 0 | 0 |
| Institution Ownerships | Institution.Ownerships | 1 | 1 | 0 | 0 | 0 |
| Institution Localities | Institution.Localities | 1 | 1 | 0 | 0 | 0 |
| Institution AreaAdministratives | Institution.AreaAdministratives | 1 | 1 | 0 | 0 | 0 |
| User Nationalities | User.Nationalities | 1 | 1 | 0 | 0 | 0 |
| Nationality Names | User.NationalityNames | 1 | 1 | 0 | 0 | 0 |
| Create Student | Institution.Students | 1 | 1 | 1 | 1 | 0 |
| Identity Types | FieldOption.IdentityTypes | 1 | 1 | 0 | 0 | 0 |
| Areas | Area.Areas | 1 | 1 | 1 | 1 | 0 |
| Status | Student.StudentStatuses | 1 | 1 | 1 | 1 | 0 |
| AcademicPeriod | AcademicPeriod.AcademicPeriods | 1 | 1 | 1 | 1 | 0 |
| Education | Education.EducationGrades | 1 | 1 | 1 | 1 | 0 |
| Security User | Security.Users | 1 | 1 | 0 | 0 | 0 |
| Security User Groups | Security.UserGroups | 1 | 1 | 0 | 0 | 0 |
| Security Role Functions | Security.SecurityRoleFunctions | 1 | 0 | 0 | 0 | 0 |
| Staff | Institution.Staff | 1 | 0 | 0 | 0 | 0 |
| Institution Student Attendances | Institution.StudentAttendances | 1 | 1 | 0 | 0 | 0 |
| Institution Student Absence Period Details | Institution.StudentAbsencesPeriodDetails | 1 | 1 | 1 | 1 | 0 |
| Attendance Student Attendance Marked Records | Attendance.StudentAttendanceMarkedRecords | 1 | 1 | 1 | 1 | 0 |
| Institution Staff | Institution.Staff | 1 | 1 | 1 | 1 | 0 |
| UserGender | User.Genders | 1 | 1 | 0 | 0 | 0 |
| Subjects | Institution.InstitutionClassSubjects | 1 | 1 | 1 | 1 | 0 |
| StudentAttendanceTypes | Attendance.StudentAttendanceTypes | 1 | 1 | 1 | 1 | 0 |
| User Authentication | User.Users | 0 | 0 | 0 | 0 | 0 |
| Institution Absence Types | Institution.AbsenceTypes | 1 | 1 | 1 | 1 | 0 |
| Institution Student Absence Reasons | Institution.StudentAbsenceReasons | 1 | 1 | 1 | 1 | 0 |
| Institution Staff Attendances | Staff.InstitutionStaffAttendances | 1 | 1 | 1 | 1 | 0 |
| Payslips | Staff.StaffPayslips | 0 | 0 | 1 | 0 | 0 |
| Security Group Users | Security.SecurityGroupUsers | 1 | 1 | 0 | 0 | 0 |
| Assessment | Assessment.Assessments | 1 | 1 | 1 | 1 | 0 |
| Teacher Subjects | Institution.InstitutionSubjectStaff | 1 | 1 | 1 | 1 | 0 |
- Run catch_webhook.py:
flask --app catch_webhook run
- Run ngrok
./ngrok http 127.0.0.1:5000
If ngrok in this directory is incompatible, download the compatible version and run using the above arguments
a) Create new webhook in Administration > System setup > System configuration > +
b) Copy forwarding https address provided by ngrok to webhook URL field
c) Set Method to Post
d) Select needed Trigger events