JW Platform API Reference¶
Using the API, developers can build any functionality offered by JW Platform into their own website, service or application and programmatically manage their content library and cloud hosted players. The API features a straightforward authentication mechanism and multiple output formats (PHP, JSON, XML, Python). The management endpoints are grouped into classes and the available content can be requested through a standard URL scheme. This reference describes in detail how our API works and which classes and assets are available.
To ensure fair access for all, usage of api.jwplatform.com is limited to 10 calls per minute. We reserve the right to block API access to accounts that exceed this rate. If you need a higher API rate, please contact email@example.com. Note that calls to content.jwplatform.com do not count towards the API rate limit.
The API consists of an content service URL Scheme for requesting videos, players, feeds, etc.; plus an API framework for creating and managing these assets and their metadata. The API reference provides technical documentation for both.
To quickly get started, we provide both a Python and PHP API kit, plus a ZIP file with some PHP examples.
We also provide a fully functional JW Platform WordPress Plugin, which is capable of uploading, searching and publishing videos within the WordPress admin.
content.jwplatform.com URL Scheme¶
This URL Scheme defines how to request videos, feeds, thumbs and players from the JW Platform content service endpoints. These endpoints are the correct mechanism for making high volume calls from your webpage or application and are optimized for quick responses.
The video classes define methods for uploading, editing and listing videos, thumbnails, tags and statistics. For high volume read-only calls for information on one or more videos, the content.jwplatform.com/feeds/ url described above is the preferred endpoint.
Channels (a.k.a. Playlists)¶
The channels classes define methods for creating, manipulating and listing video playlists, playlist thumbnails and playlist statistics.
The players classes define methods for creating, designing and listing video players and player statistics.
The advertising classes define methods for creating and managing advertising schedules and advertising tags.
The accounts classes define methods for creating and managing accounts, usage statistics, transcoding templates and player skins.
api.jwplatform.com Syntax, Security and Upload Mechanisms¶
These sections provide details on how asset management API calls are structured and mechanisms for uploading content to the platform.