API ключ проекта находится в личном кабинете пользователя, настройки проекта, раздел интеграция.

Boomstream API использует протокол взаимодействия REST. Префикс API:

https://boomstream.com/api

Все входные данные принимаются через GET параметры.

Формат выходных данных: json, xml и xls. Формат устанавливается параметром format, например:

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

В API используются версии для внесения изменений в существующие методы:

Версия API по умолчанию - 1.0.
Текущая версия API - 1.1.

Для того, чтобы использовать текущую версию API, необходимо добавить параметр в HTTP запрос - &ver=1.1.

Каждый ответ API содержит параметр Status, который обозначает статус ответа на запрос. Успешные ответы имеют статус Success, не успешные - Failed. При этом у не успешных ответов есть дополнительный параметр Message, который содержит текст ошибки. Примеры:

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

Ниже приведены API объекты:

Работа с API

Продукты

Решения

Компания

Документы