Skip to main content

Connect other software with the API

The Shopnix API lets other software connect to your store, for example your billing, accounting or inventory system. The software uses an API key to work with your Store Manager data without you logging in.

Before you start

  • You need to be an Administrator in Store Manager.
  • You need a developer, or a software provider, to build the connection. This article covers what you set up in Store Manager.

Turn on the API app

  1. Go to Store Manager → Setup → Apps.
  2. Find the API app and turn it on.

If you don't see the API app, contact Shopnix support to turn on API access for your store. Until it is on, any API request gets the reply "API access is not enabled for this shop".

Create an API key

Each API key belongs to a staff user in Store Manager.

  1. Go to Store Manager → Setup → Users.
  2. Click the name of the user the software will connect as. You can also add a new user for this. See Add staff users and set permissions.
  3. Next to API Key, generate a key.
  4. Save the user.
  5. Copy the key and give it to your developer.

Anyone with your API key can reach your store's data. Share it only with people you trust, and never post it in public. If a key may have leaked, regenerate it straight away.

Regenerate an API key

  1. Go to Store Manager → Setup → Users and click the user's name.
  2. Next to API Key, regenerate the key.
  3. Save the user, then give the new key to your developer.

For your developer

Store Manager screens can be called as an API with the parameter mode=api and the user's API key. For details of the requests your developer can make, contact Shopnix support.

Need more help? Email support@shopnix.io or call +91 8880788813.

No comments to display