Introduction

To backup your Cin7 Omni data using the Cin7 API and Control-C service involves a couple of key steps.

  1. Registering as a new user for the Control-O service
  2. Creating the API connection in Cin7 for Control-O to be able to connect to your data under your Cin7 account. As a part of this setup you will ONLY need to give READ ONLY access. Control-O does not update or change any of your Cin7 data.


NOTE: Please check that you have a free API connection to configure. To do this check, please follow these instructions here...

  1. Log in to Cin7 Omni as an administrator.

  2. From the user menu, open Settings.

  3. Under Integrations & API, select API v1.

  4. Note your API Username.

  5. Select Add New API Connection.

    • 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.


Instructions

Step 1

1. Please register as a new user here and complete the form to create your new user account.


2. You will be sent an email to confirm the creation of the account under the provided email.

3. Verify the account in the email sent to you by clicking on the link.

4. The account will be verified and confirmed.


5. You can now login using your newly created account with the details of the credentials that you provided. 


6. Click on Cin7 Company, Manage Cin7 Organisations, then Add New...


7. You will be prompted to enter the Cin7 API details created following Step 2. Set up the API connection in Cin7. 


Please login to your Cin7 Omni account to obtain the details in a NEW Safari/Chrome/Firefox tab or window. Do not close this tab or window... you will be coming back to here to add A. and B. values that you will generate in Step 2.


Step 2.

This is where and how you will create your API connection for Control-O


1. Click on the cog/gear icon at the bottom left hand side of your Cin7 Omni menu to open Settings & Options. Click on the Integrations & API option...


2. Click Add New API Connection...


3. Give the connection a name - Control-C (so you know what it is servicing).


4. You will now have a new API Key generated for you by Cin7. Click Back to Setup.


5. This next Cin7 page will display your API Username and your API Key.


  1. Copy the API Username and paste this into the Control-O tab that you still have open. 
  2. Copy the API Key to the Control-O tab to complete the form in Control-O (see the Control-O dialog box below).
  3. Click on Permissions




6. Click on Permissions


7. Tick all the READ boxes to allow the data to be backed up by Control-C and click Save


8. Last step, go back to the Control-O tab/window and click SAVE. The backup will start immediately. 

NOTE: Depending on the amount of data, this could take some time.