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 | The smallest structural entity in the platform, and where a stream's data lands. A site holds your imported data, the optimizations you apply to it, and the exports that send it onward. See Create or copy a site. |
| 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 | How product data gets into a site. Importing from a stream requires a Stream API data source on the site, pointing at that stream. See Platform setup. |
| Productsup Platform | The Productsup web application, where you configure projects, sites, data sources, and exports. Distinct from the Stream API, which is how you send data into it. |
| 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. It shows live and historical data on system performance, and publishes messages about any service interruptions.
You can subscribe on the page to updates and receive notifications via your preferred communication channel.
How is this guide?