### Playback API - Getting Started Source: https://apis.support.brightcove.com/ssai/getting-started Guides for getting started with the Playback API, including an overview, quick start, and best practices. ```APIDOC ## Overview: Playback API ### Description An introduction to the Brightcove Playback API, detailing its purpose in delivering video content. ### Method (Details not provided in source text) ### Endpoint (Details not provided in source text) ### Parameters (Details not provided in source text) ### Request Example (Details not provided in source text) ### Response #### Success Response (200) (Details not provided in source text) #### Response Example (Details not provided in source text) ``` ```APIDOC ## Quick Start: Playback API ### Description A practical guide to quickly begin using the Brightcove Playback API to deliver video content. ### Method (Details not provided in source text) ### Endpoint (Details not provided in source text) ### Parameters (Details not provided in source text) ### Request Example (Details not provided in source text) ### Response #### Success Response (200) (Details not provided in source text) #### Response Example (Details not provided in source text) ``` ```APIDOC ## Best Practices: CMS and Playback APIs ### Description Recommendations and best practices for effectively using the Brightcove CMS and Playback APIs together. ### Method (Details not provided in source text) ### Endpoint (Details not provided in source text) ### Parameters (Details not provided in source text) ### Request Example (Details not provided in source text) ### Response #### Success Response (200) (Details not provided in source text) #### Response Example (Details not provided in source text) ``` -------------------------------- ### NextGen Live API - Getting Started Source: https://apis.support.brightcove.com/ssai/getting-started Guides for getting started with the NextGen Live API, including an overview and quick start instructions. ```APIDOC ## Overview: NextGen Live API ### Description An introductory overview of the NextGen Live API, its capabilities, and use cases. ### Method (Details not provided in source text) ### Endpoint (Details not provided in source text) ### Parameters (Details not provided in source text) ### Request Example (Details not provided in source text) ### Response #### Success Response (200) (Details not provided in source text) #### Response Example (Details not provided in source text) ``` ```APIDOC ## Quick Start: NextGen Live API ### Description A step-by-step guide to quickly begin using the NextGen Live API. ### Method (Details not provided in source text) ### Endpoint (Details not provided in source text) ### Parameters (Details not provided in source text) ### Request Example (Details not provided in source text) ### Response #### Success Response (200) (Details not provided in source text) #### Response Example (Details not provided in source text) ``` -------------------------------- ### OAuth API - Getting Started Source: https://apis.support.brightcove.com/ssai/getting-started Guides for getting started with the OAuth API, including an overview and quick start instructions. ```APIDOC ## Overview: OAuth API ### Description An introduction to the Brightcove OAuth API, explaining its purpose and how it enables secure access to Brightcove services. ### Method (Details not provided in source text) ### Endpoint (Details not provided in source text) ### Parameters (Details not provided in source text) ### Request Example (Details not provided in source text) ### Response #### Success Response (200) (Details not provided in source text) #### Response Example (Details not provided in source text) ``` ```APIDOC ## Quick Start: OAuth API ### Description A practical guide to quickly begin using the Brightcove OAuth API for authentication and authorization. ### Method (Details not provided in source text) ### Endpoint (Details not provided in source text) ### Parameters (Details not provided in source text) ### Request Example (Details not provided in source text) ### Response #### Success Response (200) (Details not provided in source text) #### Response Example (Details not provided in source text) ``` -------------------------------- ### Getting Started and Learning Resources Source: https://apis.support.brightcove.com/live-api/getting-started/index Comprehensive guides and resources for getting started with Brightcove Platform APIs. Includes overview documentation, training videos, code samples, and learning guides. ```APIDOC ## Getting Started with Brightcove Platform APIs ### Description Comprehensive resources and guides for learning and implementing Brightcove Platform APIs. ### Core Getting Started Resources - **Overview: Platform APIs** - Introduction to all available APIs - **Learning Guide: Using the REST APIs** - Step-by-step REST API guide - **Testing Tools for Brightcove APIs** - Tools for testing and debugging - **Index of Platform API Code Samples** - Directory of code examples ### API-Specific Overviews - **Overview: Analytics API** - Introduction to analytics capabilities - **Overview: Audience API** - Introduction to audience management - **Overview: Channels API** - Introduction to Cloud Playout channels - **Overview: EPG API** - Introduction to electronic program guides - **Overview: CMS API** - Introduction to content management ### Learning Materials - **Platform API Code Samples** - Practical code examples - **Platform API Training Videos** - Video tutorials and walkthroughs - **Practice Area: CMS API** - Hands-on practice environment ### Integration Guides - **Integrating Your CMS with Video Cloud** - CMS integration best practices - **Best Practices: CMS and Playback APIs** - Recommended implementation patterns ### Reference Materials - **All API References** - Complete API reference documentation - **Platform APIs Known Issues** - Known limitations and issues - **Release Notes** - Latest updates and changes ### Support Resources - **FAQ** - Frequently asked questions - **Error Reference** - Error codes and troubleshooting - **Glossary** - API terminology and definitions ``` -------------------------------- ### Getting Started with Platform APIs Source: https://apis.support.brightcove.com/search_q=%2F_site%2Fplayer-management%2Fcode-samples%2F An introductory guide for new users of the Brightcove Platform APIs, covering essential setup and concepts. ```APIDOC ## Getting Started with Platform APIs ### Description This section is designed for developers new to the Brightcove Platform APIs. It covers the essential steps and concepts needed to begin integrating with Brightcove services. ### Key Topics - **Overview: Platform APIs**: A high-level introduction to the capabilities of Brightcove's platform APIs. - **Authentication for API Requests**: Essential information on how to authenticate your API calls. - **Testing Tools for Brightcove APIs**: Recommendations for tools to test your API integrations. - **Learning Guide: Using the REST APIs**: A guide to understanding and utilizing RESTful principles with Brightcove APIs. - **Index of Platform API Code Samples**: A catalog of code examples for various API functionalities. ``` -------------------------------- ### Cloud Playout APIs - Getting Started Source: https://apis.support.brightcove.com/playback-authorization/getting-started Guides for getting started with Cloud Playout APIs, focusing on Channels and EPG management. ```APIDOC ## Cloud Playout APIs ### Description APIs for managing live channels and electronic program guides (EPG). ### Getting Started * Overview: Channels API * Overview: EPG API * EPG API: Best Practices * Searching for Channels ``` -------------------------------- ### Setup for Player Management Samples Source: https://apis.support.brightcove.com/dynamic-ingest/getting-started/index This is a setup guide to prepare for using Player Management API examples. It outlines the preliminary steps needed before using subsequent code samples. The setup ensures that all dependencies are in place. ```Example { "code": "// Code for setting up Player Management samples goes here." } ``` -------------------------------- ### NextGen Live API - Getting Started Source: https://apis.support.brightcove.com/search_q=%2F_site%2Fdelivery-rules%2Fgetting-started%2F Guides for getting started with the NextGen Live API, including overviews and quick start instructions. ```APIDOC ## Overview: NextGen Live API ### Description An introduction to the NextGen Live API, covering its capabilities and benefits for modern live streaming workflows. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ### Link [Link to NextGen Live API Overview] ``` ```APIDOC ## Quick Start: NextGen Live API ### Description A step-by-step guide to help you quickly set up and start using the NextGen Live API. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ### Link [Link to NextGen Live API Quick Start] ``` -------------------------------- ### NextGen Live API - Quick Start Source: https://apis.support.brightcove.com/unused/ingest-profiles-legacy A step-by-step guide to getting started with the NextGen Live API, including initial setup and basic operations. ```APIDOC ## Quick Start: NextGen Live API ### Description This quick start guide walks you through the essential steps to begin using the NextGen Live API. It covers authentication, creating your first live stream, and basic playback configuration. ### Method [GET, POST, PUT, DELETE depending on the step] ### Endpoint [Specific endpoints for quick start actions] ### Parameters [Parameters relevant to the quick start steps] ### Request Example [Example requests for initial setup] ### Response #### Success Response - **message** (string) - Confirmation of successful operation. #### Response Example ```json { "message": "Live stream created successfully." } ``` ``` -------------------------------- ### NextGen Live API - Getting Started Source: https://apis.support.brightcove.com/social-syndication/references/release-notes Guides to help you get started with the NextGen Live API, including an overview and a quick start guide. ```APIDOC ## Overview: NextGen Live API ### Description This document provides a high-level overview of the NextGen Live API, its capabilities, and use cases. It introduces the core concepts and benefits of using the NextGen Live API for managing live streaming events. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Quick Start: NextGen Live API ### Description A step-by-step guide to help you quickly set up and make your first API call with the NextGen Live API. This guide covers authentication and a basic stream creation example. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### Platform APIs - Getting Started Source: https://apis.support.brightcove.com/images/getting-started/overview Guides for getting started with Brightcove Platform APIs, including authentication, testing tools, and learning resources. ```APIDOC ## Platform APIs - Getting Started ### Description Resources to help you begin using Brightcove's Platform APIs, covering essential concepts and tools. ### Overview * Overview: Platform APIs ### Authentication * Authentication for API Requests ### Testing Tools * Testing Tools for Brightcove APIs ### Learning Resources * Learning Guide: Using the REST APIs * Index of Platform API Code Samples ``` -------------------------------- ### Quick Start: NextGen Live API Source: https://apis.support.brightcove.com/xdr/references A concise guide to help you get started quickly with the NextGen Live API, covering essential setup and initial operations. ```APIDOC ## Quick Start: NextGen Live API ### Description A step-by-step tutorial to help developers begin using the NextGen Live API, including authentication, basic configurations, and making your first API calls. ### Method N/A (Tutorial) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### Dynamic Ingest API - Getting Started Source: https://apis.support.brightcove.com/unused/dynamic-ingest-legacy/index Provides essential guides for getting started with the Dynamic Ingest API, including overviews, quick start guides, and migration information. ```APIDOC ## Dynamic Ingest API - Getting Started ### Description This section covers the initial steps for using the Dynamic Ingest API. It includes an overview, a quick start guide, and instructions for migrating from older systems to Dynamic Delivery. ### Method N/A (Documentation overview) ### Endpoint N/A (Documentation overview) ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### Playback API - Getting Started Source: https://apis.support.brightcove.com/search_q=guides-index Introduction and quick start guide for the Brightcove Playback API. ```APIDOC ## Playback API - Getting Started ### Overview: Playback API **Description**: An introduction to the Brightcove Playback API for delivering video content. ### Quick Start: Playback API **Description**: A step-by-step guide to get started quickly with the Playback API. ### Best Practices: CMS and Playback APIs **Description**: Recommended best practices when using the CMS and Playback APIs together. ``` -------------------------------- ### Live API - Getting Started Source: https://apis.support.brightcove.com/search_q=using-live-rtmp-outputs-stream-facebook-and-youtube Guide on how to get started using the Live API for creating live streams. ```APIDOC ## Live API - Getting Started ### Description Provides instructions and overview for using the Brightcove Live API. ### Overview This section covers the basics of interacting with the Live API to manage live streams. ### Creating a Live Stream using the API Refer to the specific API documentation for creating live streams, including required parameters and request formats. ``` -------------------------------- ### OAuth API - Getting Started Source: https://apis.support.brightcove.com/ipx Introduction and quick start guide for the OAuth API, covering its purpose and initial setup. ```APIDOC ## OAuth API - Getting Started ### Overview: OAuth API An introduction to the OAuth API, explaining its role in authentication and authorization. ### Quick Start: OAuth API A practical guide to quickly begin using the OAuth API for authentication purposes. ``` -------------------------------- ### OAuth API - Quick Start Source: https://apis.support.brightcove.com/data-collection/code-samples A quick start guide to help developers get started with the OAuth API, covering initial setup and common tasks. ```APIDOC ## Quick Start: OAuth API ### Description This guide offers a quick start for integrating the Brightcove OAuth API. It covers the essential steps to obtain authorization credentials and access tokens, enabling secure API interactions. ### Method N/A (Conceptual guide) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### Platform APIs - Getting Started Source: https://apis.support.brightcove.com/playback-authorization/getting-started Guides for new users of the Brightcove Platform APIs, covering overview and authentication. ```APIDOC ## Platform APIs ### Description APIs that provide access to core Brightcove platform functionalities. ### Getting Started * Overview: Platform APIs * Authentication for API Requests * Testing Tools for Brightcove APIs * Learning Guide: Using the REST APIs * Index of Platform API Code Samples ``` -------------------------------- ### NextGen Live API - Quick Start Source: https://apis.support.brightcove.com/cms/managing-videos/cms-api-working-folders A quick guide to getting started with the NextGen Live API, including initial setup and basic operations. ```APIDOC ## Quick Start: NextGen Live API ### Description Follow this quick start guide to begin using the NextGen Live API. It covers authentication, creating a basic live event, and starting a stream. ### Method POST, GET ### Endpoint - Authentication: `/oauth/access_token` (example) - Create Event: `/v2/accounts/{accountId}/live_events` (example) ### Parameters #### Path Parameters - **accountId** (string) - Required - Your Brightcove account ID. #### Query Parameters None #### Request Body (Create Event Example) - **name** (string) - Required - Name for the live event. - **schedule** (object) - Optional - Event schedule details. ### Request Example (Create Event - JavaScript) ```javascript // Assumes you have obtained an access token const accountId = 'YOUR_ACCOUNT_ID'; const accessToken = 'YOUR_ACCESS_TOKEN'; const apiUrl = `https://api.bcovlive.io/v2/accounts/${accountId}/live_events`; fetch(apiUrl, { method: 'POST', headers: { 'Content-Type': 'application/json', 'Authorization': `Bearer ${accessToken}` }, body: JSON.stringify({ "name": "My Quick Start Event" }) }) .then(response => response.json()) .then(data => console.log('Live Event Created:', data)) .catch(error => console.error('Error:', error)); ``` ### Response #### Success Response (200 - Create Event) - **id** (string) - The ID of the created live event. - **name** (string) - The name of the live event. #### Response Example (Create Event) ```json { "id": "ngl_evt_xyz789", "name": "My Quick Start Event" } ``` ``` -------------------------------- ### OAuth API - Getting Started Source: https://apis.support.brightcove.com/xdr/getting-started/xdr-overview An introduction to the OAuth API, covering an overview and quick start guide for authentication and authorization. ```APIDOC ## Overview: OAuth API ### Description The Brightcove OAuth API allows you to implement secure authorization for your applications, enabling them to access Brightcove services on behalf of users or on their own behalf. ### Method GET ### Endpoint /oauth/v1/overview ### Parameters None ### Request Example None ### Response #### Success Response (200) - **title** (string) - Title of the overview. - **description** (string) - Detailed description of the OAuth API. - **endpoints** (object) - Key endpoints and their purposes. #### Response Example ```json { "title": "OAuth API Overview", "description": "Securely authorize applications to access Brightcove services.", "endpoints": { "authorize": "/oauth/v1/authorize", "token": "/oauth/v1/token" } } ``` ``` ```APIDOC ## Quick Start: OAuth API ### Description This guide provides a step-by-step process to get started with the OAuth API, including registering an application and obtaining access tokens. ### Method POST ### Endpoint /oauth/v1/token ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **grant_type** (string) - Required - Type of grant (e.g., `client_credentials`, `authorization_code`). - **client_id** (string) - Required - Your application's client ID. - **client_secret** (string) - Required - Your application's client secret. - **redirect_uri** (string) - Required for `authorization_code` grant - The URI to redirect the user to after authorization. - **code** (string) - Required for `authorization_code` grant - The authorization code received from the user. ### Request Example (Client Credentials) ```json { "grant_type": "client_credentials", "client_id": "YOUR_CLIENT_ID", "client_secret": "YOUR_CLIENT_SECRET" } ``` ### Response #### Success Response (200) - **access_token** (string) - The access token for API requests. - **token_type** (string) - The type of token (e.g., `Bearer`). - **expires_in** (integer) - The token's lifetime in seconds. #### Response Example ```json { "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "token_type": "Bearer", "expires_in": 7200 } ``` ``` -------------------------------- ### Python GET Request Example Source: https://apis.support.brightcove.com/ipx Demonstrates how to perform a GET request using Python. This is a fundamental example for interacting with web APIs, showing basic request setup and response handling. It assumes the `requests` library is installed. ```python import requests # Example: Making a GET request to a hypothetical API endpoint api_url = "https://api.example.com/data" params = { "key": "value" } try: response = requests.get(api_url, params=params) response.raise_for_status() # Raise an exception for bad status codes (4xx or 5xx) data = response.json() # Parse the JSON response print("Success!") print(data) except requests.exceptions.RequestException as e: print(f"Error making request: {e}") except ValueError as e: # Includes JSONDecodeError print(f"Error decoding JSON response: {e}") ``` -------------------------------- ### Platform APIs - Getting Started Source: https://apis.support.brightcove.com/social-syndication/references/syndication-api-release-notes Comprehensive getting started guide for Brightcove Platform APIs including authentication, testing tools, REST API fundamentals, and code sample index. ```APIDOC ## Platform APIs - Getting Started ### Description Initial setup and foundational information for working with Brightcove Platform APIs. ### Overview - **Platform APIs Overview** - Introduction to available APIs - **Authentication for API Requests** - Authentication mechanisms and setup - **Testing Tools for Brightcove APIs** - Available testing utilities - **Learning Guide: Using the REST APIs** - REST fundamentals - **Index of Platform API Code Samples** - Browse available samples ### Integration and Setup - **Integrating Your CMS with Video Cloud** - CMS integration guide - **Managing API Authentication Credentials** - Credential management - **All API References** - Complete API reference index - **Platform API Code Samples** - Sample code repository - **Platform API Training Videos** - Video tutorials ### Support Resources - **Platform APIs Known Issues** - Known limitations and issues - **Release Notes** - Latest API updates and changes - **FAQ** - Frequently asked questions by API ### Best Practices - **Best Practices: CMS and Playback APIs** - CMS/Playback integration patterns - **CMS API Notifications** - Event notification configuration - **Catalog Search Architecture** - Search implementation guide ``` -------------------------------- ### Cloud Playout APIs - Getting Started Source: https://apis.support.brightcove.com/search_q=step-step-using-live-module-open-broadcaster-software-obs Guides for starting with Cloud Playout APIs, focusing on Channels API and EPG API. ```APIDOC ## Getting Started with Cloud Playout APIs ### Description This section guides users through the initial setup and usage of the Cloud Playout APIs, including the Channels API and EPG API. ### Endpoints - `/cloud-playout/channels/overview` - `/cloud-playout/epg/overview` - `/cloud-playout/epg/best-practices` - `/cloud-playout/channels/search` ``` -------------------------------- ### Setup for Player Management Samples Source: https://apis.support.brightcove.com/search_q=%2F_site%2Fdata-collection%2Fgetting-started%2F This section outlines the necessary setup steps and prerequisites for running the provided Player Management API code samples. It ensures that the environment is correctly configured. ```Bash # Ensure you have your Brightcove API credentials (Client ID and Secret) # and have enabled the Player Management API for your account. # You might need to install tools like 'curl' or 'jq' for interacting with the API. ``` -------------------------------- ### Getting Started with the NextGen Live API Source: https://apis.support.brightcove.com/search_q=live-auto-captions Guides users on how to get started with the NextGen Live API, including an overview and a quick start guide. ```APIDOC ## Getting Started with the NextGen Live API ### Description This section provides instructions for getting started with the NextGen Live API. It includes an overview of the API and a quick start guide to help users begin using its features. ### Method Not specified in the provided text. ### Endpoint Not specified in the provided text. ### Parameters Not specified in the provided text. ### Request Example Not specified in the provided text. ### Response Not specified in the provided text. ``` -------------------------------- ### NextGen Live API - Quick Start Source: https://apis.support.brightcove.com/ingest-profiles/references/ingest-profiles-api-fields-reference-dynamic-delivery-and-context-aware-encoding A quick guide to get started with the NextGen Live API, covering essential steps for initial setup and basic operations. ```APIDOC ## Quick Start: NextGen Live API ### Description A step-by-step guide to quickly begin using the NextGen Live API, including authentication and making your first API call. ### Method GET, POST (for initial setup and requests) ### Endpoint Base URL: `https://api.enterprise.brightcove.com/v1/` (example, may vary) ### Parameters #### Path Parameters None specific to quick start. #### Query Parameters None specific to quick start. #### Request Body Depends on the operation (e.g., creating an event). ### Request Example 1. Obtain API credentials (Client ID, Client Secret). 2. Authenticate to get an access token. 3. Make a `POST` request to create a live event. ```javascript // Pseudocode for authentication and first call const token = getAccessToken(clientId, clientSecret); const eventDetails = { "name": "Quick Start Live Event" }; createLiveEvent(token, eventDetails); ``` ### Response #### Success Response (200 or 201) Details of the requested resource or operation status. #### Response Example (Varies based on the API call made) ``` -------------------------------- ### Setup for Player Management Samples Source: https://apis.support.brightcove.com/search_q=getting-started-index This is a setup guide for using the Player Management API code samples. It outlines the prerequisites and initial steps required before running the samples. ```javascript // Ensure you have obtained an access token with the appropriate scopes (e.g., video-cloud:read, video-cloud:write) // Store your account ID and access token securely const accountId = 'YOUR_ACCOUNT_ID'; const accessToken = 'YOUR_ACCESS_TOKEN'; ``` -------------------------------- ### In-Page Experience API: Getting Started Example Source: https://apis.support.brightcove.com/general/features/overview-forensic-watermarking Quick start guide for the In-Page Experience Platform (REST) API. This API allows for managing and delivering in-page experiences. ```json { "request_type": "get_experience", "experience_id": "YOUR_EXPERIENCE_ID" } ``` -------------------------------- ### NextGen Live API - Quick Start Source: https://apis.support.brightcove.com/search_q=%2F_site%2Fssai%2Fgetting-started%2F A quick start guide to help you begin using the NextGen Live API, covering initial setup and basic operations. ```APIDOC ## Quick Start: NextGen Live API ### Description A step-by-step guide to help developers quickly get started with the NextGen Live API, including authentication, making initial API calls, and common use cases. ### Method N/A (Getting Started) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### NextGen Live API - Quick Start Source: https://apis.support.brightcove.com/player-management/code-samples/setup-player-management-samples A quick start guide to help developers begin using the NextGen Live API with minimal setup. ```APIDOC ## Quick Start: NextGen Live API ### Description This guide provides the essential steps and information needed to quickly start integrating with the NextGen Live API. It covers authentication, basic operations, and common use cases. ### Method N/A (Quick Start Guide) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### Getting Started with Brightcove APIs Source: https://apis.support.brightcove.com/search_q=dynamic-ingest-api-sample-re-transcoding-videos-legacy-ingest Comprehensive getting started guide covering platform API overview, authentication setup, REST API fundamentals, and available testing tools. Includes learning resources and code sample index for rapid API integration. ```APIDOC ## Getting Started with Brightcove Platform APIs ### Initial Setup #### 1. Platform Overview - Brightcove Platform APIs architecture - Available API services and endpoints - API capabilities and use cases - Account setup requirements #### 2. Authentication Setup - OAuth 2.0 authentication configuration - API credential creation and management - Token generation workflow - Credential security best practices #### 3. REST API Fundamentals - HTTP method usage (GET, POST, PUT, DELETE, PATCH) - Request/response format - Error handling and status codes - Rate limiting and quotas ### Available Testing Tools - Online API Tester - Browser-based testing - Postman - API collection and automation - Insomnia - REST client with environment support - cURL - Command-line interface ### CMS Integration - Integrating Your CMS with Video Cloud - Content synchronization workflows - Metadata mapping and transformation - Automated content management ### Learning Resources #### Documentation - Learning Guide: Using the REST APIs - API Reference documentation - Feature-specific guides - Best practices documentation #### Code Samples - Index of Platform API Code Samples - Language-specific examples - Common use case implementations - Integration patterns #### Training - Platform API Training Videos - Video tutorials for each API - Workflow demonstrations - Integration examples ### Support Resources - Platform APIs Known Issues - FAQ documentation - Error reference guides - Release notes and updates - Developer forums and community ``` -------------------------------- ### Playback API - Quick Start Source: https://apis.support.brightcove.com/unused/ingest-profiles-legacy/guides/index Get started quickly with the Playback API using this guide. ```APIDOC ## Quick Start: Playback API ### Description A fast-track guide to help developers quickly integrate video playback using the Brightcove Playback API. ### Method N/A (This is a conceptual guide, not a specific endpoint) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### NextGen Live API Quick Start Source: https://apis.support.brightcove.com/xdr/references/index A quick start guide to help developers begin using the NextGen Live API with minimal setup. ```APIDOC ## Quick Start: NextGen Live API ### Description Follow this guide to quickly set up and make your first API calls with the NextGen Live API. ### Method N/A (Quick Start Guide) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### Quick Start: Dynamic Ingest API Source: https://apis.support.brightcove.com/search_q=standard-live-ingest-profiles Get started with the Dynamic Ingest API by learning how to add videos to Video Cloud using CURL commands. This quick start guide walks through the essential steps and credential setup. ```APIDOC ## Quick Start: Dynamic Ingest API ### Description Walkthrough for adding videos to Video Cloud using the Dynamic Ingest API via CURL command-line interface. ### Main Functions The Dynamic Ingest API enables you to: - Add videos to Video Cloud - Upload associated media assets (thumbnails, posters) - Specify transcoding profiles and renditions - Set video metadata and custom fields - Manage ingestion priorities and workflows ### Steps 1. **Get Client Credentials**: Obtain API credentials from Brightcove 2. **Generate Access Token**: Use credentials to request OAuth 2.0 token 3. **Prepare Video Source**: Identify video file location (URL, S3, etc.) 4. **Create Ingest Request**: Construct Dynamic Ingest API payload 5. **Submit via CURL**: Execute POST request with video details 6. **Monitor Status**: Check job progress using status endpoint 7. **Verify Results**: Confirm video appears in Video Cloud account ### Get Client Credentials - Navigate to Brightcove API authentication settings - Create OAuth 2.0 credentials for Dynamic Ingest API - Store client ID and client secret securely - Generate access tokens using credential flow - Include token in API request headers ### CURL Example ``` curl -X POST https://ingest.api.brightcove.com/v1/accounts/{account_id}/videos \ -H "Authorization: Bearer {access_token}" \ -H "Content-Type: application/json" \ -d '{"name":"Video Title","description":"Video Description"}' ``` ``` -------------------------------- ### Setup for Player Management Samples Example Source: https://apis.support.brightcove.com/analytics/general/multi-cdn-analytics Demonstrates the initial setup required to use the Player Management API samples. This might include authentication, environment configuration, and importing necessary libraries. Proper setup is essential before implementing any Player Management tasks. ```Unknown Code Sample: Setup for Player Management Samples ``` -------------------------------- ### OAuth API - Quick Start Source: https://apis.support.brightcove.com/search_q=%2F_site%2Fdelivery-system%2F Get started with the OAuth API to obtain client credentials and access tokens. This tutorial guides you through authentication setup using cURL. ```APIDOC ## OAuth API - Get Client Credentials ### Description Obtain client_id and client_secret credentials using the OAuth API. These credentials are required to request access tokens for authenticating to Brightcove APIs. ### Requirements - cURL (built-in on MacOS and Linux/Unix systems) - Brightcove account with API access - Valid account credentials ### Authentication Workflow 1. Get client credentials (client_id and client_secret) 2. Use credentials to request access token 3. Include access token in API requests ### Base URL https://oauth.brightcove.com/v4 ### Typical Flow - Create client credentials for your API integration - Request access token using credentials - Use access token to authenticate API calls - Refresh token when expired ### Related Endpoints - POST /oauth/token - Request access token - Manage client credentials in Brightcove Studio ``` -------------------------------- ### Getting Started - Learning Guide: Using the REST APIs Source: https://apis.support.brightcove.com/playback/getting-started/quick-start-playback-api A learning guide focused on understanding and utilizing Brightcove's RESTful APIs for various functionalities. ```APIDOC ## Learning Guide: Using the REST APIs This learning guide provides a comprehensive introduction to using Brightcove's REST APIs. It covers core concepts, common use cases, and practical examples for interacting with the platform programmatically. ``` -------------------------------- ### Setup for Player Management Samples Source: https://apis.support.brightcove.com/search_q=%2F_site%2Fplayback%2Fguides%2F This code snippet outlines the necessary setup steps before running Player Management API samples. It often involves obtaining authentication tokens and setting up base URLs. ```javascript const API_KEY = 'YOUR_API_KEY'; const CLIENT_ID = 'YOUR_CLIENT_ID'; const CLIENT_SECRET = 'YOUR_CLIENT_SECRET'; const ACCOUNT_ID = 'YOUR_ACCOUNT_ID'; const BASE_URL = `https://players.api.brightcove.com/v2/${ACCOUNT_ID}`; // Function to get an access token (implementation omitted for brevity) async function getAccessToken() { // ... implementation to get token using OAuth API ... return 'YOUR_ACCESS_TOKEN'; } async function initialize() { const token = await getAccessToken(); console.log('Setup complete. Access token obtained.'); // Proceed with API calls using BASE_URL and token } initialize(); ``` -------------------------------- ### Platform APIs - Getting Started Source: https://apis.support.brightcove.com/general/tls-media-player-and-api-urls Guides on getting started with Brightcove Platform APIs, including an overview, authentication methods, testing tools, and a learning guide for using REST APIs. ```APIDOC ## Platform APIs - Getting Started ### Description This section provides essential information for developers beginning to work with the Brightcove Platform APIs. It covers fundamental concepts and tools necessary for making API requests and integrating with the Video Cloud platform. ### Getting Started * **Overview: Platform APIs** * **Authentication for API Requests** * **Testing Tools for Brightcove APIs** * **Learning Guide: Using the REST APIs** ``` -------------------------------- ### Setup for Player Management Samples Source: https://apis.support.brightcove.com/search_q=%2F_site%2Fpolicy%2Fgetting-started%2F This code snippet provides the necessary setup instructions or initial code required before running other Player Management API samples. It typically involves authentication and client initialization. ```javascript // Conceptual JavaScript setup for Player Management API async function initializePlayerManagement() { const accountId = 'YOUR_ACCOUNT_ID'; const accessToken = await getOAuthAccessToken(); // Assume this function exists and works console.log('Player Management API initialized.'); return { accountId, accessToken }; } // Function to get OAuth token (implementation depends on your OAuth flow) async function getOAuthAccessToken() { // Replace with actual OAuth token retrieval logic return 'YOUR_ACCESS_TOKEN'; } initializePlayerManagement().then(config => { // Proceed with other Player Management API calls using config.accountId and config.accessToken }); ``` -------------------------------- ### Setup for Player Management Samples Source: https://apis.support.brightcove.com/cloud-playout-apis/getting-started This guide outlines the initial setup required to run the Player Management API code samples. It typically involves obtaining API credentials and ensuring necessary tools or libraries are installed. ```bash # Ensure you have Node.js and npm installed. # Install the Brightcove Node.js SDK: npm install brightcove-api-sdk # Obtain your Account ID, Client ID, and Client Secret from your Brightcove account settings. # Store these securely, e.g., in environment variables or a configuration file. export BRIGHTCOVE_ACCOUNT_ID='YOUR_ACCOUNT_ID' export BRIGHTCOVE_CLIENT_ID='YOUR_CLIENT_ID' export BRIGHTCOVE_CLIENT_SECRET='YOUR_CLIENT_SECRET' # You might also need to set up OAuth API access to get tokens if not using static credentials. # Refer to Brightcove OAuth API documentation for details. ``` -------------------------------- ### Getting Started with OAuth API Source: https://apis.support.brightcove.com/oauth/index Guides on how to get started with the Brightcove OAuth API, including an overview and a quick start tutorial. ```APIDOC ## Getting Started with OAuth API ### Description These resources provide initial steps and foundational knowledge for using the Brightcove OAuth API. ### Resources - **Overview**: [Link to OAuth API Overview] - **Quick Start**: [Link to OAuth API Quick Start Guide] ``` -------------------------------- ### Getting Started with the NextGen Live API Source: https://apis.support.brightcove.com/search_q=live-redundancy Guides on how to get started using the NextGen Live API, including an overview and a quick start. ```APIDOC ## Getting Started with the NextGen Live API ### Description Learn how to get started using the NextGen Live API. ### Apis Overview: NextGen Live API Quick Start: NextGen Live API ``` -------------------------------- ### Setup for Player Management Samples (Player Management API) Source: https://apis.support.brightcove.com/playback-rights/getting-started Initial setup instructions or code snippets required before running other Player Management API samples. This might involve authentication or environment configuration. ```bash export BRIGHTCOVE_ACCOUNT_ID='YOUR_ACCOUNT_ID' export BRIGHTCOVE_CLIENT_ID='YOUR_CLIENT_ID' export BRIGHTCOVE_CLIENT_SECRET='YOUR_CLIENT_SECRET' ``` -------------------------------- ### Getting Started with Platform APIs Source: https://apis.support.brightcove.com/search_q=using-live-rtmp-outputs-stream-facebook-and-youtube Foundational guides for beginning development with Brightcove Platform APIs including authentication, testing tools, and REST API fundamentals. ```APIDOC ## Getting Started with Platform APIs ### Description Comprehensive getting started guides for Brightcove Platform API development. ### Core Topics - **Platform APIs Overview** - Introduction to Brightcove API ecosystem - **Authentication for API Requests** - JWT and credential management - **Testing Tools** - Online tester, Postman, Insomnia, cURL - **Learning Guide: Using the REST APIs** - REST fundamentals ### Prerequisites - Valid Brightcove Video Cloud account - API credentials (Client ID and Secret) - Understanding of REST API concepts - HTTP and JSON knowledge ### Next Steps 1. Set up API credentials 2. Choose a testing tool (Postman, Insomnia, or cURL) 3. Create JWT authentication token 4. Make your first API request 5. Explore specific API documentation ### Available APIs to Learn - Analytics API - CMS API - Cloud Playout APIs - Audience API - Playback API ### Resources - Index of Platform API Code Samples - Platform API Training Videos - All API References ``` -------------------------------- ### Setup for Player Management Samples Source: https://apis.support.brightcove.com/search_q=%2Fplayback-authorization%2Fguides%2Fnode%2F Provides the necessary setup steps and code to begin using the Player Management API samples. This might include authentication setup or initializing the API client. ```javascript // Assuming you have obtained an access token using the OAuth API const accessToken = 'YOUR_ACCESS_TOKEN'; const accountId = 'YOUR_ACCOUNT_ID'; // Initialize API client or set default headers const apiClient = { headers: { 'Authorization': `Bearer ${accessToken}`, 'Content-Type': 'application/json' } }; console.log('Player Management API setup complete.'); ``` -------------------------------- ### Setup for Player Management Samples Source: https://apis.support.brightcove.com/cms/code-samples/cms-api-sample-media-sharing-report This covers the initial setup required to use the Player Management API samples. This includes API authentication setup and retrieving the necessary player configuration files. It provides the initial steps needed for running the Player Management API samples. ```generic Setup for Player Management Samples ``` -------------------------------- ### Brightcove Playback API Source: https://apis.support.brightcove.com/unused/dynamic-ingest-legacy/getting-started/quick-start-dynamic-ingest-api-legacy-ingest Documentation for the Playback API, including getting started, guides on video search, catalog architecture, manifest TTL, static delivery, and various API references. ```APIDOC ## Brightcove Playback API ### Description Allows retrieval of video metadata and playback information, including support for searching the video catalog and delivering video content. ### Getting Started - Overview: Playback API - Quick Start: Playback API - Best Practices: CMS and Playback APIs ### Guides - CMS and Playback APIs: Video Search - Catalog Search Architecture - Short Manifest TTL - Static URL Delivery ### References - Playback API Reference - Video Fields Reference - Playlist Fields Reference - Error Reference - CMS/Playback APIs Release Notes ### Code Samples - Video Thumbnail Grid - MRSS Generator - JSON/MRSS Feed from a Playlist - iTunes and Roku Feed Generators ``` -------------------------------- ### Playback API - Quick Start Source: https://apis.support.brightcove.com/live-api/guides/live-api-static-entry-points Get started quickly with the Playback API using this step-by-step guide. ```APIDOC ## Playback API - Quick Start: Playback API ### Description A concise guide to help developers rapidly integrate the Playback API for serving video content. ### Method N/A (Documentation Topic) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### Analytics API - Getting Started Source: https://apis.support.brightcove.com/general/audio-content Guides on getting started with the Analytics API, including an overview and details on the Video Data Endpoint and dimensions. ```APIDOC ## Analytics API - Getting Started ### Overview: Analytics API An introduction to the Analytics API and its capabilities. ### Analytics API Explorer Information about the Analytics API Explorer tool. ### Overview: Video Data Endpoint Details on the Video Data Endpoint for retrieving video analytics. ### Overview: Dimensions, Fields, and Parameters Explanation of the dimensions, fields, and parameters available in the Analytics API. ``` -------------------------------- ### NextGen Live API - Getting Started Source: https://apis.support.brightcove.com/search_q=quick-start-ingest-profiles-api Provides introductory information on how to get started with the NextGen Live API, including an overview and a quick start guide. ```APIDOC ## NextGen Live API - Getting Started ### Description This section offers guidance on initiating your use of the NextGen Live API. It includes a general overview and a quick start guide to help you begin implementing live streaming solutions. ### Method POST (Implied for starting a live stream) ### Endpoint `/live/v1/accounts/{accountId}/live_streams` (Example endpoint for creating a live stream) ### Parameters #### Path Parameters - **accountId** (string) - Required - The Brightcove account ID. #### Request Body - **name** (string) - Required - The name of the live stream. - **embed_html** (boolean) - Optional - Whether to generate embed HTML. ### Request Example ```json { "name": "My Live Event", "embed_html": true } ``` ### Response #### Success Response (200) - **id** (string) - The ID of the created live stream. - **name** (string) - The name of the live stream. #### Response Example ```json { "id": "live-stream-111", "name": "My Live Event" } ``` ```