User Tools

Site Tools


dev:app_store_example_with_postman

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
dev:app_store_example_with_postman [2016/08/11 14:38] sudev:app_store_example_with_postman [2020/12/03 09:32] (current) su
Line 1: Line 1:
 ====== App Store Example using Postman ====== ====== App Store Example using Postman ======
  
-In this example, we'll use Postman so make authorization request and %%API%% call to the App Store.+In this example, we'll use Postman to make an authorization request and %%API%% call to the App Store.
  
 //Postman is an Web %%API%% testing tool that runs on top of Google Chrome. It can be downloaded for free and provides a practical example of an external app interacting with the Industrial App Store. //Postman is an Web %%API%% testing tool that runs on top of Google Chrome. It can be downloaded for free and provides a practical example of an external app interacting with the Industrial App Store.
Line 12: Line 12:
 === App Store Authentication and API Call Example === === App Store Authentication and API Call Example ===
  
-In our example we'll prepare request the App Store %%API%% method:[[https://appstore.intelligentplant.com/ApiHelp/Api/GET-api-Resource-UserInfo|GET api/Resource/UserInfo]]+In our example we'll prepare request to the App Store %%API%% method:[[https://appstore.intelligentplant.com/ApiHelp/Api/GET-api-Resource-UserInfo|GET api/Resource/UserInfo]]
  
 //This returns info about the logged-in user.// //This returns info about the logged-in user.//
  
-{{ :dev:postman01.png?direct&300 |}}+{{ :dev:postman01.png?direct&600 |}}
  
 If you attempt to execute this directly, you will receive an unauthorized error like the following: If you attempt to execute this directly, you will receive an unauthorized error like the following:
Line 28: Line 28:
 This is because the App Store %%API%% is secured using OAuth2.  This is because the App Store %%API%% is secured using OAuth2. 
  
-To prepare an authorization request, select "Authorization", type "OAuth 2.0" and click "Get New Access Token".+To prepare an authorization request, select: **Authorization OAuth 2.0**
  
-{{ :dev:postman02.png?direct&300 |}}+Specify "add authorization data to request headers"
 + 
 +{{ :dev:postman01b.png?direct&600 |}} 
 + 
 +Then click **Get New Access Token**.
  
 You will be prompted for the following Authorization parameters: You will be prompted for the following Authorization parameters:
  
-| Auth URL | %%https://appstore.intelligentplant.com/AuthorizationServer/OAuth/Authorize%% | +{{ :dev:postman02.png?direct&600 |}} 
-Access Token %%URL%% | %%https://appstore.intelligentplant.com/AuthorizationServer/OAuth/Token%% | + 
-Client ID | [We'll give you this if you ask] | +^ Grant Type | Authorization Code | 
-Client Secret | [We'll give you this if you ask] | +^ Call Back %%URL%% | %%https://app.getpostman.com/oauth2/callback%% | 
-Scope | %%UserInfo%% | +Auth %%URL%% | %%https://appstore.intelligentplant.com/AuthorizationServer/OAuth/Authorize%% | 
-Grant Type | Authorization Code |+Access Token %%URL%% | %%https://appstore.intelligentplant.com/AuthorizationServer/OAuth/Token%% | 
 +Client %%ID%% | [We'll give you this if you ask] | 
 +Client Secret | [We'll give you this if you ask] | 
 +Scope | %%UserInfo%% | 
 +^ Client AuthenticationSend as Basic Auth header | 
  
-This returns the Access Token.+This returns an Access Token.
  
-{{ :dev:postman03.png?direct&300 |}}+{{ :dev:postman03.png?direct&600 |}}
  
 Select "Use Token", try sending the %%API%% request again, and this time we get the %%UserInfo%% result. Select "Use Token", try sending the %%API%% request again, and this time we get the %%UserInfo%% result.
  
-{{ :dev:postman04.png?direct&300 |}}+{{ :dev:postman04.png?direct&600 |}}
  
  
Line 53: Line 62:
 === Summary === === Summary ===
  
-In the above example we used Postman to simulate an external app interacting with the App Store. Postman has been registered with App Storeand thus has been granted the security credentials required of App Store apps.  +In the above example we used Postman to simulate an external app interacting with the App Store. Postman has been registered for use with the App Store and obtained the required security credentials.  
-To register an App, see [] for more info.+For more info, see **[[Dev:Register your App]]**.
  
-Postman exposes the parameters required to make an OAuth2 authorization request. Your application would execute this behind the scenes. See [] for more info.+Postman exposes the parameters required to make an OAuth2 authorization request. Your application should execute this behind the scenes. For more info, see **[[Dev:App Store API Security Overview]]**.
  
-Finally, we used App Store as a means of authenticating users and presenting user-information. However, there is an extensive %%API%% available, including user-account debiting and real-time process data interrogation. See [] for more info.+Finally, we used App Store as a means of authenticating users and presenting user-information. However, there is an extensive %%API%% available, including methods for user-account debiting and real-time process-data interrogation. For more info, see **[[https://appstore.intelligentplant.com/apihelp|App Store API Documentation]]**.
  
  
dev/app_store_example_with_postman.1470926320.txt.gz · Last modified: 2016/08/11 14:38 by su