After the required functionalities have been enabled to the partner the API is functional & the implementation can be started.
The partner is enabled to customize the experience for the customer or secure the input of clientID by the customer.
Customizations
Changes on the partner setup are valid & reflected for all customers as soon as set by the partner.
For example, to set partner images and affiliate banners, you need this endpoint:
PUT /setup/partner/images
The image is shown as the creator and the banner is at the end of an handover.
The following steps have to be taken into account:
The partner image must be at least 130px*130px and the banner should be in a banner format and it must have a minimum height of 30px.
The image/banner must be Base64 encoded for the request.
Send a request as described in this YAML.
In order to check the current configuration, use the following endpoint:
GET /setup/partner
This endpoint is used to check the current setup for your system.
Examples
Partner with full functionality
> 200 OK
{
"enabledRequests":[
"review","salary","wake_up_call"
],
"grantedFunctionality":[
"userList","userPush","messageImport","hasActions"
],
"webhook":"https://example.com/hotelkit",
userSync":{
"regEx":"^(\\d{3}_\\d*)(,\\d{3}_\\d*)*$",
"examples":["123_00025","123_12345,045_58975"],
"errorMessage":{
"de_DE":"Personalnummern m\u00fcssen dem Format XXX_XXXXX entsprechen",
"en_US":"personnel numbers must be given in the format XXX_XXXXX"
}
},
"sso":{
"type":"oAuth",
"providerOptions":{
"authorizationServer":"https://authorization-server.com/auth",
"client_id":"hotelkit",
},
"hotelkitOptions":{
"userCreate":false,
"userEdit":false,
"passwordReset":true
}
}
}
Partner without userPush
> 200 OK
{
"enabledRequests":[
"review","salary","wake_up_call"
],
"grantedFunctionality":[
"userList","messageImport", "hasActions"
],
"webhook":"https://example.com/hotelkit"
}
Partner without Webhook
> 200 OK
{
"enabledRequests":[
"review","salary","wake_up_call"
],
"grantedFunctionality":[
"userList","messageImport"
],
"webhook":null
}