Set up a Cin7 Omni API connection
Overview
Find out how to connect third-party applications to Cin7 Omni via Cin7 Omni API.
Set up a connection: key, username, and permissions
How you set up a connection to Cin7 Omni via Cin7 Omni API will differ depending on what third-party application you’re connecting to.
But, for basic authentication over HTTPS, you’ll always need a username and a key. You create a unique key for each connection. Then you configure your connections’ permissions – that is, what Omni data the connections can read and write.
Either watch this video of setting up an API connection or follow these instructions.
Log in to Cin7 Omni as an administrator.
From the user menu in the navigation, open Settings.
Under Integrations & API, select API v1.
Here you’ll see your username (API Username). Now you need to create the key:Select Add New API Connection (see image below) – if you receive an error (“Unable to create more than X API connections”), you must contact Cin7 Omni support to have your new connection added for you.
Give your connection a short, descriptive App Name – we suggest including the name of the software you’re connecting to Omni.
Note your connection’s key (API Key for …) and store it safely – if you lose your key, you’ll have to generate a new one (see below).
Select Back to Setup.
You’ll see your new connection under API Connections. Now you can configure its permissions:On your connection, select Permissions (see image below).
Configure each endpoint’s (Resource) permissions – that is, for each endpoint, select Create, Read, Update, and/or Write.
Select Save.
-
Select Connections List.
For a complete list of supported endpoints, see our Cin7 Omni API Documentation. For more information on API generally, watch What is an API? from MuleSoft.
Generate new key
If you lose your key (Connection Key), you must generate a new one; and if you generate a new one, you’ll have to substitute it wherever you used the old key:
Log in to Cin7 Omni as an administrator.
From the user menu in the navigation, open Settings.
Under Integrations & API, select API v1.
Under API Connections, select Regenerate Key for your connection.
On the dialog, select Okay.
Note your connection’s new key (API Key for …) and store it safely.
Select Back to Setup.