The information we need:
To get your own platform-application, we need the following information of your product.
General
-
Name of the product (max. 64)
- Company Name / Name of Integration Partner (max. 100)
-
Short description (max. 255)
- Usecases you want to treat
-
Domain (or Domain-Pattern)
e.g. www.yourserver.com or www.*.(server1|server2).com - Restrictions for specific countries, regions or schools
For UI-Integration
-
Redirect-Path: e.g. /untis
Must match with the REDIRECT_URL you send during the OAuth-Authentication!
Where to integrate:
- Main menu
- Lesson details
- Examinations
-
Logout-Path: e.g. /logout
Will be called during the logout in WebUntis. -
Different Default-Values per User-Role (Optional)
- Role (e.g. Admin, Student, Teacher, …)
- Name of the Menuentry (e.g. “Your Application”)
- Open in new Tab or integrated as an iFrame
- Different Redirect-pathes for each role are possible (e.g. "/redirect/teacher" or "/redirect/student")
-
Icon with these specifications (recommended):
- Size: 24x24px
- Color: #919DA6
- File format: SVG (optional: PNG)
-
For mobile-app integration (optional):
-
Either you have your own iOS/Android app:
- Universal Link to open your iOS/Android app (e.g. "https://yourserver.com/app" or "https://{domain}/openapp")
-
To check if your app is already installed on the device:
- AppId for Android (e.g. "com.yourapp.school")
- AppId for iOS (e.g. "12532342")
-
Or you have a mobile-view of your web-application and the redirect-pathes would also work on mobile devices:
- YES or NO
-
Either you have your own iOS/Android app:
For Calendar Integration
- Calendar-Path (optional): e.g. /untis_calendar
If you provide us a specific iCal-API, we can read your calendar data and show the data in our timetable.
Specification: Calendar API (iCal) Specification
For API-Integration
-
Which APIs do you need?
We need to know, so that your platform application gets the correct permissions.- OneRoster read
- Student masterdata read
- Student masterdata write
- Teacher masterdata read
- Teacher masterdata write
- Legal Guardian masterdata read
- Legal Guardian masterdata write
- Class masterdata read
- Class masterdata write
- Lesson read (incl. students)
- Timetable read
- Exams and ExamTypes read
- Class register: Student absences read
- (Class register: Lesson topic write) only pilots
-
Credential-Path (optional, but we highly recommend!): e.g. /credentials
To transfer the platform credentials (secret, password, …) automatically, you must provide the following API. Otherwise, the school-administrator must copy the credentials and add them to your application manually and therefore you must provide a specific user interface.
Specification: Credentials API Specification