API

REST API

Integrate and automate the work with the system. Our API is constantly evolving and improving

Start


This API evolves fast and future versions, adds new endpoints and parameters. To provide a sane experience, API is versioned. Within a version, the behavior and return values of API are not changed from currently documented behavior and return values. As well, API and its data payloads are designed so that new parameters and return values can be added at any time.

To provide the best experience, a well-behaved KAI-ISPYT API client must not send undocumented parameters as a part of their request. These parameters could collide with a future version of API. As well, KAI API client must accept and ignore any additional keys that it doesn’t handle in a response.


You can also reach us at support@kai-ispyt.com if you need help.

User creation

It creates a new user and returns user’s data.

To create a user , send POST-enquiry of the following format: http://YOUR_URL/api/user/

Parameters

Parameter Required paramter Description
server_api_key + Secret key. It is issued by system administrator.
email + User E-mail, a unique field. If the e-mail has already existed, the entry will not be created.
phonenumber + User phone number.
id_group + Group identifier.
surname_user + User surname. User’s login will be created on the basis of his surname.
name_user User name
middlename_user User patronymic

Result

Success answer example in JSON format:

good

 

Error answer example in JSON format:

bad

 

Parameter Value
status success – the enquiry is performed successfullyerror – the enquiry is  not performed or performed with an error
type users_item – it returns user objectinvalid_param_error – error at parameters transferinvalid_request_error – error at enquiry processingapi_error – error at server side
data created user data
message Error text

Group list display

It returns group list of the system.
To create a user, send GET-enquiry of the following format:
http://YOUR_URL/api/group/

Parameter

Parameter Required parameter Description
server_api_key + Secret key. It is issued by system administrator.

Result

Success answer example in JSON format:

good

 

Error answer example in JSON format:

bad

 

Parameter Value
status success –  the enquiry is performed successfullyerror – the enquiry is not performed or performed with an error
type list – data as value massifinvalid_param_error – error at parameters transfer

invalid_request_error – error at enquiry processing

api_error – error at server side

data returns group massif as group ID => Group name
message Error text
count Number of returned entries

New features coming soon