Basics

Terms

  • Prism Page - Prism version of your content.
  • Prism Server - imports content from the origin and presents to to end-users as Clickio Prism Pages.
  • Prism Data Structure - allows publishers to share data with Prism Server to publish and manage content in Clickio Prism.
  • Origin - the server that responds with the original site content.

Requests from Prism Server

Prism Server sends requests to the Origin for each site URL depending on the chosen integration method to get Prism Data Structure in response.

Prism Server can send requests for all pages types on your site, such as Index, Sections, Articles etc.

Publisher should choose one of the following integration methods.

1. POST request to endpoint

Prism Server sends POST requests to a Content API endpoint (ex: https://yoursite.com/prism-data/) with a POST header:

Content-Url: <URL>

2. GET request to endpoint with ?url= param

Prism Server sends GET requests to a Content API endpoint with the ?url=<%URL%> param.

Example:

https://yoursite.com/prism-data/?url=https://yoursite.com/page/url/

3. GET request to page url with ?prism_data=1 param

Prism Server sends GET requests to page URLs with the GET param ?prism_data=1.

Example:

https://yoursite.com/page/url/?prism_data=1

Responses from the origin to Prism Server

Showing Prism pages

Regardless of the chosen method of sending requests, the Origin must provide a 200 response. The response should contain valid JSON markup.

In the JSON markup, the publisher can declare any supported content types and configure their appearance, position on the page, etc.

Showing original pages

To should the original page instead of the Prism version, the 200 response should contain decline-parameter in the response body:

[{
    "PrismDecline": true
}]

Next Steps