DOCSEARCHbyAlgolia
Submit Docs

Publica.la Developer Documentation

website·Indexed 35 days ago

https://docs.publica.la/

Developer resources for the Publica.la platform, featuring REST API references (including v3), content publishing via ONIX intake, and authentication integrations such as SAML 2.0, OpenID Connect (OIDC), and LTI. Includes guides on custom domains, HTTPS certificates, webhooks, IPNs, and embedding the Reader in external applications.

Tokens
66.8K
Snippets
272
Records
425
Agent score
59%

What's inside Publica.la

  1. Overview of Instant Payment Notifications (IPNs)

    Instant Payment Notifications (IPNs) enable payment processors to communicate transaction events directly to a Publica.la store. Unlike standard webhooks sent by the Publica.la platform, IPNs are sent directly from the payment provider, offering faster status changes, provider-specific data formats, and an additional verification layer.

  2. Overview of Publica.la LTI Integration

    Publica.la supports IMS Basic LTI launches version 1.0/1.1 (lti_version = LTI-1p0). This integration allows Publica.la to be embedded as a tool within an LMS, enabling automatic logins (SSO) so users can access the store without a separate login form. The platform uses a POST route for LTI launches: https://{customer-store.com}/auth/lti.

  3. Overview of Publica.la Notification Methods

    Publica.la provides two primary methods for receiving real-time updates about store events such as sales, subscription renewals, and content updates:

    1. Webhooks: Real-time HTTP POST requests sent from Publica.la to a specified endpoint. They feature JWT-based authentication, configurable retries, and support for multiple event types.
    2. Instant Payment Notifications (IPNs): Payment-specific notifications sent directly from payment processors to the user's system, bypassing the Publica.la platform for an additional layer of payment verification.

  4. Overview of Publica.la Auth Token SSO

    The Auth Token integration enables single sign-on (SSO) between an external platform (LMS, e-commerce, CMS) and Publica.la stores. The platform generates a signed JWT containing user information and redirects the user to Publica.la. Publica.la validates the token to grant access, creating new users on first authentication or recognizing existing users via their uuid.

  5. Overview of SAML 2.0 authentication in Publica.la

    SAML (Security Assertion Markup Language) allows institutions to act as the Identity Provider (IdP) to authenticate readers, while the Publica.la store acts as the Service Provider (SP). This ensures readers never share institutional credentials directly with the store. Each reader is assigned their own account. Supported providers include Google Workspace, OpenAthens, Azure AD, and Shibboleth.

  6. Overview of the Aggregates API

    The Aggregates API allows top-level aggregator stores to provision and manage sub-tenants (aggregates). Each aggregate is an independent store with its own domain, catalog, and configuration.

    Key Constraints:

    • Only top-level aggregator stores can use this API; sub-tenants cannot provision other tenants.
    • The 'store aggregation' feature must be enabled by support.
    • Aggregates cannot be deleted via the API; contact support for deactivation.

    Inheritance: New aggregates automatically inherit the aggregator's transaction/sales fee structures and currency configurations. They maintain independent content catalogs, user bases, and store configurations.

  7. Overview of Publica.la AI Reader Features

    Publica.la provides three tiers of reader-facing tools. All AI processing is activated on-demand by the end user; no background processing occurs.

    1. Standard Reader Tools: Always available. Includes Dictionary (word definitions), Translate (text translation), and Text-to-Speech (audio conversion).
    2. AI Comprehension Tools: Enabled by default but can be disabled per publisher. Includes Explain (simplifying text), Expand (providing context), and Summarize (generating summaries of text or page ranges).
    3. Vito AI Assistant: Available on request and activated per publisher. A conversational assistant that generates summaries, creates assessment questions, and answers reader questions based on publication text.

  9. Overview of the Add-ons API

    The Add-ons API allows for the full lifecycle management (CRUD) of interactive add-ons—such as articles, audio, video, images, and links—that are anchored to specific positions in a publication and displayed to readers. Key features include bulk creation (up to 100 add-ons per request), a review lifecycle (draft vs. published), cursor-based pagination, and sanitized rich text for body content.

  10. Overview of IP Range Authentication

    IP Range Authentication allows users to be automatically authenticated without a manual login if their originating IP address matches a configured allowed IP or range. This is available for Enterprise plan subscribers and supports two access modes: Direct (e.g., university networks) and Proxy (e.g., EZProxy).

  11. Overview of Scheduled Automations

    Scheduled automations allow for the publishing of PDF editions from a folder in an S3 bucket on a predefined schedule. This is ideal for predictable calendars (e.g., daily newspapers or weekly magazines) where file naming conventions are preferred over custom code.

    Note: Scheduled automations only support PDF files. For EPUB or audiobook content, use the Content API v3.

  12. Overview of OpenID Connect (OIDC) integration

    The OpenID Connect integration allows a Publica.la store to delegate user authentication to an external Identity Provider (IdP) such as Keycloak, Auth0, Okta, Azure AD, or any standards-compliant OIDC server. The IdP handles the authentication process, and Publica.la consumes the response to provision or link a local account and establish a session. This ensures users never see a Publica.la-native login form.