Get ready for a more efficient, powerful, and user-friendly API experience with our brand new release

Introducing our new and enhanced API!

We've taken the robust functionality you loved from our first API iteration and upgraded it with modern RESTful principles. This means you'll now have an easy-to-follow, predictable, and standardised set of API endpoints that make integration smoother than ever.

Our API places data at the heart of its design, providing you with enhanced flexibility and control over data retrieval. Enjoy improved filtering, sorting, and pagination capabilities, making it easier than ever to manage your iCompleat data.

What's more, we've introduced interactive Swagger-derived documentation which allows you to test and implement the API with your iCompleat system and see meaningful results in an instant.

In this article, we show you how to get set up quickly with iCompleat API.

 

Access iCompleat API Documentation

Our Swagger-derived API documentation is divided into two regions:

 

Go to API Documentation for US

Go to API Documentation for EU

 

Enable API v2 in iCompleat

1. On the iCompleat homepage, click Configuration.
2. Click API.
3. In the top-left, go to API V2.
4. Click Activate.
5. A list of credentials appears.

   Make a note of the API base URL and your Security key.

   The API base URL is the location of the interactive API documentation.

   The Security key will authenticate your access to the interactive API documentation in the next stage below.

 

Log in to test your API calls

You can use our interactive API documentation to check out all the API calls against your tenant, and test them out to see them in action.

To get up and running you need to authenticate your login details and generate a temporary access token. Your temporary access token will expire after 30 minutes, after which you can reactivate it using a refresh token. Your refresh token is generated at the same time as your temporary access token, and is valid for seven days.

Here, we show you how to generate a temporary access token and authorise it to log in, as well as how to access and use your refresh token.

 

Generate a temporary access token

Here's how to generate a temporary access token.

 

1. Go to our interactive API documentation via the URL in the API section in iCompleat, adding /docs to the end of the URL.

   eu.api.compleat.online/docs

2. Go to Endpoints in the top-left.'
3. Click to expand the Authentication drop-down.
4. Click to expand the /token drop-down.
5. In the top-right, click Try it out.
6. In the Request body field, enter your iCompleat username and password in place of the string text.
7. Below the request body, click Execute.
8. Your temporary access token is generated.

 

Authorise your access token and log in

Once you've generated an access token, you need to log in and authorise your access token in order to access your API calls.

Here's how.

1. In the top-right, click Authorize.
2. Copy your Security key from the API section in iCompleat, and paste it into x-api-key field.

   Then, click Authorize.

3. Copy your access token, and paste it into the authorization field.

   Then, click Authorize.

4. You're now logged in to access and test your API calls for 30 minutes.

 

Use your refresh token

When your access token expires after 30 minutes, you can use your refresh token to log in and access your API calls for seven days.

When you generated your access token, a refresh token was also generated, and can be found beneath your access token.

 

 

Here's how to log in using your refresh token

 

1. Copy and paste your refresh token (all the text between the speech marks).
2. In the top-right of the interactive API documentation, click Authorize.
3. Delete your expired access token, and paste your refresh token.

   Then, click Authorize.

4. You're can now access and test your API calls using your refresh token for seven days.

 

 Still got questions? Comment below and let us know how we can improve this guide.