Testing IoT Accelerator REST APIs using Postman®
The following steps describe how to test IoT Accelerator REST APIs from a Postman® client installed on PC. The IoTA REST APIs in scope are divided in different postman collections. Each collection includes one or more API according to its specific function.
This collection offers operations for sign in and authenticate the user. There are two types of authentication X-access-token and Bearer token. Based on the type of authentication used by the other API groups, one of the login API of the collection must be sent.
This collection requires HTTP Basic Authentication.The SMS Messaging API allows a web application to send and receive SMS messages over HTTPS and simplifies the communication between the enterprise and the IoT Accelerator SMSC.
Business Analytics Report API
This collection requires Bearer Authentication.The Business Analytics Report API provides methods to retrieve an organization's report and invoice information.
This collection requires Bearer Authentication. Custom fields are user-defined key-value pairs. They can be used for advanced filtering capabilities on single subscriptions as well as batch jobs. Custom fields can be created, modified and attached to subscriptions using this api.
This collection requires Bearer Authentication. This API request creates a subscription device reconnect request. The change can be requested for one subscription.
Devices: eUICC inventory view
This collection requires Bearer Authentication. This API provides eUICC inventory and their subscriptions information.
This collection requires Bearer Authentication. This API provides a resource to retrieve information about enterprises and to manage them.
Search Subscription Details
This collection requires Bearer Authentication. This API allow to perform a search in the subscription inventory and obtain subscription information.
This collection requires Bearer Authentication. The Shared Bundle API provides resources to retrieve information about an organization usage and limits of shared bundles.
Subscription Change History
This collection requires Bearer Authentication. This API create a request to get subscription change history for a batch of subscriptions
This collection requires Bearer Authentication. This API provides Cell Global Identity (CGI) of a subscription.
Subscription Management - Additional Functions
This collection requires Bearer Authentication. This API provides additional subscription management functions, such as: change subscription owner, change subscription package, change subscription state, change subscription region, query subscription available regions, query sim resource, change alternative roaming profile, cancel SIM order types for: SIM stock order, SIM order, Euicc stock order, Euicc order, subscription profile stock order.
Subscription Signalling Events
This collection requires Bearer Authentication. This low level API provides resources for getting signalling events for subscriptions.
Subscription Signalling Usages
This collection requires Bearer Authentication. This API provides resources for getting aggregated usage reports for subscriptions.
Ticketing Service for Incident Management
This collection requires Bearer Authentication. This API provides a resource for getting information about incidents and manage them.
This collection requires X-access-token. This API provides an interface to consumer connectivity management functionality.
This collection requires X-access-token. This API that provides users with a web application interface, mainly to localize embedded Universal Integrated Circuit Cards (eUICCs) and query subscription data over HTTPS.
This collection requires X-access-token. This API offers a web application interface to perform operations related to the inventory and management of subscriptions.
This collection requires X-access-token. This group of APIs offers an interface to manage users identity.
Preliminary actions: download & install Postman® Client
- Download Postman® Client from here and install it on your PC.
- Launch Postman®.
Preliminary actions: import API & settings
- Download the IoTA REST API Postman® Collection.zip file and extract it.
- In Postman®, click on “Import”.
- In the popup window, import the files:
"T) Business Analytics Report API.postman_collection.json",
"T) Custom fields.postman_collection.json",
"T) Device Reconnect.postman_collection.json",
"T) Devices- eUICC inventory view.postman_collection.json",
"T) Enterprise Management.postman_collection.json",
"T) Search Subscription Details.postman_collection.json",
"T) Shared Bundle.postman_collection.json",
"T) Subscription Change History.postman_collection.json",
"T) Subscription location.postman_collection.json",
"T) Subscription Management - Additional Functions.postman_collection.json",
"T) Subscription Signalling Events.postman_collection.json",
"T) Subscription Signalling Usages.postman_collection.json",
"T) Ticketing Service for Incident Management.postman_collection.json",
"XA) Consumer Connectivity.postman_collection.json",
"XA) Device Localization.postman_collection.json",
"XA) Subscription Management.postman_collection.json",
"XA) User administration.postman_collection.json".
- After importing the file, the APIs will be available in Postman navigation panel under the "Collection" tab.
Preliminary actions: importing the environment
- Now it’s time to setup the IoTA Environment in Postman®. To do this, follow the same procedure to import a file, but this time import the "IOTA REST API ENV.postman_environment.json".
- Click on “Import”.
Now your environment is ready to be used.
Preliminary actions: setting up the environment
- If not already selected, in Postman select “IOTA REST API ENV” from the menu placed in the top right corner box. Then click on the “view (eye) icon” on the right to make the settings active.
- A new window will appear: click “Edit” in the top right corner.
- Enter the information on your IoTA account replacing the <INSERT-HERE> strings as show in the image below
Some of attributes used within the configuration are:
msisdn = SIM Phone number starting with Mobile Country Code
imsi = International Mobile Subscriber Identity (unique number per SIM)
username & password = provided by IoTA for your account
companyID = provided by IoTA for your account
4) Save settings by clicking on “Update Button”. Now you will be able to make your first API call.
Click on "Login" collection and in basis at the types of authentication X-access-token or Bearer token of the Collection to be test send the relative request.
Click on the Collection to be test in the left Navigation Panel, select the method to be test and click on it: the relative API will be opened in the central panel.