Aggregates API v3 Overview
Programmatically provision and manage sub-tenants (aggregates) under your aggregator store. Each aggregate is a fully independent store with its own domain, catalog, and configuration.
Detailed documentation about API endpoints and parameters
View all tagsProgrammatically provision and manage sub-tenants (aggregates) under your aggregator store. Each aggregate is a fully independent store with its own domain, catalog, and configuration.
Introduction
Manage audio tracks for audiobook content. Tracks are individual audio files (chapters, sections) that make up an audiobook.
Overview
Create multiple content items in a single API call. Files are not processed immediately, processing is triggered on-demand when a user accesses the content (publication page or reader).
Create multiple orders in a single API call. The bulk endpoint processes orders concurrently, making it significantly faster than sequential individual requests.
Overview
This document compares Content API v1 and v3 and provides a practical migration guide for integrators. The v3 feed is designed for speed, bandwidth efficiency, and flexibility via cursor pagination and response shaping (fields and includes).
Manage your store's digital catalog: list, create, update, and delete content items.
Distribute content to other tenants' catalogs using the sharewithtenants_ids field. This allows a content owner to make their content available in other tenants' stores without duplicating the content item.
Provision a new sub-tenant (aggregate) under your aggregator store. The new tenant is created with its own domain, admin user, and store configuration.
Add new content items to your catalog. Supports all content types: PDF, EPUB, audiobooks, physical products, and external links.
Remove content items from your catalog. This operation is permanent and irreversible.
Retrieve the details of a specific sub-tenant (aggregate) by its ID.
Retrieve a specific content item by its internal ID or external ID.
Retrieve a specific order by its UUID or external ID.
Retrieve a paginated list of all sub-tenants (aggregates) under your aggregator store.
Retrieve a paginated list of your store's catalog with powerful filtering, sorting, and response shaping capabilities.
Retrieve a paginated list of orders with powerful filtering, sorting, and response shaping capabilities.
What is the Orders API?
This document provides a comprehensive migration guide from Orders API v1 to v3, including breaking changes, schema differences, and practical migration steps.
Manage customer purchases and content access on your Publica.la platform.
Grant content access without creating payment records. Use when you process payments externally and only need Publica.la for content delivery.
Permission orders grant content access without creating payment records. Use when you handle payments in your own system or for legacy access migration.
Overview
Publica.la exposes automatic redirect endpoints and URL parameters that provide convenient access to content and streamlined purchase flows. These features are useful for deep linking, email campaigns, marketing materials, and integrations where you need predictable URLs that automatically resolve to the correct content or initiate purchases.
Assign content access and create payment records in Publica.la's financial system. Required for marketplace content sales or when you need financial tracking for externally processed payments.
Report orders assign content access and create payment records in Publica.la's financial system. Use for marketplace content sales (requires support enablement) or when you need financial tracking for externally processed sales.
Initiate Publica.la's checkout flow where customers pay directly through the platform. Orders start with pending status and transition to approved after successful payment via integrated payment gateways (Stripe, MercadoPago, etc.).
Sale orders initiate Publica.la's checkout flow where customers pay directly through the platform. Orders start with pending status and transition to approved after successful payment via Stripe or MercadoPago.
The Sessions API provides insights into user interactions with your content, tracking reading sessions and engagement metrics. This feature allows you to retrieve detailed session data, including reading duration and page changes. This section will help you understand how to leverage session data to enhance user experience and content strategy.
Content languages define the language of the content itself (e.g., the language a book is written in). This is different from the store language, which controls the storefront interface.
Manage existing orders by updating expiration dates or canceling access entirely.
Modify the configuration of an existing sub-tenant (aggregate). All fields are optional; only include fields you want to change.
Modify existing content items. Update metadata, pricing, access settings, files, or any other content attributes.
Overview