WMC v2.3 wiki
Product Overview
Using
OSS API*
Advanced
Resources
Product Overview
Using
OSS API*
Advanced
Resources
This is an old revision of the document!
A RESTful Web services architecture follows basic design principles:
GET
, POST
, PUT
, DELETE
, …) and other HTTP standards The API version level is requested by the client using the accept HTTP header, for example here with API v1:
Accept: application/vnd.kerlink.iot-v1+json
GET http://kerlink.fr/oss/rest/application/customers/198/fleets?page=3&PageSize=40
This web service allows to get the page number 3 of the list of fleets of the customer 198.
The list of possible verbs is : GET
, POST
, PUT
, DELETE
, PATCH
POST
: creates a new resource. GET
: gets a resource. PUT
: updates an existing resource. DELETE
: deletes a resource. PATCH
: updates a subset of fields of an existing resource.
These examples use the command-line program curl
to make HTTP requests.
If you want to test, you could also use mockable.io or any other tool of your choice.
The use of the API is bound to a fresh token. Here is how you can request for a new token:
curl -s 'http://wanesyserver.tld/oss/application/login' \ -H 'Accept: application/vnd.kerlink.iot-v1+json' \ -X POST \ -d '{"login":"jdoe","password":"P@ssW0rd5ecRe7"}' \ -H 'Content-Type: application/vnd.kerlink.iot-v1+json' \ | jq .
Here jq
is used to prettify the JSON output so that it is readable and indented:
{ "expiredDate": 1500537180050, "tokenType": "Bearer", "token": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJzdXBlcmFkbW ... n6i5WboHR-I" }
curl -s 'http://wanesyserver.tld/oss/application/customers' \ -H 'Accept: application/vnd.kerlink.iot-v1+json' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJzdXBlcmFkbW ... n6i5WboHR-I' \ | jq .
Result:
{ "count": 2, "pageSize": 50, "page": 1, "totalCount": 2, "list": [ { "id": 130, ... } ], "nbPages": 1 }