How To Create A Lightspeed K-Series API Client
Trung Ly
27 steps
2 minutes
Mail
Lightspeed
Deref-Mail
1
Go to <https://developer-portal.lsk-demo.app/> (staging) or to [https://developer-portal.lsk-prod.app/](https://developer-portal.lsk-demo.app/)(production) create a new account
2
Click "Register"
3
Please ensure all required fields on the form are completed. A **valid email address** is necessary for verification.
4
Click "Register"
5
Please wait for the email verification to arrive. Click on the "**Link to email address verification**" provided in the email. Be sure to check your spam folder, and add [do_not_reply@lightspeedhq.com](mailto:do_not_reply@lightspeedhq.com) to your whitelist to ensure you receive the verification email. The subject line is **[[Verify email]]**
6
Click “Request Access” to submit your request and wait for approval by our internal team. Please note that you will not be able to request an API until your user account has been approved.
7
Click "Submit request"
8
\[INTERNAL\] Upon submission of the request by the end user, a Slack notification will be sent to our team to approve their request.
9
\[INTERNAL\] Click "Access Request", based on the partner **developer email**. The status should be [[In review]].
10
\[INTERNAL\] Review the request to ensure it complies with our internal requirements. Once verified, proceed with approving the request.
11
\[INTERNAL\] Click "Approve request"
12
Once approved, end users will receive the following email. **Subject**: "You now have access to the Lightspeed Developer Portal! Your request for developer access in the K-Series Developer Portal has been approved!..."
13
The status should update to [[Provisioned]] for both the internal team and the end user. However, if the end user encounters issues and is unable to submit any requests (e.g., API client), instruct them to sign out and then sign back in.
14
If the user’s access has been approved but they are still seeing [[Request in review]], instruct them to sign out or clear their browser cache.
15
Click “Logout,” then sign back in.
16
After logging out and signing back in, the “Go to requests” option should appear.
17
Click [[New request]] to create a new API client
18
Select the relevant request type
19
Complete the form as required to submit a new API client request (all field are required). Complete the form as required to submit a new API client request.
20
Scopes
21
Click "Create request"
22
Similar to a user access request, the internal team will be notified through Slack. Navigate to the Developer Portal > Requests > Look for the request based on the developer email and type [[Client]]
23
\[INTERNAL\] Review the information carefully. - Make sure to only grant them the scopes required for their integration. - Ensure that the redirect URI don't contain the Lightpeed Commerce domain - No profanity in the display name. Click [[Approve request]]
24
\[INTERNAL\] An automatic email with their client credential details will be sent.
25
Click "Your Lightspeed K-series API client has been created."
26
Click "[onetimesecretlink](https://ots.lightspeed.app/#/s/c8f1537a-abed-4da4-a6c2-fb9f3ab46474/6a491d731c7488854e749dbd290e8392c3a2258bef75a1c50d9066c4fe007c34)"
27
Only the API [[clientId]] and [[clientSecret]] will be sent.
How To Create A Lightspeed K-Series API Client
Trung Ly
27 steps
2 minutes
Mail
Lightspeed
Deref-Mail
1
Go to <https://developer-portal.lsk-demo.app/> (staging) or to [https://developer-portal.lsk-prod.app/](https://developer-portal.lsk-demo.app/)(production) create a new account
2
Click "Register"
3
Please ensure all required fields on the form are completed. A **valid email address** is necessary for verification.
4
Click "Register"
5
Please wait for the email verification to arrive. Click on the "**Link to email address verification**" provided in the email. Be sure to check your spam folder, and add [do_not_reply@lightspeedhq.com](mailto:do_not_reply@lightspeedhq.com) to your whitelist to ensure you receive the verification email. The subject line is **[[Verify email]]**
6
Click “Request Access” to submit your request and wait for approval by our internal team. Please note that you will not be able to request an API until your user account has been approved.
7
Click "Submit request"
8
\[INTERNAL\] Upon submission of the request by the end user, a Slack notification will be sent to our team to approve their request.
9
\[INTERNAL\] Click "Access Request", based on the partner **developer email**. The status should be [[In review]].
10
\[INTERNAL\] Review the request to ensure it complies with our internal requirements. Once verified, proceed with approving the request.
11
\[INTERNAL\] Click "Approve request"
12
Once approved, end users will receive the following email. **Subject**: "You now have access to the Lightspeed Developer Portal! Your request for developer access in the K-Series Developer Portal has been approved!..."
13
The status should update to [[Provisioned]] for both the internal team and the end user. However, if the end user encounters issues and is unable to submit any requests (e.g., API client), instruct them to sign out and then sign back in.
14
If the user’s access has been approved but they are still seeing [[Request in review]], instruct them to sign out or clear their browser cache.
15
Click “Logout,” then sign back in.
16
After logging out and signing back in, the “Go to requests” option should appear.
17
Click [[New request]] to create a new API client
18
Select the relevant request type
19
Complete the form as required to submit a new API client request (all field are required). Complete the form as required to submit a new API client request.
20
Scopes
21
Click "Create request"
22
Similar to a user access request, the internal team will be notified through Slack. Navigate to the Developer Portal > Requests > Look for the request based on the developer email and type [[Client]]
23
\[INTERNAL\] Review the information carefully. - Make sure to only grant them the scopes required for their integration. - Ensure that the redirect URI don't contain the Lightpeed Commerce domain - No profanity in the display name. Click [[Approve request]]
24
\[INTERNAL\] An automatic email with their client credential details will be sent.
25
Click "Your Lightspeed K-series API client has been created."
26
Click "[onetimesecretlink](https://ots.lightspeed.app/#/s/c8f1537a-abed-4da4-a6c2-fb9f3ab46474/6a491d731c7488854e749dbd290e8392c3a2258bef75a1c50d9066c4fe007c34)"
27
Only the API [[clientId]] and [[clientSecret]] will be sent.
