Differences

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

--- dev:app_store_example_with_postman [2016/08/11 14:38] – su
+++ dev:app_store_example_with_postman [2016/08/24 09:46] – su
@@ Line 1: / Line 1: @@
 ====== App Store Example using Postman ======
-In this example, we'll use Postman so make a 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.
@@ Line 12: / Line 12: @@
 === 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 a 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.//
@@ Line 34: / Line 34: @@
 You will be prompted for the following Authorization parameters:
-| Auth URL | %%https://appstore.intelligentplant.com/AuthorizationServer/OAuth/Authorize%% |
+^ Auth %%URL%% | %%https://appstore.intelligentplant.com/AuthorizationServer/OAuth/Authorize%% |
-| Access Token %%URL%% | %%https://appstore.intelligentplant.com/AuthorizationServer/OAuth/Token%% |
+^ Access Token %%URL%% | %%https://appstore.intelligentplant.com/AuthorizationServer/OAuth/Token%% |
-| Client ID | [We'll give you this if you ask] |
+^ Client %%ID%% | [We'll give you this if you ask] |
-| Client Secret | [We'll give you this if you ask] |
+^ Client Secret | [We'll give you this if you ask] |
-| Scope | %%UserInfo%% |
+^ Scope | %%UserInfo%% |
-| Grant Type | Authorization Code |
+^ Grant Type | Authorization Code |
-This returns the Access Token.
+This returns an Access Token.
 {{ :dev:postman03.png?direct&300 |}}
@@ Line 53: / Line 53: @@
 === Summary ===
-In the above example we used Postman to simulate an external app interacting with the App Store. Postman has been registered with App Store, and 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]]**.