Getting Started with the Developer Portal

Table of content

---

• Overview
• APIS
  • Core API
  • Query API
• Products
• Profile
• Analytics
• Issues

Overview

---

Welcome to the API Developer Portal. The API Portal enables you to:

• Securely publish APIs

• Give developers access to the API Portal and Emerson APIs

• Give developers the information they need to begin creating applications against Emerson APIs

The API Portal contains these two main functional areas:

• Core API: will provide the Authorization to the API’s and provide the access to Unified model data.

• Query API: will provide the source information and retrieve the latest and history data of your sources.

Availability of the API’s depends on the Subscription Level. If you need access to any API, please contact TS Support.

APIS

---

Core API

---

The Core API will provide you with Authorize and Unified Model options, Below are the detail information:

Authorize:

1. This will let you issue a password grant against the authorization server to retrieve a bearer token. This can be directly done from the API Console by clicking on the ”Try it” button in Post Authorize.

2. By following the guidelines and filling out the username and password in the Request body (Remember to write inside the quotation marks), you will be able to retrieve an access_token.

3. The access_token is then used as the bearer token in the authorization field of the HTTP header when making subsequent calls to the other APIs.

UnifiedModel:

It Provide two types of data model information

Properties

[{

    "Key": "p5",

    "Name": "Device name",

    "Description": "The name of the device",

    "Type": "String"

},{

    "Key": "p6",

....

Alarms

[{

    "Key": "a3",

    "AlarmNo": "5",

    "Description": "Supply air sensor short circuit",

    "Manufacturer": "Thermoking"

},{

    "Key": "a4",

....

Important! When passing in the access_token, it is important to write it like this: Bearer access_token
Remember to add a single space after the Bearer, and keep the Bearer with a capital B.

Query API

---

The Query API will provide you with three options.

1. Sources: It will retrieve a list of all the available sources and the time data was last logged

2. SourceLatestData: It will retrieve the latest available source data from one of the accessible devices.

3. SourceHistoryData: It will retrieve historical device data from one or all accessible sources of a device.

Note: The Query API will be using the access_token as a Bearer token, which we retrieved in the Authorize.

Products

---

The Products page allows you to subscribe to the available API’s. This can be done by going through four steps:

Step 1:
Click on the product for which you would like to subscribe.

Step 2:
Click on the subscribe button to initiate a subscription.

Step 3:
You will be prompted to give your subscription a name before confirming the subscription. The “Subscription Name” will only be visible to your profile, and you can therefore provide it with any name you like.

Step 4:
Review the subscription from your profile, where it also will be possible to cancel and rename your subscription. You can also review the email that has been sent to you, which includes some helpful tips on your new subscription.

Profile

---

From the navigation menu, you can access your profile page (located to the right). From within your profile page, you can review your profile data such as email, first name and last name. You will also be able to see your current subscriptions:

Your current subscriptions can be cancelled at anytime you want, or you can even regenerate the primary and secondary key to deny access to your API.

Analytics

---

When you finally start using your subscriptions, it will be possible to track the usage of the APIs, and monitor analytics data. This data can be seen when clicking on the “Analytics reports” button from within your profile page:

From here on, you will be shown a dashboard of your API’s health and usage statistics, that allows you to get a better understanding on how you use your API’s.

Issues

---

If you should have any questions, suggestions, requests, or if you just want to tell us something, you can use the Issues page on the developer portal and create a new topic.