Add-ons API Overview
Manage the full lifecycle of your publications' add-ons: interactive pieces (articles, audio, video, images, links) anchored to a position in a publication and shown to readers on top of the content.
API version 3 endpoints and features
View all tagsManage the full lifecycle of your publications' add-ons: interactive pieces (articles, audio, video, images, links) anchored to a position in a publication and shown to readers on top of the content.
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.
Manage audio tracks for audiobook content. Tracks are individual audio files (chapters, sections) that make up an audiobook.
Create up to 100 add-ons on one publication in a single request. Bulk items are pure database writes: attach images through the single add-on endpoints.
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.
Share every owned content item that belongs to one or more collections with a list of target tenants in a single API call. The endpoint validates the request synchronously and queues the sharing work in the background.
Manage your store's digital catalog: list, create, update, and delete content items.
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).
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.
Create a single add-on on a publication you own. For batches without images, use the bulk endpoint (up to 100 per request).
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.
Read the publications a list of the target user holds. Any list of the store can be read, private ones included.
Retrieve a specific order by its UUID or external ID.
Retrieve every add-on of a publication you own, drafts included.
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.
Read every list the store shows a given user, or find one of them by id or name.
Retrieve a paginated list of orders with powerful filtering, sorting, and response shaping capabilities.
Read the reading lists of any user of your store, and manage the publications they hold, from your own platform.
Add and remove publications in any list of any user of your store: the favorites list, a custom list the user created, or a list the user collaborates on. What you write here is what the user sees in the storefront and in the reader.
The legacy POST /integration-api/v1/create-article endpoint is deprecated and will be sunset. The Add-ons API v3 replaces it with a complete resource: listing, creation (single and bulk), correction, deletion and a review lifecycle.
Manage customer purchases and content access on your Publica.la platform.
This document provides a comprehensive migration guide from Orders API v1 to v3, including breaking changes, schema differences, and practical migration steps.
Grant content access without creating payment records. Use when you process payments externally and only need Publica.la for content delivery.
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.
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.).
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.
Correct an add-on's content, publish or unpublish it, or remove it.
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.