DOCSEARCHbyAlgolia
Submit Docs

Arc XP Developer Documentation

website·Indexed 35 days ago

https://dev.arcxp.com

Developer guides and API references for the Arc XP platform, including the Compass Web SDK for content recommendations, PageBuilder Engine, Subscriptions and Identity management, and the View and Preview APIs for headless CMS content delivery.

Tokens
221.4K
Snippets
718
Records
1.6K
Agent score
66%

What's inside Arc XP

  2. Overview of the ContentOps API

    The ContentOps API is used to manage the scheduling and execution of publish, unpublish, and delete events for stories, images, and galleries. These operations are discrete and only affect the respective downstream systems (such as Draft or Photo Center) without altering other aspects of the document state. The API is primarily intended for scheduling events to occur in the future.
    Base URL: api.[orgID].arcpublishing.com/contentops/v1

  3. Overview of Arc XP CLI Themes Package

    The Arc XP CLI Themes Package (@arcxp/cli) provides tools for managing blocks.json site settings, deploying theme bundles, and customizing themes. It enables developers to view and convert configuration properties, deploy bundles across environments, create theme forks, and migrate from Themes Settings to PageBuilder Deployer workflows.

  4. Overview of Arc XP Audience Targeting

    Audience Targeting is a server-side tool that allows the curation of tailored digital experiences based on criteria such as Country, Device, and Cookies. Because the targeting decision occurs at the CDN edge server (Edge Network Computing), it is tightly coupled with the Arc XP CDN and cannot be emulated in a local development environment; it must be tested on Arc XP environments.

  5. Overview of Arc XP Content Recommendations Architecture

    Content Recommendations consists of three primary components that manage the flow of data from the CMS to the end-user:

    1. Collector API: A server-side ingest API that receives content and behavioral events. For Arc XP CMS users, this is handled by the platform-managed arc_xp_compass IFX integration.
    2. Catalog and Model: The internal system that processes ingested data to generate recommendations.
    3. Recommendations API: A browser-direct, read-only API that returns a ranked list of items with display-ready card objects using an X-API-Key header.

    The Recommendations block in PageBuilder renders the final reel by calling the Recommendations API.

  6. Overview of Arc XP iOS SDK Video service

    The Arc XP SDK Video service provides tools for fetching, playback, streaming, and customized player views in iOS applications. The primary components are ArcMediaClientManager (used to fetch video content from the backend) and ArcMediaPlayerViewController (used to display the video and manage playback controls).

  8. Overview of Arc XP Video Reference App for Tizen

    The Arc Video Reference App is a set of HTML and JavaScript source files designed to help developers create Samsung Tizen Smart TV applications for streaming video content. It is based on the Arc web player, meaning existing web player documentation applies. Key supported features include adaptive-bitrate delivery, Live Streams, VOD, playlists, Open Measurement Certification for mid-roll ads, server-side inserted ads, closed captions, geographic restrictions, and remote control support.

  9. Overview of Arc XP Subscriptions

    Arc XP Subscriptions is an API-first platform for publishers to manage digital subscriptions and generate reader revenue. It provides a customizable checkout process, supports multiple payment gateways, manages subscription renewals based on publisher-defined billing cadences, and offers reporting capabilities for data-driven decision making.

  10. Overview of the Video Center ecosystem components

    Arc XP Video Center integrates several critical components into a single platform to manage the video lifecycle:

    • Video CMS (VCMS): Handles uploading, encoding/transcoding, permissions, file management, and ad-insertion.
    • CDN: Caches video streams close to end-users to reduce latency and improve retrieval speed.
    • Player: The user interface that decodes and renders the video.
    • Advertising Platform: Integrates with the VCMS to monetize content via ad-insertion.

  12. Overview of Compass Web SDK

    The Compass Web SDK (published as @arcxp/compass-sdk and exposed globally as ArcCompass) is a client-side library used to collect reader interaction events—such as page views, video progress, and clicks—and send them to an event collector to train recommendation models. It can be integrated via a <script> tag for direct browser inclusion or as an npm ESM module for build pipelines (e.g., React or Next.js).