Authentication

O auth2 (oauth2)

The Lightspeed Restaurant K-Series APIs support OAuth2 authentication using the authorization code grant flow. See our Authorization Quick Start Guide for more details on how to authenticate.

Flow type authorizationCode
Authorization URL https://auth.lsk-prod.app/realms/k-series/protocol/openid-connect/auth
Token URL https://auth.lsk-prod.app/realms/k-series/protocol/openid-connect/token
Scopes
  • orders-api:

    Read business information, floors, menus, discounts, and production instructions. Read and write orders and payments. Read Rich Item data.

  • financial-api:

    Read financial data

  • reservation-***:

    Platform reservations scope. The *** will be replaced by the platform-code of the reservation platform.

  • items:

    Read and write items

  • propertymanagement:

    Read and write Property Management System configurations.

  • id-cards:

    Create and manage ID card batches and cards.

  • staff-api:

    Read shift information, read and write user information.

  • reservations-api:

    Configure legacy reservation integrations. Note: This API will eventually be deprecated in favour of the new Reservations for Platforms API. More information on the new reservations workflows can be found in the Integration Guide.

  • offline-access:

    Request offline access to the API. This allows your application to access the API on behalf of the user even when they are not actively using your application. See Offline Access for more information.|