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:
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:
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]
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:
https://boomstream.com/api/info?apikey=[API_KEY]
Example of successful response:
<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: