REST API overview
How the License Web REST API fits into your key delivery and activation flow, and how to plan an integration.
The REST API is the core of License Web. It has endpoints for every step of the key lifecycle: creating keys, activating, deactivating, and checking trial, expiry and status.
Typical flows#
Most products are sold through an e-commerce store that delivers the key to the customer. In that case the flow starts when your store calls addKeys to push the new key into License Web. Your product then calls activateLicense when the customer activates it.
If you use License Web itself to create and deliver keys, your flow starts with activateLicense from your product.
Both approaches are supported. For worked scenarios, see Example use cases.
Explore the API in Swagger#
The API comes with a Swagger interface where you can read about and try out every endpoint:
https://lcweb.yourdomain.com/swagger/index.html
Turn the interface on or off with the API Interface switch under Admin > API & Routing. See API and routing.
Warning
Turn off the API interface in production. Turn it on only when you need to refer to it, then turn it off again.
Authentication#
Every request sends an API key pair in the ApiKey and ApiSecret HTTP headers. Create key pairs under Admin > API & Routing; see API keys.
Plan your integration#
Know your activation process before you integrate. Learning the API takes about 30 minutes, less if you already work with REST APIs.
- Map out your key delivery, activation and deactivation flow.
- Study the API endpoints.
- Integrate your product with License Web.