37 docs tagged with "Guide"

Manage the full lifecycle of your products' add-ons: interactive pieces (articles, audio, video, images, links) anchored to a position in a product 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.

Publica.la integrates AI capabilities into the reader experience through a suite of tools that help readers comprehend, interact with, and get more value from digital content. This page documents what AI features exist, how data flows through them, what providers are involved, and what controls publishers have.

Overview

Create up to 100 add-ons on one product in a single request. Bulk items are pure database writes: attach images through the single add-on endpoints.

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.

Create and manage your store's bundles: curated sets of your products sold together as a single unit. A bundle only references its products, so its price and availability are computed live from them and never stored.

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.

Create a bundle from 2 to 100 of your products, in a single request.

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 product 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 a bundle from your store, as deleting it from the dashboard does.

Add ?embedded=true to any reader URL to render the Publica.la reader inside an iframe in your application. Embedded mode hides navigation controls that would break the parent page context and adapts the UI to fit within a container.

Retrieve a bundle and, when you ask for them, its products, its price per currency and whether it can be sold right now.

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 every add-on of a product you own, drafts included.

Retrieve a paginated list of all sub-tenants (aggregates) under your aggregator store.

Retrieve the bundles of your store, newest first, with cursor-based pagination.

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.

Read the reading lists of any user of your store, and manage the products they hold, from your own platform.

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.

An ONIX intake ingests your catalog from an ONIX 3.0 feed. We create an SFTP account and a private storage area for you and send you the password; you upload the feed and the content files there, and we create and update the products in your store from what the feed says. Use it when you are onboarding a large catalog, or when your metadata already flows to distributors and retailers as ONIX.

Overview

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.

Overview

A scheduled automation publishes PDF editions from a folder in an S3 bucket on a schedule you define, with no integration to build. Use it when you release on a predictable calendar (a daily newspaper, a weekly magazine) and prefer naming files to a convention over writing code.

Publica.la provides a B2B2C digital publishing SaaS platform: branded ecommerce storefronts plus a secure reading and listening experience delivered through our web reader and our native applications for iOS, Android, macOS, and Windows. The service is fully cloud-based on AWS, fronted by Cloudflare, with no on-premise component required of you or your content partners.

Correct an add-on's content, publish or unpublish it, or remove it.

Change a bundle's details, replace its products, swap or drop its cover, and publish or unpublish it.

Modify the configuration of an existing sub-tenant (aggregate). All fields are optional; only include fields you want to change.