Reinvent Your StoreThe Future Is Open

FAQs

• LightSpeed API FAQ

  What is LightSpeed API?

  LightSpeed API allows innovative retailers, developers and IT managers to build custom apps and integrations on top of the LightSpeed platform by offering a way to read and write data to and from LightSpeed Server.

  Can LightSpeed build an app for me?

  No, we are not offering custom development services at this time.

  Does the release of this API mean that LightSpeed will no longer be developed?

  No, the LightSpeed API allows developers to extend the LightSpeed platform through external apps while we focus on improving the core functionality of LightSpeed Server and its desktop and mobile clients.

• Development

  What is the protocol used by the API to communicate with LightSpeed Server?

  LightSpeed API uses a REST service which operates over HTTP.

  What development tools can I use to develop apps?

  Any tools that can communicate with a REST service can be used to develop apps, for example: PHP, Python and Objective-C.

  What platforms can I deploy my apps on?

  As long as your app can communicate with the LightSpeed Server using REST, platform is not a barrier.

  Do I need to own LightSpeed to use the API?

  Yes, you need a licensed LightSpeed Server to use the API.

  Can I test out the API or build apps with the LightSpeed Demo?

  No, a LightSpeed Developer Exchange membership and licensed LightSpeed Server is required for development at this time.

  When I buy the API can my whole team of developers utilize it at the same time?

  Yes, provided they have a licensed LightSpeed Server to test with.

  Can I use the same API kit to develop several applications?

  Yes.

• Functionality

  Can I modify the user interface or functionality of LightSpeed?

  No, developer apps exist as separate desktop, mobile or web-based apps.

  Can I add additional fields to the LightSpeed database?

  No, if you need to store additional data, you will need to store it in a separate database or in the cloud.

  How do I read and write data to and from the LightSpeed Server?

  You can read and write data using standard REST conventions for accessing data objects, such as GET, PUT and POST. In the initial version of the API, you can read products, customers, invoices, gift cards, taxes and users and create/modify products, customers and invoices. The scope of the API will be expanded in future releases of LightSpeed Server.

  Can I use SQL to read or write to or from the LightSpeed database?

  No, you must use REST conventions to read and write data from data objects.

  Can developers use the API to connect other software systems with LightSpeed?

  Yes.

  Will the API allow other credit card processing partners to be used?

  No, this would void LightSpeed's PCI certification.

  Will the API allow me to integrate additional POS hardware?

  No, not at this time.

  What if a future LightSpeed update changes how the data is organized to work with my app?

  LightSpeed API's REST interface will remain as static as possible across LightSpeed releases. However, major upgrades may require developers to make some updates to their apps to maintain compatibility.

• App Distribution

  Can customers buy apps directly from me?

  Yes, developers will be responsible for distributing and supporting their own apps.

  How can I showcase the app I have developed?

  Developers must market their own apps at this time. LightSpeed is exploring ways to showcase developer apps, please stay tuned for more news on this.

  Am I charged a royalty when I sell an app to a customer?

  No.

  Will my app use up a user license when it connects to LightSpeed Server?

  Apps that are registered as read-only on LightSpeed Developer Exchange do not use up a user license when they connect to LightSpeed Server. Apps registered as read-write will use up a user license while connected to the LightSpeed Server.

  Will there be a LightSpeed App Store?

  This is being considered. Please stay tuned to lightspeedretail.com for further news.

• LightSpeed Developer Exchange

  What is LightSpeed Developer Exchange (LDX)?

  LightSpeed Developer Exchange is a developer program sold as an annual membership that allows developers to register apps and license customers for their apps. It includes access to API technical documentation, a developer forum and 3 developer support incidents per year.

  How do I join LDX and what does it cost?

  Membership costs $499 USD annually and can be purchased from LightSpeed Sales or your local LightSpeed reseller.

  Do I need to register my app on the LDX in order to sell my app or use it internally?

  Yes. Registering an app enables you to license LightSpeed customers to use your app. They provide a portion of their LightSpeed Server license key and you authorize use of your app using LightSpeed Developer Exchange. This allows your app to connect to their LightSpeed Server once you provide them with the app.

  Can I sell my app if my LDX membership expires?

  No, you cannot license new customers to use your app without an active membership.

  Will my customers be able to use my app if my LDX membership expires?

  Yes, they can continue to use your app if your membership lapses.

  Is there technical documentation my developer can reference?

  Yes, technical documentation is available on LightSpeed Developer Exchange.

  How do i access developer support?

  LightSpeed Developer Exchange offers a developer forum and members are entitled to 3 developer support incidents per year.

  As a developer, can I get access to the API without joining LDX?

  No, developers must be a LightSpeed Developer Exchange member to register and license apps that use the API. Customers of your apps do not need to be members, but must own a licensed LightSpeed Server.

  As a developer, if I sign up for LDX, will I get advance access to LightSpeed updates/upgrades to test the apps that I have developed?

  Yes, we will offer LightSpeed betas to developers whenever possible.