Skip to main content

Curation API

Overview

The Curation API for Zapp enables external systems to control screen structures dynamically. This feature addresses the need for content customization based on user context or specific events. Primarily designed for the home screen, it is adaptable for internal screens as well.

Prerequisites

  1. Create a list of components presets.

Preset Mapping

Similar to screen type mapping, map all the component presets that you plan to use in the curation API. The REFERENCE NAME will be used in the Curation Feed as the preset_name (see bellow for details).

preset-mapping

Implementing The Curation Feed

Add to your custom DSP implementation one or more additional endpoints to each curation feed you would like to create. Each endpoint should return the following response:

{
"entry": [
{
"preset_name": "<REFERENCE_NAME>",
"feed_url": "https://example.com"
},
...
]
}

Read more about Pipes2 implementation here.

Adding Your Curaiton Feed To Your Layout

Add The Curaiton Endpoint & Feed To Zapp

  1. Add the curaiton endpoint to zapp, here is the full guide.

You can add context keys to your endpoint to personlize the results according to the user's specific context.

  1. Add the curtaiton feed to Zapp, here is the full guide.

Add The Super Component To Your Screen

Adding the curation feed is done by using the Super Component which is a container component that randers a list of components from a curation feed.

  1. Go to the relevant layout screen.
  2. Add a new compoent.
  3. Pick the Super Component.
  4. Add your curation feed in the data source field.

Notes and Limitations

  • Feed Behavior: Feeds returning empty entries will not be displayed.
  • Component Restrictions: The Curation component cannot be added to a group.
  • Group Presets: Groups, including group info, can be added as presets.