[object Object] Icon

Encoding
Learn how to create, start, manage and modify Encodings

[object Object] Icon

Player
Learn how to create, start, manage and modify Players

[object Object] Icon

Analytics
Learn how to create, start, manage and modify Analyticss

Docs Home
User shortcuts for search
Focus by pressing f
Hide results by pressing Esc
Navigate via   keys

Wed Sep 26 2018

Get started with the Bitmovin API

IntroductionLink Icon

As a developer the Bitmovin API will become the center of your video infrastructure universe, as it allows you to manage everything about your encodings, player, and analytics, as well as your Bitmovin account itself. In this tutorial we will guide to you through the first steps on how to communicate with the Bitmovin API, so you can start to create your first encoding right away.

Create an Bitmovin AccountLink Icon

If you haven't already, please create an Bitmovin account by clicking on "Sign Up" in the upper right corner or visit https://bitmovin.com/dashboard/signup. Once activated you will have access to our your own dashboard so can easily manage your encodings, player/analytics licenses, team members and more. Further, you will be able to manage your API Key, which is needed to interact with our Bitmovin API, which allows to you to control your complete encoding workflow programmatically.

Get your Bitmovin API KeyLink Icon

Once logged in your Bitmovin account at https://bitmovin.com/dashboard go to your account settings. There you will find your Bitmovin API key which is needed in order to communicate with our REST API.

Send your first request to the Bitmovin APILink Icon

At this point you created an Bitmovin account, chose an API client, and found your API key in your account. So by now you have everything needed to send your first API request.

Every request is send to your API as to our API endpoint at https://api.bitmovin.com/v1/ using GET, POST or DELETE as method. All responses are formatted using JSON and follow a specific response message format.

CURL

The following request will list all encodings that are available for your account. As you might have not done an encoding yet, the response will look like the following:

Request

1curl -X GET https://api.bitmovin.com/v1/encoding/encodings -H 'x-api-key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx'

Response

1{
2 "requestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
3 "status": "SUCCESS",
4 "data": {
5 "result": {
6 "totalCount": 0,
7 "previous": "https://api.bitmovin.com/v1/encoding/encodings?offset=0&limit=25",
8 "next": "https://api.bitmovin.com/v1/encoding/encodings?offset=25&limit=25",
9 "items": []
10 }
11 }
12}

Choose an API ClientLink Icon

Due to the vast amount of features in our API there are as many REST API requests available, that are documented in our API reference. In order to ease and speed up your development, and to save you from spending your valuable time on repetitve tasks, we already offer several API clients in the most common languages (Java, Javascript/Node, Python, PHP, Go, .NET(C#), Ruby).

E.g. using our Java API client to perform the same request as in the previous example getting a List about all encodings, it would look like the following:

1BitmovinApi bitmovinApi = new BitmovinApi(YOUR_API_KEY_HERE);
2List<Encoding> encoding = bitmovinApi.encoding.getAllEncodings();

Its that simple ! These API cliensts allow you to quickly try out our API, as well as to easily integrate our API in your new or existing applications/projects, to get your video encoding workflow setup in no time.

An overview about all available API clients can be found here in our documentation, including links to their respective Github repository, examples, and getting started guides to start your first encoding.

Give us feedback