This repository provides a postman collection that facilitates learning the Trade Tapp API.
The API supports 3 legged token only.
Postman is a popular tool that provides an easy-to-use interface to send HTTP requests. Postman is able to parse the responses that APS sends you and save response parameter values to variables. These parameters can then be reused in subsequent requests through these variables. The Postman collections in this repository use this ability to provide pre-populated HTTP requests to help you follow the tutorial workflow with minimal effort. You can also modify the requests and experiment without having to write a single line of code.
-
You can learn how to install and use Postman from here.
-
You can download the Postman installer from here.
-
APS Account: Learn how to create a APS Account, activate the subscription and create an app by this tutorial. Get APS client id, client secret and callback url. Please register APS app with the callback url as
https://www.getpostman.com/oauth2/callback
-
Clone this repository or download it. It's recommended to install GitHub Desktop. To clone it via command line, use the following (Terminal on MacOSX/Linux, Git Shell on Windows):
git clone https://github.com/autodesk-platform-services/aps-tradetapp-postman.collection
-
Import the collection and environment files to Postman
-
In environment, input CLIENT_ID and CLIENT_SECRET variables you got from APS into corresponding
Current value
fields: -
In context menu of collection >> Edit, switch to the tab Authorization. Click Get New Access Token, input the variables as below:
-
Grant Type
Authorization Code
-
Callback URL
https://www.getpostman.com/oauth2/callback
-
Auth URL
https://developer.api.autodesk.com/authentication/v1/authorize
-
Access Token URL
https://developer.api.autodesk.com/authentication/v1/gettoken
-
Client ID
{{CLIENT_ID}}
-
Client Secret
{{CLIENT_SECRET}}
-
Scope
data:read
-
-
Click Get New Access Token, it will direct to login Autodesk account, after it succeeds, the token will be generated. Click Use Token.
Trade Tapp API requires to work with 3-legged token. This collection takes Inheriting auth to apply 3-legged token to every endpoint in the collection automatically, which means it does not need to input the token in the header explicitly.
-
Assume the steps of Setup have been performed and the access token is ready.
-
Try running some requests and explore the output:
Blogs:
- APS Blog
- Field of View, a BIM focused blog
Please contact us via https://aps.autodesk.com/en/support/get-help.
This sample is licensed under the terms of the MIT License. Please see the LICENSE file for more details.