Developers
The StoreLenz developer API
A developer API is being built, so that the information StoreLenz collects about a shop can be read by your own programs instead of only by a person looking at a screen. It is not open yet, and this page is not a reference: there is nothing to call, so there is nothing to document.
The API is not open. No keys are being issued, no requests are being answered, and we are not naming a date.
What it will let you do
The plan is to give your own programs the information the product already shows a person on a screen — no more than that, and nothing a shop does not publish itself.
Look up a shop
You will be able to give it a shop's web address and read back what that shop publishes about itself: its name, where it ships, which currencies it takes, how big its catalogue is and which tools it runs.
Read a catalogue and its prices
It will hand back the products a shop lists publicly, with their prices and what has changed since you last looked. This is the part most people say they want first.
Be told when something changes
The same changes the product already emails you about — a new product, a price cut, a sale starting — will be delivered to a program instead of an inbox.
Read the estimates, with their ranges
Traffic and revenue estimates will arrive the way they appear on screen: as a range with a label saying how confident it is. An API that handed back one confident number would be a worse answer, not a better one.
What we are not promising
- A date. We are not going to give you one we might miss, and we would rather say nothing than say a quarter.
- A list of addresses to call, or what the answers will look like. Those are still being decided, and publishing a draft would only mean somebody builds against it and has to start again.
- That today's plan allowances are final. They are written into the plans already, and they are shown below, but nothing is counted until the API opens.
What each plan already sets aside for it
These allowances are written into the plans today. Nothing is counted against them yet, because there is nothing to call — they are here so you can see what you would be working with.
| Plan | Keys | Credits a month | Requests a minute |
|---|---|---|---|
| Starter | No API access on this plan | ||
| Growth | 2 | 10,000 | 30 |
| Pro | 5 | 100,000 | 120 |
A credit is the unit the allowance is counted in, not a request: the plan is for heavier requests to cost more than light ones. We have not settled what each kind will cost, so that is not written down anywhere yet.
One thing worth deciding now
A key will stand for your account. Anything holding it can spend your monthly allowance and read everything your plan allows.
So keep it on a computer you control — your own server, or whatever runs your scheduled jobs. Never put a key in a web page, in an app you hand to other people, or in code you publish: everything sent to a browser can be read by whoever is using that browser.
If a key ever does get out, you will be able to remove it from your account and make a new one. That is the whole point of having more than one.
Tell us what you would build with it
Write to us and pick API access as the reason. We will let you know when it opens, and what people say they want to do with it decides what works first.