In this lesson, you will configure a Postman environment with environment variables from your new integration and a collection of requests provided by Adobe. Postman is a widely used tool for interacting with APIs and was chosen for this tutorial as a "common denominator" environment for learning the API. Once you are comfortable with the API, can then incorporate them as needed into your own custom environment. If you are new to Postman, we're confident you will quickly get up-to-speed.
In order to complete this lesson, you need to have Developer-level access to Platform
- Get comfortable using Postman
- Explain the environment variables
- Explain the calls in the collection
- Explain the Platform endpoints
Download and Install Postman
If you don't already have it, download and install Postman on your machine.
Add the Postman Collection
- Start Postman. If you are new to Postman, you can opt to create a user account or skip that step to start using the app.
- Click the Import button on the top left.
- Select Import From Link and enter this URL https://raw.githubusercontent.com/adobe/experience-platform-postman-samples/master/Postman%20Collections/Check_Streaming_to_Profile.json
- Click on the Collections tab and you should see the Check Streaming to Profile collection you just added.
Add a Postman Environment
The sample requests in our Collection refer to numerous global variables. We need to create a Postman Environment which will store the values of these global variables so we can successfully make the API requests. The Environment will store details of our Adobe I/O Integration, among other values. If you are a user who supports multiple Platform organizations, you can create an environment for each organization you support and use the same Collection to make Platform requests.
- Download the Adobe Experience Platform Postman environment json .
- In Postman, click on the settings icon to open the Manage Environments dialog.
- Click on Import
- Click on Choose Fles and
- Select the Adobe Experience Platform.postman_environment.json file you just downloaded
- Click Add
- Click on the newly created Adobe Experience Platform environment from the dropdown on the top right
- Using the values from the Adobe I/O integration you created in the last lesson, complete the values for the following, putting them in both the "Initial Values" and the "Current Values" fields. :
- Copy the contents of the private.key and use it as the value for secret . To copy the contents, from the same terminal you ran openssl , execute the following command:
pbcopy < private.keyPaste the contents of the clipboard into the secret field, include the -----BEGIN PRIVATE KEY----- and -----END PRIVATE KEY----- lines up to the last - . When you paste the contents of the clipboard into Postman you may end up with an extra new line character. Delete this newline character or it will prevent you from making API calls later on.
- Complete the ldap field using your Adobe Id. This field will be used to to uniquely identify the datasets you create.
- Click Update and close the Manage Environments dialog.
- Now make sure you select the Adibe Experience Platform from the environments drop down at the top right of Postman.
- From our newly imported collection, open Auth Setup and click on INIT: Load Crypto Library for RS256 .
- Now you are ready to generate an JWT and bearer token to interact with Adobe I/O. In order to make this process easier we'll be using an Adobe I/O Runtime action. Click on IMS: JWT Generate + Auth via User Token . Then click on the body tab:
All of that work you did to setup the environment has been put to good use. Each Postman call will take advantage of these values.
- Now click Send and scroll down to the response section:That JSON response includes an access_token which is the Bearer token used to authenticate with Adobe I/O. The Postman call will save this value in an environment variable for future use.
Whew! We are finally ready to start calling the Adobe Experience Platform API's for real. We've run through creating an integration and getting authenticated.