Test the REST API Using Postman

Web API provides most of its function through a REST APIs that integrates with third-party services. This guide explains how to use the test utility, Postman to call these REST APIs.

Postman is not a product of Mitsubishi Electric Iconics Digital Solutions. Updates to Postman may change these steps. If you cannot find a setting described here, see Postman's documentation.

These are the prerequisites to test REST APIs with Postman:

• Web API service is running
• Simulator Point Manager is running
• Postman is installed
• Optional: IIS is running as a reverse proxy
• Optional: IIS is using self-signed certificates or certificates from a verified certificate authority

To test Web API via Postman, follow these steps:

1. Start the Web API service and confirm basic Swagger functionality by following the steps in: How to get detailed API documentation of the calls

2. In Postman, go to File > Settings.

   

3. If you are using the default self-signed certificate, disable SSL certificate verification.

   

4. Enable Send Postman Token header and Automatically follow redirects.

5. Check that your Proxy settings are appropriate for your server. In most cases, you should enable Use system proxy.

   

6. Select Import to read all REST APIs from Swagger.

7. In the text field, enter this url: https://your host name/fwxapi/swagger/v1/swagger.json

   Notes:

   • For HTTPS to work, you need either a self-signed certificate or a certificate from a verified certificate authority
   • When using certificates, you need to use the exact host name or IP address provided by the certificate, not localhost.

   

8. Select Import.

   

   When the import is finished, Postman will create a tree with all imported REST APIs.

   

9. Set the default variable baseUrl to https://hostname which will be used across all REST APIs.

   

10. Go to the Collections tab, expand IcoWeb APIService 1.0 > fwxapi > rest > v1 > Data, and double-click GET Reads a value of a point. Set the pointName parameter to svrsim:sin.

    

11. Go to the Authorization tab and set the following values:

    • Token name: any identifying name, for this example: Web API Token
    • Grant Type: set to Authorization Code (with PKCE)
    • Callback url: http://localhost
    • Auth url: https://your hostname/fwxserverweb/security/connect/authorize
    • Access Token url: https://your hostname/fwxserverweb/security/connect/token
    • Client ID: in_house_client
    • Code Challenge Method: SHA-256
    • Scope: fwxserver
    • Client Authentication: Send as Basic Auth Header

    

12. Select Get New Access Token. Sign in with your administrator account from GENESIS security.

    

13. If the authentication was successful, Postman will display the token details. Select Use Token.

    Do not share the access token text! It can be used to authenticate with your administrator credentials.

    

14. Go to the Settings tab and set the following:

    • HTTP version: HTTP/1.x
    • Enable Automatically follow redirects
    • Enable Encode URL automatically

    

16. Select Send and check the response panel. It should show an HTTP status of: 200 OK