Headless API Services
Overview
The Headless API Platform provides programmatic access to the core capabilities of our publishing platform. These services are primarily used by our own user interfaces, ensuring consistent access to platform functionality across our applications. At the same time, they are designed as general-purpose APIs that enable customers, partners, and third-party applications to integrate directly with the platform's services without relying on the user interface.
Why Headless APIs?
While the platform provides its own user interfaces for managing and publishing product data, many customers need to integrate publishing workflows into their existing systems and operational processes.
The Headless API Platform enables customers to:
- Integrate product data and business information with external systems.
- Start, monitor, and manage Priint:BPM processes from custom applications and integrations.
- Automate deployments and configuration changes across environments.
- Provision and configure publishing infrastructure through scripts and automation tools.
- Retrieve process results, generated assets, and execution status programmatically.
This allows customers to integrate the platform into their existing IT landscape while using its publishing and automation capabilities.
Available APIs
| API | Purpose |
|---|---|
| AdminAPI | Covers the administration and operation of publishing projects through standardized APIs. |
See the AdminAPI documentation for details.
Additional APIs may be introduced in future releases to cover other functional domains.
Target Audience
The Headless API Platform is intended for:
- Customer development teams
- System integrators
- Technology partners
- Third-party software vendors
The APIs enable these consumers to integrate platform capabilities directly into their own solutions instead of relying on the standard platform applications.
Getting Started
To begin using the Headless API Platform:
- Review the Authentication Guide.
- Identify the API that provides the required functionality.
- Explore the available endpoints through the Swagger documentation.
- Integrate using standard HTTP and JSON-based technologies.
For detailed information about a specific API, refer to its dedicated documentation.