Versionen im Vergleich

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

...

In order to check the current configuration, use the following endpoint:

GET /setup/partner
Examples

Partner with full functionality

Codeblock
> 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

Codeblock
> 200 OK
{
    "enabledRequests":[
        "review","salary","wake_up_call"
    ],
    "grantedFunctionality":[
        "userList","messageImport", "hasActions"
    ],
    "webhook":"https://example.com/hotelkit"
}

Partner without Webhook

Codeblock
> 200 OK
{
    "enabledRequests":[
        "review","salary","wake_up_call"
    ],
    "grantedFunctionality":[
        "userList","messageImport"
    ],
    "webhook":null
}