REST API

See our Postman collection for our API documentation

Akenza provides a REST API for programmatic access to its features. If you have any questions or want to request new API features, please submit a feature request here.

A set of examples, showing how to use the API:

Python:

GitHub - akenza-io/akenza-python-examples: Python examples for the akenza IoT platform.GitHub

Javascript:

GitHub - akenza-io/akenza-javascript-examples: A set of examples for using the `akenza` APIGitHub

Java:

GitHub - akenza-io/akenza-java-examples: A set of Java examples for using the `akenza` APIs.GitHub

The API documentation can be found here:

akenza APIakenza API

Authenticating Requests

Requests can be authenticated with with API Keys by providing the x-api-key header or OAuth2 Clients with short-lived Baerer tokens passed as the Authentication header.

If the request is out of the specified permission scopes (e.g. Organization Delete) the API will return permission denied error.

Refer to Authentication for more details.

Example Request

GET https://api.akenza.io/v3/assets

This request will fetch all Assets in a workspace using an API Key for authentication.

Query Parameters

Name	Type	Description
workspaceId	string	The Workspace Id

Headers

Name	Type	Description
x-api-key	string	The API Key Secret

200 Returns a paginated list of Assets.

{
   "content":[
      {
         "id":"02d2327fedce2128",
         "name":"some device",
         "description":null,
         "type":"DEVICE",
         ...
      }
   ],
   "pageable":{
      ...
   },
   "totalPages":1,
   "totalElements":1,
   "last":true,
   "number":0,
   "sort":{
      ...
   },
   "size":25,
   "numberOfElements":1,
   "first":true,
   "empty":false
}

403 Returns an error object with the status and reason if e.g. the API Key permissions don't allow access to the Asset List.

{
    "timestamp": "2021-02-19T15:06:56.928+00:00",
    "path": "/v3/assets",
    "status": 403,
    "error": "Forbidden",
    "message": "Permission denied",
    "requestId": "64fa58b0-18361",
    "errorId": "33a00d16-6a22-4687-99ca-90bb448e5eb2",
    "traceId": "8a7c4ea8ae80a5e4"
}

Backfilling

Backfilling allows adding data to a device using an http endpoint. It is possible to backfill data individually or in bulk for a single device.

All data sent this way will be processed by the output connectors and rules, therefore the body has to match the output of the device type script. If not specified the timestamp will be set to the current time and the topic to default.

The example requests can be found in the akenza api documentation