with Postman

A quick showcase of how Postman can be used to explore the various calls available on our REST API.

Overview

We will here show how Postman can be used to interact with our REST API. As an example, Basic Auth will be used to authenticate a GET request that fetches a list of available projects and a POST request that creates a new label for a device. All available endpoints are listed in our REST API Reference.

Prerequisites

• Enable Basic Auth You need to have created a Service Account with Basic Auth and a role of Project Developer or higher.

Postman

Postman is a collaboration platform for API development. It is a powerful tool with many useful features, but we will here use it to make simple arbitrary HTTP requests.

Installation

Postman can be acquired from the official downloads page.

Authorization

When creating a new request, under the Authorization tab, specify the method of Basic Auth.

• Username: Your Service Account Key ID.

• Password: Your Service Account Secret.

GET Request

To fetch a list of all projects available to a Service Account, create a new GET request with the following endpoint URL. No request body is required for this call.

https://api.d21s.com/v2/projects

If the valid key-id and secret of a Service Account with sufficient privileges were used, Postman should return a list of the available project for that account.

{
    "projects": [
        {
            "name": "projects/<PROJECT_ID>",
            "displayName": "wCaV7Y",
            "organization": "organizations/<ORGANIZATION_ID>",
            "organizationDisplayName": "Disruptive Technologies Research",
            "sensorCount": 10,
            "cloudConnectorCount": 1,
            "inventory": false
        }
    ],
    "nextPageToken": ""
}

POST Request

To add a new label to a device, create a new POST request with the following endpoint URL.

https://api.d21s.com/v2/projects/<PROJECT_ID>/devices/<DEVICE_ID>/labels

For the body, choose Raw and then JSON. Within, the label name and value should be provided.

If the valid key-id and secret of a Service Account with sufficient privileges were used, Postman should return the name, key, and value.

{
    "name": "projects/<PROJECT_ID>/devices/<DEVICE_ID>/labels/my-new-label",
    "key": "my-new-label",
    "value": "some-value"
}