To transfer the platform credentials (secret, password, …) and other information about the school automatically to your application, 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.
Credenials API Specification v2
Since the name of a school is no longer necessary for communicating with WebUntis-Platform, we removed the "schoolName" in this new version!
|
POST |
JSON string with the data, for example: { |
Headers used to verify WU identity: Authorization - base64 encoded signature
|
-
"eventType" can have values "CREATED" and "REACTIVATED"
- CREATED: App was activated from the platform appstore.
- REACTIVATED: App was already created but deactivated. Now it was re-activated again.
Example HTTP request:
POST {partner.credentials.api} HTTP/1.1
Host: api.webuntis.integration.com
Content-Type: application/json; charset=utf-8
Content-Length: length
Connection: Keep-Alive
Authorization: zGPyG3bdqDbfJLk3s8jlRcbpreaCPhTJDywgh1JdqQYie5Aus0bzV/PjuFml1j+7B/6bEKI4xY+dh71dDJyvQWBkeS0DRxY883TPkvfMnfVr6vucTVjph5AARA9YXQw3OfGA5oDp9VXmBI22f4TFvanEWTqo5KD6pBM9FE+FUgEzDqXnB9FOogJ5xrfa8f0iU6Si3V0W3J20rIO71jf4V8Hvj9a9vs1p50ldi63SWeNAwO2wH+rxZXVtZ6RJqWkp720wgwIacfMezaw6lI0dodp0uDQnCmxarT07M4BbsvRciabe4tDJVuKd0JIpos4VargBtBPpgfXbPxWlSF6cTQ==
Algorithm: SHA256withRSA
{
"tenantId": "12345",
"clientId": "test-client-id",
"secret": "test-secret",
"password": "test-password",
"host": "localhost",
"country": "AT",
"region": "AT-3",
"language": "de",
"eventType": "CREATED",
"activatorEmail": "jane@doe.com",
"activatorUsername": "Jane Doe",
"schoolEmail": "school@entenhausen.com",
"schoolPhoneNumber": "555 / 123 456 789"
}
--> How can you verify WU identity
DEPRECATED: Credentials API Specification v1
|
POST |
JSON string with the data, for example: { |
Headers used to verify WU identity: Authorization - base64 encoded signature
|