Lightspeed Restaurant K Series API
1.0.0

Lightspeed Restaurant offers a REST API in order to communicate with the data in the system. These APIs are built using the RESTful standards and adhere to the basic verb interactions as defined by the REST standard.

These services are in continuous development and subject to change. Find our versioning policy here.

This is the documentation for version 1.0.0 of the API. Last update on May 1, 2024.

Base URL 
https://api.trial.lsk.lightspeed.app

Add authentication by XApiKey

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

Activate XApiKey authentication for webhooks.

Path parameters

  • platform-code string Required

    The 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":"Example-x-api-id","X-API-SECRET":"Example-x-api-secret"},"parameters":{"key":"string"}}'
Request example 
{
  "headers": {
    "X-API-ID": "Example-x-api-id",
    "X-API-SECRET": "Example-x-api-secret"
  },
  "parameters": {
    "key": "string"
  }
}