logo

API Usage

api
manage account

General Information

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

All input data is passed via GET parameters. Output data formats are JSON and XML.

The format is set using the format parameter. Examples:

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

API Versions

  • Default API version — 1.0
  • Current API version — 1.1

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

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.

Example of successful response:

XML 
<Response>
    <Status>Success</Status>
    <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>

Example of error response:

XML 
<Response>
    <Message>Media not found</Message>
    <Status>Failed</Status>
    <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: