General Guidelines

Authentication

All requests must contain an authentication token. This token can be generated on demand and retrieved from the PSS dashboard by the end user. Only one valid token may exist at a time.

Once a customer has been approved for Catalog API usage the authentication token can be requested and retrieved from the PSS dashboard. NOTE: The originating IP address that requests made to the Catalog API must match that entered in to the API Settings page.

Authentication tokens are sent as key/value pairs in the request headers. Please refer to the example requests section.

File Extensions

All requests must end with either the .xml or .json file extension. Data returned to the API Client will be in the formatted accordingly.

Response Status

All successful responses generated by PSS will be delivered to the requestor with a HTTP Status Code 2xx. Please be sure to first verify the status the servers respond with before continuing on to process the data being returned.

All requests will contain a Request parameter that will have a timestamp of the request and a RequestID. Should an error occur, please be sure to record this information so PSS developers can more quickly debug and issue that may arise.

Catalog API Client

To help with the speed of development and ease of integration please refer to the interactive Catalog API Client. This client will only communicate with a sandbox environment and authentication tokens can be created upon request.

A personalized version of this Catalog API Client can be found on your application located at http://<host>/admin/catalog_api/documentation

Feedback and Knowledge Base