What is the licence API for?

It lets your item ask us whether the copy somebody is running is genuine, using their purchase code. That is how one sale stops becoming a hundred installs.

How it works

Your item collects the buyer's purchase code, usually during setup, and sends it to us with your API key and the item's own id. We reply with whether the licence is valid, which tier it is, whether support is still running, and a signed token the item can hold on to.

The item id matters as much as the key. Your key covers everything you sell, so the id is what tells us which item is asking, and a code bought for one of your items is refused by another. You will find it on the Licensing panel of the item's page in your dashboard.

You decide what your item does with that. Most items refuse to run without a valid licence. Some run in a limited mode. That is your call, not ours.

What you can check

• The purchase code is real and belongs to your item.
• Regular or Extended, so an Extended-only feature can be gated properly.
• Whether support is still active.
• How many installations the licence has activated.

Using it well

Check on install and occasionally after, not on every page load. Constant checks slow your buyer's site down, use your quota for nothing, and turn any blip on our side into a visible problem on theirs.

Store the signed token and work from it between checks. See what happens when the API is unreachable, which is the part most worth getting right.

Where to start

The full reference, with the endpoints and a worked example, is in the API documentation.