benedikt-buchert / experience-platform-postman-samples

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Adobe Experience Platform Postman Samples

A repository that collects Postman samples work with Adobe Experience Platform.

Please note this repository is undergoing a migration/normalization to align with Adobe I/O Console's "Export Details to Postman" functionality. The Postman Collections in the following folders has been aligned with the Adobe I/O generated Platform API Postman Environment file:

Goals

The purpose of this repository is to collect Postman samples that show how to interact with Adobe Experience Platform. Each of the samples will use a common Postman Environment file in order to make it easier to switch between separate collections.

Usage

Generate and Import the Postman Environment

  1. Install Postman

  2. Start Postman

  3. Login to Adobe I/O Console, select Integrations, and select the Adobe Experience Platform API Integration you wish to interact with using Postman.

  4. Tap the Export Details to Postman button to have a Postman Environment file with the Integration's details pre-populated.

  5. Select the downloaded Platform API.postman_environment.json file to import the environment.

  6. Now click on the newly imported Platform API.

  7. All of the values with the exception of PRIVATE_KEY should be pre-populated.

  8. Copy the contents of your private.key and use it as the value for PRIVATE_KEY in BOTH the Initial and Current values fields.

    For MacOS & Linux platform

    From the same terminal you ran openssl, execute the following command:

    pbcopy < private.key

    For Windows Platform

    From the same terminal you ran openssl, execute the following command:

    notepad private.key

    Copy the entire key to the keyboard, including the -----BEGIN PRIVATE KEY----- and -----END PRIVATE KEY----- lines.

  9. Click Update and close the Manage Environments dialog.

  10. Now make sure you select the Platform API from the environments drop down at the top right of Postman.

Import the Collection

To import a Postman Collection

  1. Download the .postman_collection.json file(s) from this Github repository
  2. In Postman, select Import int he to left
  3. Select Import File
  4. Select the downloaded .postman_collection.json file(s)

Reference

See also the Medium post on the Adobe Techblog around the usage of Postman with Adobe I/O.

Contributing

Contributions are welcomed! Read the Contributing Guide for more information.

Licensing

This project is licensed under the MIT. See LICENSE for more information.

About

License:MIT License