Step by step
- Open Set-up > Public API and press API Documentation.
- Use the menu on the left to jump to a part: Overview, Authentication, Responses and pages, Errors, Rate limits, Keeping in sync and Code examples.
- Below Endpoints, each GET address (key and shop, categories, brands, units, products, one product, stock, deleted items) has its own part with an example answer.
- Press Copy beside the Base URL or a code block to copy it, and give it to your programmer with the key.
Good to know
- The key goes in the Authorization header (Bearer) of every call; the header X-Api-Key works too.
- A key reads only what it was given: catalog, products or stock.
- Too many calls in a minute are refused for a while; the answer tells how many seconds to wait.
- Match products by id, not by SKU, and read everything again once a day.
- The guide is in English, the language programmers use.