Vimeo OTT API Reference Notes
Introduction
- API Endpoint:
https://api.vhx.tv
- Provides a REST interface to Vimeo OTT for managing products, customers, videos, collections, authorizations, and analytics.
- All API access is over HTTPS, exchanging data in JSON format.
- Supports JSONP and CORS for AJAX requests.
Authentication
API Key
- Use API Key for HTTP Basic Auth.
- API Key serves as the username with no password needed.
VHX-Customer and VHX-Client-IP headers are important for customer-specific API calls.
Hypermedia
- Implements HAL protocol with
_links and _embedded properties for resources.
Error Handling
- Uses standard HTTP status codes like 200 (OK), 400 (Bad Request), 404 (Not Found), etc.
Products
- Represents premium access to video content (subscription, rental, purchase).
Retrieve a Product
- Endpoint:
GET /products/:id
- Requires
href of the product.
List all Products
- Endpoint:
GET /products
- Supports filtering by query, active status, and sort order.
Customers
- Represents a person with access to a product's content.
Create a Customer
- Endpoint:
POST /customers
- Requires
email and product as mandatory arguments.
Retrieve a Customer
- Endpoint:
GET /customers/:id
- Can scope to a specific product.
Videos
- Represents a playable resource with streamable files.
Create a Video
- Endpoint:
POST /videos
- Requires a
title for the video.
Retrieve a Video
- Endpoint:
GET /videos/:id
- Includes metadata and advertising information.
Live Events
- Represents a Vimeo Event with current/upcoming streams and archives.
Retrieve a Live Event
- Endpoint:
GET /live_events/:id
Collections
- Organizes and adds metadata to videos.
- Types include category, series, season, movie, and playlist.
Create a Collection
- Endpoint:
POST /collections
- Requires
type and name.
Retrieve a Collection
- Endpoint:
GET /collections/:id
Analytics
- Provides data on videos, customers, traffic, and platform income.
Retrieve a Report
- Endpoint:
GET /analytics
- Supports types like
traffic, income_statement, units, etc.
Key Arguments across Endpoints
href: Identifier for resources like products, customers, videos.sort, page, per_page: Common filtering and pagination parameters.
This summary provides an overview of the key functionalities and endpoints within the Vimeo OTT API, focusing on authentication, product and customer management, media handling, collections, and analytics capabilities.