Wirnet™ i-series

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== HTTP REST API ======
===== Introduction =====
The HTTP REST API service is used for:
  * Network configuration.   
  * Time configuration.
  * Gateway management (reboot, updates,restore...) 

The requests and their associated responses are detailed in the [[wiki:resources|KerOS web services documentation]].

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>

For each method, the method name, the URL, the content type and the content of the requests/responses are described. When the expected content is a JSON array, each field of the array is defined at the end of the document.

To send HTTP requests to Wirnet iBTS, first, a login request with both the login and the password is necessary. When the request is successful, gateway sends back a unique token. This token must then be used in each request. 

===== Examples =====
These examples use the command-line program curl to make HTTP requests. It is recommended to read the following examples in parallel with the documentation.

These examples are presented as is. They are not written to cover every possible exception. It is up to the user to adapt them to its needs.


==== Authentication ====

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 '192.168.4.127/application/administration/login' \
  -H 'Accept: application/vnd.kerlink.iot-v1+json' \
  -X POST \
  -d '{"login":"admin","password":"pwd4admin"}' \
  -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>
{
  "token_type": "Bearer",
  "expiration_date": 1538169670,
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1MzgxNjk2NzB9.0zM4BRqvMrorq916RJy4q_bghlK1HwrCYlZGADCdH1Q"
}
</code>

==== Ethernet configuration ====


>
==== End-device registration ====
Request: ''addEndpoint''

This request sends a JSON array containing every parameter required to add a new end-device to SPN. It then checks if the request is a success. 

<code bash>
### INSERT HERE THE LOGIN SCRIPT ###

# Add an end-device and search for the  string "201 Created"
ADD_DEVICE_RESULT=$(curl -i --insecure -s                                       \
                        "$URL/application/spn/endpoint"                         \
                        -H "Authorization: Bearer $TOKEN"                       \
                        --data-binary '[{"activation_type":"OTAA",
                                "class":"A","dev_eui":"0123456789123457",
                                "app_eui":"0000000000000000",
                                "app_key":"12345678912345678912345678912345",
                                "dev_addr":"",
                                "nwks_key":"",
                                "apps_key":"",
                                "rx_window":3,
                                "rx_frequency":869525000,
                                "rx_datarate":0}]'                              \
                | grep "201 Created"                                            \
)

# Check if the end-device has been successfully added
if [[ -z $ADD_DEVICE_RESULT ]]; then
        echo End-device not created
else
        echo End-device successfully added
fi
</code>

The previous script uses hard-coded values for the end-device configuration, but the same could be done with a JSON file as shown in the following example. 

This script fills the ''--data-binary'' parameter by the content of the ''end-device.json'' file. This file, obviously, contains the JSON array required to add an end-device.

<code bash>
### INSERT HERE THE LOGIN SCRIPT ###

# Add an end-device and search for the  string "201 Created"
ADD_DEVICE_RESULT=$(curl -i --insecure -s                                       \
                        "$URL/application/spn/endpoint"                         \
                        -H "Authorization: Bearer $TOKEN"                       \
                        --data-binary '@end-device.json'                        \
                | grep "201 Created"                                            \
)
</code>

==== RX data download ====
Request: ''downloadRxdata''

This request downloads the RX data from all registered end-devices. Frames are stored in the ''rx_data.csv'' file.

<code bash>
### INSERT HERE THE LOGIN SCRIPT ###

# GET RX data for all end-devices
curl --insecure -s                                                             \
     "$URL/application/spn/rxdata/file"                                        \
     -H "Authorization: Bearer $TOKEN"                                         \
     -H "Content-Type: application/vnd.kerlink.iot-v1+json"                    \
     -o rx_data.csv
</code>
Wirnet™ i-series

User Tools

Site Tools

Page Tools
