# Lightspeed Restaurant (K-Series) (prebuilt connector)

## Description

**Lightspeed Restaurant (K-Series**) is a restaurant management solution and point-of-sale (POS) system that provides a comprehensive suite of features for hospitality businesses.  

## API documentation

API documentation for Lightspeed Restaurant (K-Series) can be found via the link below:

{% embed url="<https://api-docs.lsk.lightspeed.app/>" %}

## Authentication&#x20;

When adding connector instances for **Lightspeed Restaurant (K-Series**), the following authentication methods are supported:

* [OAuth 2 (authorisation code)](#oauth-2-authorisation-code)

### OAuth 2 (authorisation code)

When a user chooses to [add a connector instance](https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/working-with-instances/adding-an-instance) using **OAuth 2 (authorisation code)** authentication, the credentials below are prompted:

<table><thead><tr><th width="219">Credential</th><th width="150" data-type="checkbox">Required?</th><th>Notes</th></tr></thead><tbody><tr><td><code>base url</code></td><td>true</td><td>The URL used to access your Lightspeed instance, without the https// element. For example: <code>api.trial.lsk.lightspeed.app</code>.</td></tr><tr><td><code>state length</code></td><td>false</td><td>If you have been given a state length, enter it here. This numeric value determines the length of a random string generated (behind the scenes) during the OAuth process, for verification purposes.</td></tr><tr><td><code>client ID</code> &#x26; <code>client secret</code></td><td>true</td><td>A unique identifier and password, required to access and interact with your Lightspeed data via its API.</td></tr><tr><td><code>scope</code></td><td>true</td><td>The required scope to determine data access permissions granted to Patchworks. For more information, see Lightspeed's documentation: <a href="https://api-portal.lsk.lightspeed.app/quick-start/authentication/access-scopes">Access scopes</a>.</td></tr><tr><td><code>response authentication token key</code></td><td>true</td><td>Set to <code>access_token</code>.</td></tr><tr><td><code>grant type</code></td><td>true</td><td>Set to <code>authorization_code</code>.</td></tr><tr><td><code>response type key</code></td><td>true</td><td>Set to <code>code</code>.</td></tr><tr><td><code>refresh grant type</code></td><td>true</td><td>Set to <code>refresh_token</code>.</td></tr><tr><td><code>response refresh token key</code></td><td>true</td><td>Set to <code>refresh_token</code>.</td></tr></tbody></table>