Introduction
REST API for programmatic access to account management features including projects, sites, channels, and process triggers.
The Platform API is a REST API that provides programmatic access to account management features such as managing projects and sites, listing site errors, triggering processes, and more.
The Platform API does not have a PHP library. Productsup maintains an OpenAPI specification file which you can use to generate a client. See API specification to download it.
Version
Current stable version: 2. Always use the latest version of the API unless otherwise instructed.
What you can do
| Resource | Operations |
|---|---|
| Projects | List, create, edit, and delete projects |
| Sites | List, create, copy, edit, and delete sites |
| Site tags | List, create, and delete site tags |
| Site errors | Retrieve errors for a site or process run |
| Channels | List channels and retrieve channel details |
| Channel history | Retrieve channel export history |
| Import history | Retrieve import history for a site |
| Product data read | Read product data from a site stage |
| Process | Trigger import and export processes |
| Status | Check the processing status of a site |
System status
The Productsup status page provides real-time and historical data on system performance. It also publishes messages for service interruptions.
Subscribe on the page to receive notifications through your preferred channel.
How is this guide?