Skip to main content

17 docs tagged with "Guide"

Step-by-step guides and implementation tutorials

View all tags

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.

AI Transparency & Data Handling

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.

Content API v1 → v3 Migration Guide

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).

Content Sharing

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 Aggregate

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 Content

Add new content items to your catalog. Supports all content types: PDF, EPUB, audiobooks, physical products, and external links.

Get Aggregate

Retrieve the details of a specific sub-tenant (aggregate) by its ID.

Get Content

Retrieve a specific content item by its internal ID or external ID.

Get Order

Retrieve a specific order by its UUID or external ID.

List Aggregates

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

List Content

Retrieve a paginated list of your store's catalog with powerful filtering, sorting, and response shaping capabilities.

List Orders

Retrieve a paginated list of orders with powerful filtering, sorting, and response shaping capabilities.

Orders API v1 → v3 Migration Guide

This document provides a comprehensive migration guide from Orders API v1 to v3, including breaking changes, schema differences, and practical migration steps.

Update Aggregate

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

X

Graph View