REST API Getting Started

1. Creating the API key

2. Creating a data table using a CSV file

3. Updating a data table using a CSV file

4. Finding a data set a unique identifier

1. Creating the API key

Prerequisites

1. A server license that has the REST API module.
2. An admin account that has access to the user management module for the creation of the key.

Procedure

1. From the Users module in the left-hand side menu
2. Select the user for whom you want to create a key, alternatively, you can create an “API User” dedicated for your application.
3. Add a new key, providing the IP address of the server accessing the API. API key user is requiring to whitelist the callers servers.

Once generated you will have a 32 character long key made of one combination of letters and numbers, this is all you need to get started.

2. Creating a data table using a CSV file

     Uploading a data set is as simple as connecting to the API and streaming it to the server.

Prerequisites

     A .CSV file

C# Sample Code 

3. Updating a data table using a CSV file

Similar to the creation example, updating a data set is the same process with a different method.

Prerequisites

A .CSV file

C# Sample Code

In the example above, simply replace line 24 with this one.

4. Finding a data set a unique identifier

To do so, simply…

1. Go to your data section

2. Select the data set

3. The unique id is on the right of the “Identifier” attribute.