Wanesy™ Management Center (End Of Life)

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Operational Support System ======

The OSS has several interfaces that can be accessed through APIs.

{{:wiki:oss_overview.png|}}

===== REST =====

A RESTful Web services architecture follows basic design principles:

  * It exposes a tree of resources via URI 
  * It is stateless. Each request from any client contains all the information necessary to service the request, and session state is held in the client. 
  * A resource is represented by an hypermedia type, for example JSON 
  * It uses HTTP methods explicitly (''GET'', ''POST'', ''PUT'', ''DELETE'', …) and other HTTP standards 
  * hypertext links to reference state 
  * hypertext links to reference-related resources

The API version level is requested by the client using the //accept// HTTP header, for example here with API v1:

<code>Accept: application/vnd.kerlink.iot-v1+json</code>

==== Example ====

<code>GET http://kerlink.fr/oss/rest/application/customers/198/fleets?page=3&PageSize=40</code>

This web service allows to get the page number 3 of the list of fleets of the customer 198.

{{:wiki:oss_api_example.png|}}

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. 

==== Using the command-line ====

These examples use the command-line program ''curl'' to make HTTP requests.

If you want to test, you could also use [[https://mockable.io|mockable.io]] or any other tool of your choice.

=== Logging in ===

The use of the API is bound to a fresh token. Here is how you can request for a new token:

<code bash>
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 .
</code>

Here ''jq'' is used to prettify the JSON output so that it is readable and indented:

<code javascript>
{
  "expiredDate": 1500537180050,
  "tokenType": "Bearer",
  "token": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJzdXBlcmFkbW ... n6i5WboHR-I"
}
</code>

=== Requesting the customers list ===

<code bash>
curl -s 'http://wanesyserver.tld/oss/application/customers' \
  -H 'Accept: application/vnd.kerlink.iot-v1+json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJzdXBlcmFkbW ... n6i5WboHR-I' \
  | jq .
</code>

Result:

<code javascript>
{
  "count": 2,
  "pageSize": 50,
  "page": 1,
  "totalCount": 2,
  "list": [
    {
      "id": 130,
      ...
    }
  ],
  "nbPages": 1
}
</code>
Wanesy™ Management Center (End Of Life)

User Tools

Site Tools

Page Tools
