Stream API
Introduction to the Productsup Stream API, glossary, and status page.
The Stream API is the latest addition to the APIs Productsup offers to its clients that follows JSON API standards. Streams support a high throughput or number of items that undergo product changes. Streams can leverage how clients use their data in the Productsup Platform.
The Stream API does not have a PHP library, we maintain an Open API Specification file which can be used to generate a client.
Glossary
| Term | Description |
|---|---|
| Stream | An account-bound space where you can send items via the Stream API. See Streams for more information. |
| Batch | A collection of information about a group of products that you send to Productsup. |
| Site | A location in the Productsup Platform where you import data from a Stream via Data Source. |
| Product | Generic term to indicate data that is sent to the Stream API. The Productsup API does not require you to send only product information. It lets you send different types of data, as long as it follows some minimal requirements. |
| Data Source | A location in the Productsup Platform where you import data from a Stream via Data Source. |
| Productsup Platform | A connection between a Stream and a site. It lets clients select where to import data from. You can set this up in the Productsup platform. |
| Personal Access Token | Means of authentication against our API. Also referred to as PAT. |
Status Page
Our status page provides real-time information on system performance and security. You will find live and historical data on system performance. The Status page will also contain messages on any service interruptions.
You can subscribe on the page to updates and receive notifications via your preferred communication channel.
How is this guide?