Step by step
- Open Set-up > Public API.
- Press Create API Key. Enter a Name (for example Our website), tick What can it read? (Catalog, Products, Stock), choose Which products? (All products or E-commerce only), a Price group if needed, Calls a minute, and Allowed IPs and Expires on if you want them. Press Save.
- Copy the key shown in Your new API key, keep it safe, and press I have copied it.
- The Connect box shows the Base URL and how to send the key. API Documentation opens the full guide for your programmer.
- The figures show Active keys, Calls (24 hours), Refused calls (24 hours) and Average answer time.
- API Keys lists each key with Can read, Products, Limit, Last used and Status. Edit changes a key, Revoke stops it and Delete removes a revoked key.
- Recent Calls lists the calls with Time, Key, Request, Status, Duration and IP. Choose a key in the list to see only its calls.
Good to know
- The key is shown only once. If it is lost, revoke it and create a new one.
- Use a key only on a server, never in a web page or an app people can open. Make one key for each software you connect.
- A revoked key is refused at once and cannot be changed or used again. A key must be revoked before it can be deleted.
- E-commerce only sends only the products that have Show in e-commerce on.
- Public API is an App Store app. Creating, editing, revoking and deleting keys needs the manage permission. Calls are kept for 30 days.