Interface description for connecting the school administration program to app.schuelerausweis.de
Minimized administrative effort
✅ One-time setup - the process then runs automatically ✅ No more manual data synchronization required ✅ Automatic daily updating of student ID cards
Error reduction and data security
✅ Error minimization through direct transfer from the school administration program ✅ No risk of outdated or incorrect student data ✅ Secure transfer via SSH/SCP
Automatic deactivation of departed students
✅ Students who are no longer in the file are automatically deactivated ✅ No outdated or invalid ID cards in the system ✅ Expired ID cards cannot be reactivated, ensuring that only active students have valid ID cards
1 Introduction
This interface description defines the requirements and the technical procedure for connecting a school administration program to the app.schuelerausweis.desystem . The aim is to automatically provide a CSV file that is imported daily by our system.
2. data provision
-
Format: CSV (UTF-8 without BOM, separator:
;or,) -
Line break: LF (Unix standard)
-
File name: Must remain constant (e.g.
schuelerdaten.csv) -
Storage location: Defined SFTP/SSH/SCP server of the school
-
Access: Our system requires read access to the file directory
-
Import cycle: Once a day, the file is automatically retrieved from the server and imported into our system
3. rules for data processing
-
Empty file = no synchronization: If the file is empty or contains no valid data records, no synchronization takes place.
-
All active students must be included: Students who are no longer listed in the file are automatically deactivated.
-
Expired passes cannot be reactivated in Apple Wallet: The person concerned must create a new ID card.
-
No changes to the data structure after setup: The order of the columns must not be changed.
-
Constant file name: The file must always have the same name. If the file name is changed, it will not be imported.
3. structure of the CSV file (field mapping)
The CSV file must contain exactly the following sequence and fields:
| Column | Data type/format | Mandatory field | Field Description |
|---|---|---|---|
| School name | Fixed value: Sample school |
✅ | Please always enter the school name "Musterschule" |
| Class | Free text | ✅ | Class name |
| First name | Free text | ✅ | First name of the pupils |
| Last name | Free text | ✅ | Last name of the students |
| Date of birth | YYYY-MM-DD |
✅ | Date of birth |
| Customer number | Leave blank | ✅ | This column must be present but left blank |
| Validity | YYYY-MM-DD |
✅ | Expiration date of the ID card |
| Barcode | Alphanumeric (A-Z, a-z, 0-9) |
❌ | If not used, leave blank |
| E-mail address | Valid e-mail address | ✅ | Unique e-mail address |
| StudentID | Alphanumeric + special characters (no umlauts) | ✅ | Identification number from the school administration program |
| Address | Free text | ❌ | If not used, leave blank |
5. technical requirements
-
Protocol: SSH (preferred) or SFTP
-
File storage: The CSV file must be stored daily in a defined location on the school server
-
Access rights: Our server requires read access to the directory
-
Character encoding: UTF-8 (without BOM)
6 Implementation steps
-
The school sets up a daily CSV export in its school administration program.
-
The file is automatically saved on the school server.
-
Our system retrieves the file daily via SSH/SCP and imports the data automatically.
-
Regular monitoring of the transmitted data by the school is recommended.
Questions / Contact us:
If your school requires a different transfer method or has questions about the setup, please contact us.