The Shopstar API lets developers connect your store to other tools — a custom mobile app, a reporting dashboard, an automation workflow, or anything else that needs to read or write store data. This guide is about creating and managing the credentials they need.
Owner access only
Only the store owner can view or create API credentials. Team members with Manager, Staff, or Check-in Only roles do not have access to this page.
Open API credentials
In the sidebar, click Store, then API Credentials. You will see a list of the keys and clients you have created, and a button to create new ones.
Create an API key
- 1
Pick your credential type
The API credentials page has two sections — API keys for simple tools and scripts, and OAuth clients for apps that connect to your store on your behalf, such as an AI shopping assistant. Click Create API key or Create OAuth client in the relevant section.
- 2
Give it a descriptive name
Name it after what it is for — "Reporting dashboard", "Mobile app", "Zapier integration". This makes it easy to find and revoke later if something changes.
- 3
Copy the key straight away
Your key or secret is only shown once — right after you create it. Copy it now and save it somewhere safe. Once it disappears from the page, you cannot see the full secret again, only a short prefix that helps you recognise it.
- 4
Give the key to your developer
Share the credential with whoever is building the integration. They use it in the API request headers to authenticate as your store.
Keep your keys safe
- Treat API keys like passwords — never post them on social media or in public code repositories
- Create one key per integration so you can revoke one without breaking the others
- Revoke any key you no longer use — fewer active keys means less to worry about if one ever leaks
- If you suspect a key has been leaked, revoke it immediately and create a fresh one
Read the API documentation
The API credentials page has an Open API docs button in the top right. The docs explain how to connect, what store data is available, and how to make requests — everything a developer needs. Share the link with whoever is building your integration.
Not a developer? Ask for help.
API credentials are aimed at developers building custom tools. If you want to connect your store to a specific app and are not sure how, check if the app has a pre-built Shopstar integration first — you may not need to touch the API at all.
Frequently asked questions
What can the API access?
API credentials give access to your store data — products, orders, customers, and other resources. The exact access depends on what you grant when you create the credential. Your developer can read the API docs to understand what is available.
How do I revoke a key?
Open Store > API Credentials, find the key you want to remove, and click Revoke. The key stops working immediately. Any integration using that key will need a new one.
Is there a limit on how many keys I can create?
There is no hard limit. Create as many as you need — one per integration is the cleanest approach so you have independent control over each one.
Can a team member use the API?
Only the store owner can manage the API credentials. However, a developer can use a key the owner created without needing access to the dashboard themselves.