Add authentication by XApiKey

PATCH /reservation/api/1/platform/{platform-code}/webhook/auth/api-keys

Activate XApiKey authentication for webhooks to notify external platform about K-series updates

Path parameters

  • platform-code string Required

    Unique code assigned to the reservation platform.

    Maximum length is 11. Format should match the following pattern: [a-zA-Z0-9_-]+.

application/json

Body

Responses

  • 200

    Accepted

  • 400

    Non relevant request

  • 403

    Scope 'reservation-{platform-code}' not found in the token

  • 404

    Platform not found

PATCH /reservation/api/1/platform/{platform-code}/webhook/auth/api-keys
curl \
 -X PATCH https://api.trial.lsk.lightspeed.app/reservation/api/1/platform/EasyTable/webhook/auth/api-keys \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"headers":{"X-API-ID":"ABCDEF001","X-API-SECRET":"*********"},"parameters":{}}'
Request example
{
  "headers": {
    "X-API-ID": "ABCDEF001",
    "X-API-SECRET": "*********"
  },
  "parameters": {}
}