Online Video Platform. Boomstream Platform.
Open in API Explorer

API Usage

api
manage account

Methods: info

General Information of API

The project API key is located in the personal account settings, in the Integration section.

Boomstream API uses the REST protocol. API prefix:

Text 
https://boomstream.com/api/

Two modes for passing input parameters are supported.

Mode 1 — GET with form parameters (default)

All input parameters are passed as GET query-string parameters. Output formats: JSON and XML. The format is set via the format parameter. Examples:

Text 
https://boomstream.com/api/info?apikey=[API_KEY]&format=xml&ver=1.2
https://boomstream.com/api/info?apikey=[API_KEY]&format=json&ver=1.2
https://boomstream.com/api/info?apikey=[API_KEY]&format=xls&ver=1.2 [experimental]

Mode 2 — POST with JSON

Alternatively, input parameters can be sent as a JSON object in the body of a POST request with the Content-Type: application/json header. This mode works for every API method.

Notes:

  • all input parameters, including apikey, go into the JSON object posted to the chosen endpoint;
  • when the request has Content-Type: application/json, the response is automatically returned as JSON — the format parameter is not needed;
  • array parameters (e.g. code[] in media/bulkinfo) are passed as a JSON array.

Example (curl):

Bash 
curl -X POST https://boomstream.com/api/media/info \
  -H "Content-Type: application/json" \
  -d '{"apikey": "[API_KEY]", "code": "[MEDIA_CODE]"}'

Example with an array:

Bash 
curl -X POST https://boomstream.com/api/media/bulkinfo \
  -H "Content-Type: application/json" \
  -d '{"apikey": "[API_KEY]", "code": ["[MEDIA_CODE_1]", "[MEDIA_CODE_2]"]}'

Mode 3 — Authorization: Bearer header

The API key can be passed in the Authorization: Bearer [API_KEY] HTTP header instead of the apikey parameter. This method works with every API method and can be combined with both the GET and the POST/JSON mode.

Notes:

  • if the apikey parameter is provided explicitly (in the query string or in the JSON body), it takes precedence and the Authorization header is ignored;
  • the header is used only when apikey is not passed as a parameter;
  • the response format is set as usual — via the format parameter or the Content-Type: application/json header.

Example (curl):

Bash 
curl https://boomstream.com/api/info \
  -H "Authorization: Bearer [API_KEY]"

API Versions

  • Default API version — 1.0

    • Boomstream API v.1.0 loads by default

  • API version — 1.1

    • Changed the response format for the method ppv/listBuyers

  • Current API version — 1.2

    • changed the response format for methods ppv/listMedia and ppv/addMedia

To use the current API version, you need to pass the HTTP parameter ver — &ver=1.2.

Response Format

Every API response contains the Status parameter, which indicates the status of the query response. Successful query responses have Success status, unsuccessful query responses have Failed status. Additionally, failed query responses have an additional Message parameter containing the error text.

info

Get additional information about media by its code

Input parameters

Required parameters:

  • String apikey (Project API key)

Output parameters

  • String Success (Status of response)

Example request:

Text 
https://boomstream.com/api/info?apikey=[API_KEY]

Example of successful response:

XML 
<Response>
    <Status>Success</Status>
    <sections>
        <section>
            api/media
        </section>
        ...
    </sections>
    <Version>1.1</Version>
    <Versions>
        <Item>Boomstream API v.1.0 is loaded by default</Item>
        <Item>
            Boomstream API v.1.1. Add &ver=1.1 to the HTTP request to use it. Change log: it is changed the response format for the method - ppv/listBuyers
        </Item>
    </Versions>
</Response>

API Classes

Below are the classes for working with the API: