SERTICA Application Programming Interface

SERTICA API gives the opportunity for other systems to get and send data to and from SERTICA. This means that if an interface is created for e.g. ERP or SCADA/SRO, the API will be used.

All requests are connected to a user when communicating with the API. This means that you will only have access to the data that the user has access to.

General

The API is designed with the principles of a REST http services.

HTTP requests are used to communicate with the API. Request/response data is in JSON format.

Basically, the following applies:

• GEThttp requests.
  Can det GET requests cannot edit data.
• POSThttp requests.
  Creates In cases where ”actions” needs data input, e.g. when searching, login and the like, POST is used as well because GET cannot send data input.
• PUThttp requests.
  Used for editing existing objects.
• DELETEhttp requests.
  Used to delete objects.

Swagger/Documentation

There is available documentation in the API itself, concerning object structures, endpoints and which http methods that are used for the different requests. 
The documentation is shown by writing “api/swagger” after the address to the SERTICA site:

https://<sitename>.sertica.com/api/swagger

It is also possible to test different requests from the swagger tool and test which replies it will return.

Test the request by filling out the required data and click on “Execute”.

Token

To call the different endpoints, a token which identifies the user is required. 
This token is received by calling Auth with username and password. 
The token can be reused until it expires. The standard expiry is after 24 hours.

Paging

When returning a list from an endpoint, the list will then be “paged”. This means that you will receive a selection of the list that matches the pageSize being used. The standard is 25.

Read the following articles for examples of using the API.