InSkill API
InSkill provides a web API to automate configuration and operation. The API is a typical REST style interface exchanging JSON formatted data.
Each HTTP request is authenticated using your account’s API key (found in the account page) passed in the request header.
GET [https://expert.inskill.ai/servicesv1/users](https://expert.inskill.ai/servicesv1/users) Apikey: <my api key>
If the api key is not valid, returns 401 Not Authorized
The REST pattern is that there is a url for each object and one for the collection of objects.
The HTTP verbs are used as follows:
GET returns existing objects
POST creates or modifies objects
DELETE removes objects
For Users the collection is
https://expert.inskill.ai/servicesv1/users
GET returns all users
{
"status": "success",
"more": false,
"users": [
{
"id": 27,
"first_name": "Michael",
"last_name": "Sandler",
"type": 1,
"navcode": "9gsFS674hp",
"pin": 7559,
"filters": null,
"role": 1,
"email": "[email protected]",
"active": 1
},
{
"id": 33,
"first_name": "Horace",
"last_name": "Freedman",
"type": 3,
"navcode": "Z2xPR37hfT",
"pin": 0,
"filters": null,
"role": 1,
"email": "[email protected]",
"active": 1
}
]
}
POST creates a new user in the collection. The body would be:
{
"first_name": "Horace",
"last_name": "Freedman",
"type": 3,
"pin": 0,
"filters": null,
"role": 1,
"email": "[email protected]",
"active": 1
}
To address a specific object, use https://expert.inskill.ai/servicesv1/users/<id>
GET https://expert.inskill.ai/servicesv1/users/27
Returns
{
"id": 27,
"first_name": "Michael",
"last_name": "Sandler",
"type": 1,
"navcode": "9gsFS674hp",
"pin": 7559,
"filters": null,
"role": 1,
"email": "[email protected]",
"active": 1
}
POST https://expert.inskill.ai/servicesv1/users/27
Modifies an existing object with body containing new values
{
"first_name": "Horacio",
"last_name": "Freedman",
"type": 3,
"pin": 0,
"filters": null,
"role": 1,
"email": "[email protected]",
"active": 0
}
And finally
DELETE https://expert.inskill.ai/servicesv1/users/27
Removes the object with id = 27
Updated 8 months ago
