...
| Note |
|---|
This documentation is intended for technical users (integrators and developers). |
| Table of Contents | ||
|---|---|---|
|
Overview
The Catalog-API is based on GraphQL. This allows for a type-safe and clearly defined schema while also allowing to query only the data you need.
| Note |
|---|
This documentation assumes familiarity with GraphQL. Please read the official websites website's Introduction to GraphQL to learn about the concepts if you have never worked with GraphQL before. |
...
You can view inline documentation of all the available types in both tools and your local development environment as the GraphQL schema offers direct support for documentation.
The endpoint that GraphQL clients have to use is: https://catalog.purplemanager.com/graphql
Queries
The Catalog-API offers both the Query and Mutation root types.
...
The AppInfo type holds the reference to your appId (the ID of your app or website in our system), the appVersion (the version of your app) and the preview flag (determines if you want preview or live contents).
| Info |
|---|
You can find the appId in the Purple Manager when editing the app. It is currently only visible in the URL:
Here the appId is "01fd7648-10c1-4478-bd98-a7df762f526b" |
DeviceInfo
The DeviceInfo type holds information about the requesting system. The deviceId is used to uniquely identify the system and allow access to previously anonymously purchased contents, e.g. in app stores.
...
Most queries for data support paging using the GraphQL Cursor Connections Specification (arguments first and after). You can identify this by the Connection suffix at the fieldnames which support paging.
| Note |
|---|
All APIs limit the maximum number of entries to 200 per query. If you need to request more data you will need to request pages using the after argument. |
Filtering and sorting
All connections support filtering and sorting the results.
...