API Usage

Project API-key is situated in personal account project settings, Integration part.

Boomstream API uses interfacing protocol REST. API prefix:

https://boomstream.com/api

All input data is received by GET parameters. Output data formats are json and xml.

A format is set via the parameter “format”, for example:

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

List of API versions are:

Default API version - 1.0.
Current API version - 1.1.

To use current API version you nee to pass HTTP parameter ver - &ver=1.1.

Every API response contains parameter “Status”, that indicates the status query response. Successful query responses have “Success” status, unsuccessful query responses have “Failed” status. Besides that, failed query responses have additional parameter “Message”, that contains the text of the error. Examples:

<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>

<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>

Below are classes for working with API: