# Introduction

ParOne is comprised of two parts: a minimalistic golf content feed generator with a robust infrastructure of multiple region CDN throughout the world, and a series of SDKs and libraries optimized for quick integration with existing golf apps and websites. This documentation website was created to support the needs of ParOne's integration projects with our partners. As a result, documentation on this website will be updated frequently to support the numerous ways we can power our partners with golf content.

# Terminology

Before you get started, here's a quick introduction to the terminalogy we use at ParOne.

# Media Outlets

Media Outlets are organizations that create, pay, and push videos to the ParOne Network to scale the distribution of their videos to apps and websites.

# Apps and Websites

Apps and Websites are organizations that receive content of their choosing and integrate ParOne via feeds into their apps and websites. This gives these apps and websites access to the content their users would be otherwise unable to receive as well as increasing utilization and traffic.

# Campaigns

Campaigns are created by Media Outlets that contain video and other data that is sent to feeds. These campaigns are sent as RSS or JSON and contain a number of key/value pairs. Each campaign has a unique campaign ID which you use when you want to display a video in apps and wesbites. An example JSON output is displayed below:

    "campaign_id": 193748, 
    "categories": [
      "ParOne Tour", 
      "News & Tour News"
    "description": "Highlights for the most recent stop of the ParOne Tour .  Check out the team at ParOne as they build something cool.", 
    "end_date": "2021-12-31T00:00:00.000Z", 
    "geo_targets": ["GBR", "USA"], 
    "name": "Highlights of the ParOne Tour", 
    "org_logo": "https://paronecdn.com/logo.png", 
    "org_name": "ParOne", 
    "start_date": "2021-01-28T00:00:00.000Z", 
    "thumbnail": "https://paronecdn.com/thumbnail.jpg", 
    "title": "Highlights from the most recent week of the ParOne Tour", 
    "url": "https://paronecdn.com/video.m3u8"

# Feeds

Feeds are collections of campaigns that apps and websites create to integrate video content their users want. Utilizing ParOne's UI, feeds can control:

  • Desired campaign categories
  • Allowed content publishers
  • Allowed sponsors

Each feed has a feed ID which you use when you want to put a video into your site/app. For information on how to create a feed, please see Create a feed.

# JSON Feed Fields and Values

For reference, here are what the names of the fields in the JSON feed are, their types, and what they mean.

Field Name Field Type Field Value
campaign_id string The ID of the campaign. This is what should go in the video player's block.
categories LIST of strings The categories associated with this campaign
description string A short description from the video.
end_date datetime The date this campaign expires, in UTC
start_date datetime The date this campaign starts, in UTC
geo_targets LIST of strings The countries where the campaign can play. If it's empty it can play anywhere. These are three-letter country codes.
name string The name of the campaign
thumbnail_url URL A URL to the poster frame/thumbnail of the video
title string The video title
url URL The URL of the manifest file. This will not be present in production.
Last Updated: 7/24/2021, 2:08:52 AM