Build an app
An app is a function (add-on) that users can add to their webshop or is a connection with third-party software. There are two different types of apps (connections):
- Custom connection with a single shop; then you don't need this tutorial and do not have to become a partner;
- Apps for multiple shops, available to all our merchants through the App Store;
This section only focuses on the second type of app, the public app, which will become available through the App Store.
If you want to create a custom connection with a single shop, contact our customer support department for API credentials**.
NOTE: The Lightspeed eCom platform has multiple clusters. In order to communicate with a specific cluster you need to identify on which cluster the shop is hosted. The success URL will contain a parameter that identifies on which cluster the shop is hosted; cluster_id. Currently these are the clusters that are in use:
1. Become a Lightspeed eCom partner and claim your test store
To start developing a
public app, you need to signup as a partner. Once you have registered and have gained approval from our ecosystem team, you will receive your partner account details and ‘test-store’ details within a few working days. As a partner you gain access to our EU partner dashboard or NoAm partner dashboard where you can create apps, themes and sell your services to our merchants.
Note: you can create a new (test/demo) store (incl. possible user), by clicking on the (+) next to "Shop" in the bottom left of our backoffice (see image). When you add a new store, you can create a new main user directly, or you as a user are added by default. You can then change/add users to the shop later through the usual flow General > Settings > Users.
2. Create a new app in the partner account
To create your first app, go to the EU partner dashboard or NoAm partner dashboard. Login to your account, go to the ‘Apps’ section and click on ‘create your first app’. Fill in all the required fields, such as Success URL, Cancel URL and Uninstall URL. After saving, you can complete some fields (summary & description), make sure that before the app goes live, everything is completely filled in and icons/banners/portfolio pictures are in right dimensions. See point 5.
3. Before you go any further...
Read this common mistakes document as it can help you in your development process.
4. Fetch the API credentials and build an app using the API Docs.
After you have created an app in the partner dashboard, you'll find the API key and the API secret on the bottom of the overview page (see image). You can find more on authentication and authorization in the "Installing an app" tutorial, and learn about the installation script that is required for our merchants to install an app. Note: authentication for single shop apps and multishop apps is different.
Be aware that you need to host your app in your own surrounding during development, testing and launch.
With the Lightspeed eCom API you can integrate your application with stores which are running on the Lightspeed eCom platform. The Lightspeed eCom API offers many options for retrieving, creating, modifying and deleting store data. This includes the ability to modify products, customers, orders, invoices, shipments and many other resources. Visit the Resources section for a complete overview of all available resources.
Be aware of the standard API request limits; it is very important that you adhere to these limits. App API keys have no direct limit, but per shop install you have a limit.
The Lightspeed eCom API accepts both
XML formatted data using the
DELETE methods. We've tried to make the Lightspeed eCom API follow the REST principles as much as possible. For more information about REST visit the "What is a REST?" page.
Libraries & tools
At this moment we only have a PHP client available. You can download the PHP client here. Note: you can use this client, but you don't need this client to connect to our API.
5. Test your app by installing it to the test-store
Testing is important, so iteratively test your app while building it. Without proper evaluation of the built app, our merchants will run into problems which increases overhead, and that is not what we want. You can test the app by installing the app to the test-store in the back office (App store > Partner apps > Choose app). We advise to test the app on multiple stores.
NOTE: While testing the app, you might want to test
"uninstalling". Since the app is not yet considered a store-item, uninstalling from the App Store as indicated in the Uninstalling an app tutorial is not possible yet. Therefore, you'll need to manually call the uninstall URL. See the tutorial for more information about uninstalling apps.
6. Launch the app
When final testing at the your end is completed and no more errors occur, the app can be published in the partner dashboard. Make sure that all fields are filled in and meet the requirements.
Please refer to the 'publish an app' section for an explanation and example of completing the fields correctly. This is needed for clear navigation and a good understanding of our merchants.
The ecosystem team will do the final check; they will test the app extensively and will monitor the texts and images. When everything is correct, the app may be published and will receive status ‘live’. Shops can then install the app via our App Store, and you can start earning.