Giter VIP home page Giter VIP logo

experience-platform-postman-samples's Introduction

Adobe Experience Platform Postman Samples

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.

Install and Setup your Postman App

Generate and Import the Postman Environment

  1. Install Postman

  2. Launch 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. Click 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 the full Adobe Experience Platform Postman Collection do the following:

  1. Download the Adobe Experience Platform.postman_colletion.json file from this Github repository
  2. In Postman, select Import in the upper left of the interface
  3. Select Import File and reference the Adobe Experience Platform.postman.collection.json you downloaded in step 1
  4. You should then see a collection appear in the Postman Collections named Adobe Experience Platform

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.

experience-platform-postman-samples's People

Contributors

chrispanella avatar davidjgonzalez avatar djwendo avatar dlh3 avatar ds-adobe avatar eknee avatar hirenoble avatar jcon3dev avatar jeffchasin avatar ktukker-adobe avatar macdonst avatar pnolan89 avatar tsilver avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

experience-platform-postman-samples's Issues

Adobe I/O Access Token Generation.postman_collection.json is Missing

Expected Behaviour

In the /apis/readme.md it says to use the Adobe I/O Access Token Generation.postman_collection.json to gain an access token. It looks like this file no longer exists in the repo.

Actual Behaviour

Clicking the link in this readme takes me to a broken link. I can't find the actual file I need.

Steps to Reproduce

1.) Go to https://github.com/adobe/experience-platform-postman-samples/tree/master/apis

2.) Click the link under the "Access Token" header named Adobe I/O Access Token Generation.postman_collection.json.

Please note that the solution isn't deleting the link from the Readme. It's providing access to the collection. I really need this for what I'm working on at the moment.

[Idea] Create an "All Postman Collections" zip of AEP API Collections JSON files

@tsilver WDYT about creating a zip file of all the JSON files in, https://github.com/adobe/experience-platform-postman-samples/tree/master/apis/experience-platform and committing it to Git (in the same folder)?

This would be easy enough to do during the Swagger -> Postman Collection generating process and would provide a single-file download to get the latest set of Postman Collections.

Alternatives

Combining the existing Collections for AEP APIs into a single "Uber" postman collection would probably be a difficult/time-consuming and require significant changes to the Swagger -> Postman converter (ie. significant enough where I don't have the time to do them :))

Accept header for Retrieve a schema call doesn't work

Expected Behaviour

Call should be made successfully with the included accept header

Actual Behaviour

The current included accept header for the Retrieve a schema call is "application/vnd.adobe.xed-id+json"
When making a call with this header, the response is:
{
"type": "http://ns.adobe.com/aep/errors/XDM-1007-400",
"title": "Accept header invalid",
"status": 400,
"report": {
"registryRequestId": "d3c91881-5726-4c3a-aae1-a28ecb1a6b9d",
"timestamp": "06-24-2022 04:12:19",
"detailed-message": "The supplied Accept header is not valid: application/vnd.adobe.xed-id+json - A valid Accept value should look like application/vnd.adobe.'{xed|xdm'}+json; version=1 (Version should be specified)",
"sub-errors": []
},
"detail": "The supplied Accept header is not valid: application/vnd.adobe.xed-id+json - A valid Accept value should look like application/vnd.adobe.'{xed|xdm'}+json; version=1 (Version should be specified)"
}

I was able to get a good response by updating the Accept header to:
application/vnd.adobe.xed+json; version=1

Reproduce Scenario (including but not limited to)

Steps to Reproduce

Download the Schema Registry API collection.
Make a call using "Retrieve a schema" and the included Accept header

Platform and Version

Sample Code that illustrates the problem

Logs taken while reproducing problem

Segmentation API - Audience Composition

Expected Behaviour

Have examples of how to use the API to manage Audience Compositions

Actual Behaviour

Currently, there aren't examples of how to use the API to manage Audience Compositions

Reproduce Scenario (including but not limited to)

How to create and remove Audience Compositions by API

Steps to Reproduce

Platform and Version

AEP

Sample Code that illustrates the problem

Logs taken while reproducing problem

Query Service API - Create a query is missing the authorization header

Expected Behaviour

The Create a query in QueryService API is supposed to allow to create and execute a new query by just importing the postman json files and sending the API request (where no additional headers need to be added).

Actual Behaviour

Even with all the required params and request body, the API fails with an authentication error.

QueryServiceAPI_NoAuthHeader

The other requests in this collection work fine, this particular request is missing the Authorization header.

Reproduce Scenario

Download and import the postman file for the Query Service API. When you try to send the request for Create a query API, it fails with the above mentioned error.

Fix

Adding the Authorization header to this request solves the issue.

QueryService API_WithAuthHeader

Wrong swagger basePath in policy-service.yaml?

Hi, while testing the Policy Service API we found out that some of the documentation refers to dulePolicy and some to dulepolicy. The camelcase version gives an 404 - not found.

The swagger basePath refers to the non working camelcase version and the top on the API documentation webpage refers to the working one, non-camelcase version.

https://raw.githubusercontent.com/AdobeDocs/experience-platform-apis/main/src/swagger-specs/policy-service.yaml
https://developer.adobe.com/experience-platform-apis/references/policy-service/

Dataset Service API- Missing requests to check, enable and disable Dataset for Profile and Upsert

Actual Behaviour

The current collection only deals with DULE for Datasets and not the basic operations related to datasets themselves as listed below.

Expected Behaviour

Dataset Service API collection should have the POST , GET and PATCH requests to list, create dataset, check and enable/disable the dataset for Profile (and upsert).

Recommendation

Within Dataset Service API there should be two folders- 'Datasets' , and 'DULE' [just like Schema Registry API has sub folders]

image

I have created and tested the requests above which should be part of basic 'Datasets' folder and request you to incorporate them into the official collection for this API and move the existing ones to the DULE subfolder.
[proposed] Dataset Service API.postman_collection.zip

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.