How To Create A Lightspeed K-Series API Client

Created by Trung Ly with Scribe

1. Navigate to https://developer-portal.lsk-demo.app/ (staging) or https://developer-portal.lsk-prod.app/ (production) to create a new account.

Step 1 Screenshot

2. Click "Register".

Step 2 Screenshot

3. Complete the registration form, ensuring all fields are filled, and provide a valid email address.

Step 3 Screenshot

4. Click "Register" again.

Step 4 Screenshot

5. Wait for the email verification. Click the "Link to email address verification" in the email.

Step 5 Screenshot

6. Click "Request Access" and wait for approval.

Step 6 Screenshot

7. After approval, click "Submit request".

Step 7 Screenshot

8. You will receive a Slack notification for internal review.

Step 8 Screenshot

9. [INTERNAL] Click "Access Request", based on the partner developer email.

Step 9 Screenshot

10. [INTERNAL] Review the request to ensure it complies with internal requirements. Once verified, approve the request.

Step 10 Screenshot

11. [INTERNAL] Click "Approve request".

Step 11 Screenshot

12. Once approved, the user will receive an email saying, "You now have access to the Lightspeed Developer Portal!".

Step 12 Screenshot

13. The status should update to [[Provisioned]]. If the user has issues submitting requests, ask them to sign out and sign back in.

Step 13 Screenshot

14. If users see [[Request in review]], instruct them to sign out or clear their cache.

Step 14 Screenshot

15. Click “Logout,” then sign back in.

Step 15 Screenshot

16. After logging back in, the “Go to requests” option should appear.

Step 16 Screenshot

17. Click [[New request]] to create a new API client.

Step 17 Screenshot

18. Select the relevant request type.

Step 18 Screenshot

19. Complete the form to submit a new API client request.

Step 19 Screenshot

20. Scopes

Step 20 Screenshot

21. Click "Create request".

Step 21 Screenshot

22. The internal team will be notified via Slack. Navigate to the Developer Portal > Requests > Look for the request based on the developer email.

Step 22 Screenshot

23. [INTERNAL] Review the information carefully and click [[Approve request]].

Step 23 Screenshot

24. [INTERNAL] An email will be sent with client credentials.

Step 24 Screenshot

25. Click "Your Lightspeed K-series API client has been created."

Step 25 Screenshot

26. Click "onetimesecretlink".

Step 26 Screenshot

27. Only the API clientId and clientSecret will be sent.

Step 27 Screenshot