What is my organization?
An organization is an an Adobe representation of a customer. Any licensed Adobe solutions are integrated with this customer organization. When an organization is entitled to Experience Platform, it can assign access to developers. The organization ID (x-gw-ims-org-id) represents the organization that an API call should be executed for, and is therefore required as a header in all API requests. This ID can be found through the Adobe Developer Console: in the Integrations tab, navigate to the Overview section for any particular integration to find the ID under Client Credentials. For a step-by-step walkthrough of how to authenticate into Experience Platform, see the authentication tutorial.
Where can I find my API key?
An API key is required as a header in all API requests. It can be found through the Adobe Developer Console. Within the console, on the Integrations tab, navigate to the Overview section for a specific integration and you will find the key under Client Credentials. For a step-by-step walkthrough of how to authenticate to Experience Platform, see the authentication tutorial.
How do I get an access token?
Access tokens are required in the Authorization header of all API calls. They can be generated using a CURL command, provided you have access to an integration for an organization. Access tokens are only valid for 24 hours, after which a new token must be generated to continue using the API. For details on generating access tokens, see the authentication tutorial.
How do I use query parameters?
Some Experience Platform API endpoints accept query parameters to locate specific information and filter the results returned in the response. Query parameters are appended to request paths with a question mark (?) symbol, followed by one or more query parameters using the format paramName=paramValue. When combining multiple parameters in a single call, you must use an ampersand (&) to separate individual parameters. The following example demonstrates how a request that uses multiple query parameters is represented in the documentation.
Examples of commonly used query parameters include:
GET /tenant/schemas?orderby=title
GET /datasets?limit=36&start=10
GET /batches?createdAfter=1559775880000&orderBy=desc:created
For detailed information on which query parameters are available for a specific service or endpoint, please review the service-specific documentation.
How do I indicate a JSON field to update in a PATCH request?
Many PATCH operations in Experience Platform APIs use JSON Pointer strings to indicate JSON properties to update. These are typically included in request payloads using JSON Patch format. See the API fundamentals guide for detailed information on required syntax for these technologies.
Can I use Postman to make calls to Experience Platform APIs?
Postman is a useful tool for visualizing calls to RESTful APIs. The Experience Platform API getting started guide contains a video and instructions for importing Postman collections. Additionally, a list of Postman collections for each service is provided.