v1

latestOpenAPI 3.1.02026-07-242325051.4 MB

Authentication

Authenticate:Login

Retrieve a handshake to redirect a user to the Pay platform so that a user can access the Pay platform without entering login credentials. Note that the user needs to have the correct rights to use this feature. You need to authenticate this API with the AT-code as username and the token as password

post/login/authenticate

Request body

Example request

{
  "login": {
    "inactivityExpire": 1800,
    "internalId": "John Doe's Bakery",
    "deviceId": "ec81b928b5f7b945cbe1ad97927867a564131eaa",
    "ipAddress": "213.126.82.230",
    "userAgent": "Mozilla/5.0 (X11; Ubuntu; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3987.87 Safari/537.36 RuxitSynthetic/1.0 v5732837501202812829 t1236787695256497497"
  },
  "account": {
    "licenseCode": "AL-1234-4321",
    "label": "John Doe",
    "languageId": "nl_NL",
    "logoutRedirectUrl": "https://mijn.3rdparty.nl"
  }
}

Response

Ok.

Example response

{
  "session": {
    "sessionCode": "LA-1234-4321",
    "handshake": "agftj386jdfjk3489dsfdf824dff",
    "internalId": "John Doe's Bakery",
    "licenseCode": "AL-1234-4321",
    "redirectUrl": "https://dashboard.bakery.com"
  }
}