How to use the SIMPro API - Getting Started

How can I access the SIMPro API?

To have access to use the SIMPro API, you must first request this service from your sales representative. 

To set up API access, we need your customer number and an email address. This can be an email address already registered with SIMPro for a user. We will create an additional user with access to the SIMPro API using your information.

How do I create API keys in SIMPro?

Once we have confirmed that API access has been activated for your user, you must log in to SIMPro and click on your name as shown in the following image:

At the bottom of this section, you will find access to generate the API Keys; you will need to scroll down until you find the following section:

To create a new key or view the keys created, you must click the "API Keys" button.

 

The keys must be added in the header of your code. For example:

headers = { 
  'x-api-client': 'your-client-id', 
  'x-api-key': 'your-api-key', 
}

If you need more information on how to do this, in this article you will find a guide with more details on how to use the new API authentication keys: Change of Authentication for the SIMPro API

Where can I find the API documentation?

You can find the API documentation by accessing the Help section of SIMPro:

Was this article helpful?
2 out of 2 found this helpful

Articles in this section

See more