Skip to content

Commit

Permalink
API chapter updates
Browse files Browse the repository at this point in the history
  • Loading branch information
Adspect committed Dec 23, 2023
1 parent 4760295 commit 8345098
Showing 1 changed file with 34 additions and 149 deletions.
183 changes: 34 additions & 149 deletions api.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ $authKey = base64_encode($apiKey . ':');

```php
<?php
$apiKey = 'SEbMw152aoe2ArffS7yjEJzJ_MFnd33e';
$curl = curl_init();
curl_setopt($curl, CURLOPT_USERPWD, $apiKey . ':');
```
Expand All @@ -57,158 +58,42 @@ curl_setopt($curl, CURLOPT_USERPWD, $apiKey . ':');
## Коллекции

Некоторые свойства объектов могут принимать значения только из строго заданных множеств --- коллекций.
Ниже приводятся списки таких значений и точки доступа для их программного получения.

### Шаблоны потоков

```
GET /collections/presets
```

### Операционные системы

Названия операционных систем не чувствительны к регистру.

```
GET /collections/os
```

* `Android 1`
* `Android 2`
* `Android 3`
* `Android 4`
* `Android 5`
* `Android 6`
* `Android 7`
* `Android 8`
* `Android 9`
* `Android 10`
* `Android 11`
* `Android 12`
* `Android 13`
* `iOS`
* `KaiOS`
* `macOS`
* `Linux`
* `Other`
* `Windows XP`
* `Windows Vista`
* `Windows 7`
* `Windows 8`
* `Windows 8.1`
* `Windows 10`
* `Windows Other`

### Браузеры

Названия браузеров не чувствительны к регистру.

```
GET /collections/browsers
```

* `Apple Safari`
* `Facebook app`
* `Google Chrome`
* `Internet Explorer`
* `Microsoft Edge`
* `Mozilla Firefox`
* `Opera`
* `Other`
* `Samsung Internet`
* `Snapchat app`
* `UC Browser`
* `WebView`
* `Yandex Browser`

### Движки браузера

Названия движков браузера не чувствительны к регистру.

```
GET /collections/engines
```

* `Blink`
* `EdgeHTML`
* `Gecko`
* `Other`
* `Presto`
* `Trident`
* `WebKit`

### Коды стран

```
GET /collections/countries
```

### Коды языков

```
GET /collections/languages
```

### Часовые пояса

```
GET /collections/time-zones
```

### Режимы потока

Названия режимов потока не чувствительны к регистру.

```
GET /collections/stream-modes
```

* `Filter` --- фильтр;
* `Review` --- модерация;
* `Money` --- контент;
* `White` --- белая страница.
В таблице ниже приводятся точки вызова для получения коллекций:

| Точка вызова | Описание |
|:----------------------------------|:---------|
| `GET /collections/presets` | Шаблоны потоков для различных источников трафика. |
| `GET /collections/os` | Операционные системы для таргетинга и статистики. |
| `GET /collections/browsers` | Браузеры для таргетинга и статистики. |
| `GET /collections/engines` | Движки браузера для таргетинга и статистики. |
| `GET /collections/countries` | Коды стран для таргетинга и статистики. |
| `GET /collections/languages` | Коды языков для таргетинга и статистики. |
| `GET /collections/time-zones` | Часовые пояса для таргетинга и статистики. |
| `GET /collections/stream-modes` | Режимы потока. |
| `GET /collections/stream-actions` | Действия для контента и белой страницы (см. ниже). |
| `GET /collections/query-group-by` | Элементы разбивки для воронки продаж. |

### Действия потока

```
GET /collections/stream-actions
```

* `local` --- локальный файл без редиректа;
* `proxy` --- проксирование;
* `fetch` --- подгрузка HTML-кода;
* `iframe` --- отображение в iframe;
* `301` --- редирект HTTP 301;
* `302` --- редирект HTTP 302;
* `303` --- редирект HTTP 303;
* `noop` --- без действия;
* `refresh` --- редирект HTTP Refresh;
* `meta` --- редирект HTML meta refresh;
* `return` --- произвольный код ответа HTTP;
* `php` --- выполнить PHP-код;
* `js` --- выполнить JavaScript-код;
* `xar` --- заголовок `X-Accel-Redirect`;
* `xsf` --- заголовок `X-Sendfile`.

### Группировки воронки продаж

Группировки воронки продаж не чувствительны к регистру.

```
GET /collections/query-group-by
```

* `date` --- по дате;
* `stream_id` --- по потоку;
* `asn` --- по ASN (номеру автономной системы);
* `country_code` --- по коду страны;
* `os` --- по названию операционной системы;
* `browser` --- по названию браузера;
* `engine` --- по названию движка браузера;
* `sub_id` --- по субаккаунту;
* `mode` --- по режиму потока;
* `target` --- по показанной странице;
* `tag` --- по тегу.
Следующая таблица описывает действия для контента и белой страницы:

| Действие | Описание |
|:----------|:---------|
| `local` | Локальный файл без редиректа. |
| `proxy` | Проксирование. |
| `fetch` | Подгрузка HTML-кода. |
| `iframe` | Отображение в `<iframe>`. |
| `301` | Редирект HTTP 301. |
| `302` | Редирект HTTP 302. |
| `303` | Редирект HTTP 303. |
| `noop` | Без действия. |
| `refresh` | Редирект HTTP Refresh. |
| `meta` | Редирект HTML meta refresh. |
| `return` | Произвольный код ответа HTTP. |
| `php` | Выполнить PHP-код. |
| `js` | Выполнить JavaScript-код. |
| `xar` | Заголовок `X-Accel-Redirect`. |
| `xsf` | Заголовок `X-Sendfile`. |

## Управление потоками

Expand Down

0 comments on commit 8345098

Please sign in to comment.