Руководство по использованию API системы Webisida.com

Интерфейсы управления кампаниями в автосёрфинге

POST v1.0/Surfing/Start
Запуск показов рекламной кампании в автосёрфинге

Параметры
- ID (Int32): Идентификатор кампании.
- Api (Int32): Идентификатор API-интерфейса.
- Timestamp (String): Время формирования запроса по UTC в формате YYYY-MM-dd HH:mm:ss.
- Sig (String): Подпись запроса, образованная путем вычисления MD5-хэша от результата склеивания через два двоеточия параметров Api, Timestamp, Key и остальных, отсортированных в алфавитном порядке обязательных параметров.
Формирование подписи
```
md5(Api::Timestamp::Key::ID)
```
Результат
Объект ApiResult, содержащий результат выполнения запроса, или объект Error, в случае ошибки.
- Message (String): Примечание к ответу на запрос.
- Data (SimpleCampaignModel): Данные, содержащие результат выполения запроса.
  - ID (Int32): ID кампании.
  - Status (Status): Статус кампании: 0 - Unknown, 1 - Enabled, 2 - Disabled, 3 - Banned.
Примечание

Допускается не более 2-х запросов в минуту и не более 5 запросов в час для одной и той же кампании.

Примеры
```
Api=0&Timestamp=2011-05-25+12:34:56&ID=0&Sig=8c629fcbdd886a340bef01e8fc92273b
```
```
{"Message":"message","Data":{"ID":0,"Status":0}}
```
```
<?xml version="1.0" encoding="utf-8"?>
<ApiResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="api">
  <Message>message</Message>
  <Data>
    <ID>0</ID>
    <Status>Unknown</Status>
  </Data>
</ApiResult>
```
POST v1.0/Surfing/Stop
Остановка показов рекламной кампании в автосёрфинге

Параметры
- ID (Int32): Идентификатор кампании.
- Api (Int32): Идентификатор API-интерфейса.
- Timestamp (String): Время формирования запроса по UTC в формате YYYY-MM-dd HH:mm:ss.
- Sig (String): Подпись запроса, образованная путем вычисления MD5-хэша от результата склеивания через два двоеточия параметров Api, Timestamp, Key и остальных, отсортированных в алфавитном порядке обязательных параметров.
Формирование подписи
```
md5(Api::Timestamp::Key::ID)
```
Результат
Объект ApiResult, содержащий результат выполнения запроса, или объект Error, в случае ошибки.
- Message (String): Примечание к ответу на запрос.
- Data (SimpleCampaignModel): Данные, содержащие результат выполения запроса.
  - ID (Int32): ID кампании.
  - Status (Status): Статус кампании: 0 - Unknown, 1 - Enabled, 2 - Disabled, 3 - Banned.
Примечание

Допускается не более 2-х запросов в минуту и не более 5 запросов в час для одной и той же кампании.

Примеры
```
Api=0&Timestamp=2011-05-25+12:34:56&ID=0&Sig=8c629fcbdd886a340bef01e8fc92273b
```
```
{"Message":"message","Data":{"ID":0,"Status":0}}
```
```
<?xml version="1.0" encoding="utf-8"?>
<ApiResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="api">
  <Message>message</Message>
  <Data>
    <ID>0</ID>
    <Status>Unknown</Status>
  </Data>
</ApiResult>
```
GET v1.0/Surfing/Status?ID={ID}&Api={Api}&Timestamp={Timestamp}&Sig={Sig}
Получение состояния рекламной кампании в автосёрфинге

Параметры
- ID (Int32): Идентификатор кампании.
- Api (Int32): Идентификатор API-интерфейса.
- Timestamp (String): Время формирования запроса по UTC в формате YYYY-MM-dd HH:mm:ss.
- Sig (String): Подпись запроса, образованная путем вычисления MD5-хэша от результата склеивания через два двоеточия параметров Api, Timestamp, Key и остальных, отсортированных в алфавитном порядке обязательных параметров.
Формирование подписи
```
md5(Api::Timestamp::Key::ID)
```
Результат
Объект ApiResult, содержащий результат выполнения запроса, или объект Error, в случае ошибки.
- Message (String): Примечание к ответу на запрос.
- Data (SurfCampaignStatusModel): Данные, содержащие результат выполения запроса.
  - Balance (Decimal): Баланс рекламной кампании.
  - Price (Decimal): Максимальная стоимость показа.
  - Expended (Decimal): Израсходовано кредитов с момента создания кампании.
  - Expenses (Decimal): Расход кредитов за текущий день.
  - Hourly (Int32): Показов в текущем часу.
  - Daily (Int32): Показов сегодня.
  - Total (Int64): Всего показов.
  - NextVisit (String): Запланированная дата и время следующего показа.
  - ID (Int32): ID кампании.
  - Status (Status): Статус кампании: 0 - Unknown, 1 - Enabled, 2 - Disabled, 3 - Banned.
Примечание

Допускается не более 2-х запросов в минуту и не более 20 запросов в час для одной и той же кампании.

Примеры
```
Api=0&Timestamp=2011-05-25+12:34:56&ID=0&Sig=8c629fcbdd886a340bef01e8fc92273b
```
```
{"Message":"message","Data":{"Balance":123.4,"Price":1.2,"Expended":120,"Expenses":60,"Hourly":5,"Daily":10,"Total":20,"NextVisit":"2020-05-05 11:50:51","ID":0,"Status":0}}
```
```
<?xml version="1.0" encoding="utf-8"?>
<ApiResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="api">
  <Message>message</Message>
  <Data>
    <ID>0</ID>
    <Status>Unknown</Status>
    <Balance>123.4</Balance>
    <Daily>10</Daily>
    <Expended>120</Expended>
    <Expenses>60</Expenses>
    <Hourly>5</Hourly>
    <NextVisit>2020-05-05 11:50:51</NextVisit>
    <Price>1.2</Price>
    <Total>20</Total>
  </Data>
</ApiResult>
```
GET v1.0/Surfing/Campaigns?Api={Api}&Timestamp={Timestamp}&Sig={Sig}
Получение состояния всех рекламных кампаний в автосёрфинге.

Параметры
- Api (Int32): Идентификатор API-интерфейса.
- Timestamp (String): Время формирования запроса по UTC в формате YYYY-MM-dd HH:mm:ss.
- Sig (String): Подпись запроса, образованная путем вычисления MD5-хэша от результата склеивания через два двоеточия параметров Api, Timestamp, Key и остальных, отсортированных в алфавитном порядке обязательных параметров.
Формирование подписи
```
md5(Api::Timestamp::Key)
```
Результат
Объект ApiResult, содержащий результат выполнения запроса, или объект Error, в случае ошибки.
- Message (String): Примечание к ответу на запрос.
- Data (SurfCampaignStatusModel[]): Данные, содержащие результат выполения запроса.
Примечание

Допускается не более 2-х запросов в минуту.

Примеры
```
Api=0&Timestamp=2011-05-25+12:34:56&Sig=8c629fcbdd886a340bef01e8fc92273b
```
```
{"Message":"message","Data":[{"Balance":123.4,"Price":1.2,"Expended":120,"Expenses":60,"Hourly":5,"Daily":10,"Total":20,"NextVisit":"2020-05-05 11:50:51","ID":0,"Status":0}]}
```
```
<?xml version="1.0" encoding="utf-8"?>
<ApiResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="api">
  <Message>message</Message>
  <Data>
    <SurfCampaignStatusModel>
      <ID>0</ID>
      <Status>Unknown</Status>
      <Balance>123.4</Balance>
      <Daily>10</Daily>
      <Expended>120</Expended>
      <Expenses>60</Expenses>
      <Hourly>5</Hourly>
      <NextVisit>2020-05-05 11:50:51</NextVisit>
      <Price>1.2</Price>
      <Total>20</Total>
    </SurfCampaignStatusModel>
  </Data>
</ApiResult>
```
GET v1.0/Surfing/RealtimeInterval?ID={ID}&Api={Api}&Timestamp={Timestamp}&Sig={Sig}
Получение текущего интервала между показами для рекламной площадки в автосёрфинге.

Параметры
- ID (Int32): Идентификатор кампании.
- Api (Int32): Идентификатор API-интерфейса.
- Timestamp (String): Время формирования запроса по UTC в формате YYYY-MM-dd HH:mm:ss.
- Sig (String): Подпись запроса, образованная путем вычисления MD5-хэша от результата склеивания через два двоеточия параметров Api, Timestamp, Key и остальных, отсортированных в алфавитном порядке обязательных параметров.
Формирование подписи
```
md5(Api::Timestamp::Key::ID)
```
Результат
Объект ApiResult, содержащий результат выполнения запроса, или объект Error, в случае ошибки.
- Message (String): Примечание к ответу на запрос.
- Data (RealtimeIntervalModel): Данные, содержащие результат выполения запроса.
  - ID (Int32): ID кампании.
  - Interval (Int32): Интервал между показами в миллисекундах.
  - Type (IntervalType): Тип интервала: 0 - Normal, 1 - Custom, 2 - Special. Интервалы типа Custom и Special переопределяют интервал, установленный согласно расписанию.
Примечание

Допускается не более 2-х запросов в минуту и не более 20 запросов в час для одной и той же площадки.

Примеры
```
Api=0&Timestamp=2011-05-25+12:34:56&ID=0&Sig=8c629fcbdd886a340bef01e8fc92273b
```
```
{"Message":"message","Data":{"ID":0,"Interval":360000,"Type":0}}
```
```
<?xml version="1.0" encoding="utf-8"?>
<ApiResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="api">
  <Message>message</Message>
  <Data>
    <ID>0</ID>
    <Interval>360000</Interval>
    <Type>Normal</Type>
  </Data>
</ApiResult>
```
POST v1.0/Surfing/RealtimeInterval
Переопределение интервала между показами для рекламной кампании в автосёрфинге.

Параметры
- Interval (Int32): Интервал между показами в миллисекундах. 0 - установка интервала из расписания, максимум - 604800000 (7 дней).
- ID (Int32): Идентификатор кампании.
- Api (Int32): Идентификатор API-интерфейса.
- Timestamp (String): Время формирования запроса по UTC в формате YYYY-MM-dd HH:mm:ss.
- Sig (String): Подпись запроса, образованная путем вычисления MD5-хэша от результата склеивания через два двоеточия параметров Api, Timestamp, Key и остальных, отсортированных в алфавитном порядке обязательных параметров.
Формирование подписи
```
md5(Api::Timestamp::Key::ID::Interval)
```
Результат
Объект ApiResult, содержащий результат выполнения запроса, или объект Error, в случае ошибки.
- Message (String): Примечание к ответу на запрос.
- Data (RealtimeIntervalModel): Данные, содержащие результат выполения запроса.
  - ID (Int32): ID кампании.
  - Interval (Int32): Интервал между показами в миллисекундах.
  - Type (IntervalType): Тип интервала: 0 - Normal, 1 - Custom, 2 - Special. Интервалы типа Custom и Special переопределяют интервал, установленный согласно расписанию.
Примечание

Допускается не более 2-х запросов в минуту и не более 20 запросов в час для одной и той же кампании. Устанавливаемый интервал переопределяет интервал, рассчитанный по данным расписания, при условии, что количество показов в расписании в любой момент действия устанавливаемого интервала ненулевое. Переопределение интервала автоматически отключается при останоке / запуске рекламной кампании.

Примеры
```
Api=0&Timestamp=2011-05-25+12:34:56&ID=0&Interval=20000&Sig=8c629fcbdd886a340bef01e8fc92273b
```
```
{"Message":"message","Data":{"ID":0,"Interval":360000,"Type":0}}
```
```
<?xml version="1.0" encoding="utf-8"?>
<ApiResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="api">
  <Message>message</Message>
  <Data>
    <ID>0</ID>
    <Interval>360000</Interval>
    <Type>Normal</Type>
  </Data>
</ApiResult>
```

Руководство по использованию API системы Webisida.com

Интерфейсы управления кампаниями в автосёрфинге

POST v1.0/Surfing/Start

Параметры

Формирование подписи

Результат

Примечание

Примеры

POST v1.0/Surfing/Stop

Параметры

Формирование подписи

Результат

Примечание

Примеры

GET v1.0/Surfing/Status?ID={ID}&Api={Api}&Timestamp={Timestamp}&Sig={Sig}

Параметры

Формирование подписи

Результат

Примечание

Примеры

GET v1.0/Surfing/Campaigns?Api={Api}&Timestamp={Timestamp}&Sig={Sig}

Параметры

Формирование подписи

Результат

Примечание

Примеры

GET v1.0/Surfing/RealtimeInterval?ID={ID}&Api={Api}&Timestamp={Timestamp}&Sig={Sig}

Параметры

Формирование подписи

Результат

Примечание

Примеры

POST v1.0/Surfing/RealtimeInterval

Параметры

Формирование подписи

Результат

Примечание

Примеры