Skip to content

Commit

Permalink
Update API
Browse files Browse the repository at this point in the history
  • Loading branch information
enclaved committed Jan 10, 2022
1 parent b3cfa1f commit cdc0465
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 13 deletions.
78 changes: 67 additions & 11 deletions api.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ $authKey = base64_encode($apiKey . ':');
* `page` --- URL / имя файла / код (в зависимости от действия), строка;
* `action` -- целевое действие, строка, одно из: `local`, `proxy`, `fetch`, `xar`, `xsf`, `return`, `noop`, `301`, `302`, `303`, `refresh`, `meta`, `iframe`, `php`, `js`;
* `arg_passthru` --- флаг проброса URL-параметров на данную белую страницу, логический;
* `skipClicks` -- число первых кликов, которым нужно показать белую страницу (отложенный старт), целочисленный;
* `ml_precision` --- точность VLA в процентах, целочисленный;
* `hll_threshold` --- чувствительность HyperLogLog, целое число в диапазоне [1; 50];
* `cost_parameter` --- имя параметра цены клика, строка;
Expand Down Expand Up @@ -182,24 +183,79 @@ $authKey = base64_encode($apiKey . ':');
}
```

## Методы
## Точки вызова

Базовый URL для всех API-методов --- `https://api.adspect.net/v1/`. Описания методов ниже указывают пути
относительно этого базового URL.
Базовый URL для всех точек вызова --- `https://api.adspect.net/v1/`. Описания методов ниже указывают пути
относительно этого базового URL. Сначала указан HTTP-метод, за которым следует относительный путь точки
вызова и версия протокола HTTP, как в настоящих HTTP-запросах.

* `GET /streams` --- возвращает массив всех потоков в аккаунте;
* `GET /streams/<id>` --- возвращает указанный поток;
* `POST /streams` --- создает и возвращает новый поток; укажите объект потока в JSON-формате в теле запроса;
* `PATCH /streams/<id>` --- обновляет поток; укажите объект потока в JSON-формате в теле запроса;
* `COPY /streams/<id>` --- копирует поток; укажите объект потока в JSON-формате в теле запроса
(указанные настройки заменят настройки в скопированном потоке, аналогично методу `PATCH`);
* `DELETE /streams/<id>` --- удаляет поток.
### Список потоков

```
GET /streams
```

Эта точка вызова возвращает список потоков в аккаунте. Список разбивается на страницы, а потоки в нем
выводятся в возрастающем [лексикографическом порядке](https://ru.wikipedia.org/wiki/%D0%9B%D0%B5%D0%BA%D1%81%D0%B8%D0%BA%D0%BE%D0%B3%D1%80%D0%B0%D1%84%D0%B8%D1%87%D0%B5%D1%81%D0%BA%D0%B8%D0%B9_%D0%BF%D0%BE%D1%80%D1%8F%D0%B4%D0%BE%D0%BA)
их имен.

Поддерживаемые URL-параметры:

* `page=1` --- задает номер страницы для отображения, по умолчанию 1;
* `per-page=20` --- задает число потоков на страницу, по умолчанию 20;
* `name=substr` --- выводит только те потоки, в имени которых содержится `substr` (без учета регистра).

### Получение потока

```
GET /streams/<id>
```

Эта точка вызова возвращает поток `<id>`.

### Создание потока

```
POST /streams
```

Эта точка вызова создает и возвращает новый поток. Укажите JSON-кодированный объект потока в теле запроса.
Все свойства объекта потока имеют значения по умолчанию, поэтому вам нужно указывать только те свойства,
значения которых вы хотите задать явно, например `{"name":"My stream"}`.

### Обновление потока

```
PATCH /streams/<id>
```

Эта точка вызова обновляет поток `<id>`. Укажите JSON-кодированный объект потока в в теле запроса.
Вам нужно указать только те свойства, значения которых вы хотите изменить; все остальные свойства
останутся неизменными.

### Копирование потока

```
COPY /streams/<id>
```

Эта точка вызова копирует поток `<id>`. Укажите JSON-кодированный объект потока в теле запроса ---
указанные в нем свойства заменят свойства в скопированном потоке, что сэкономит вам дополнительный
вызов точки `PATCH`. Если свойства изменять не требуется, то укажите пустой объект `{}`.

### Удаление потока

```
DELETE /streams/<id>
```

Эта точка вызова удаляет поток `<id>`.

## PHP-файлы

Вы можете скачать файлы `index.php`, `filter.php` и `ajax.php` для любого потока при помощи запросов:

* `index.php` и `filter.php` --- `GET https://clients.adspect.ai/getindex.php?sid=<id>`
* `index.php` и `filter.php` (один и тот же файл) --- `GET https://clients.adspect.ai/getindex.php?sid=<id>`
* `ajax.php` --- `GET https://clients.adspect.ai/getindex.php?sid=<id>&mode=ajax`

Вместо `<id>` укажите ID конкретного потока в Adspect.
4 changes: 2 additions & 2 deletions integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,12 +69,12 @@ PHP-интеграция представлена в двух видах: пря
Если ваш сайт написан на чистом HTML, то вы можете поменять расширение вашего файла с `.html` на `.php`, а затем добавить
в него указанную строчку кода.

После настройки просто направьте трафик на ту страницу, в которую вы добавили код.

Если вы добавили код в файл вашей белой страницы, то в настройках потока укажите действие "Без действия" для белой страницы.
Adspect не будет предпринимать никаких действий и оставит посетителя на текущей странице, которая и является белой.
Аналогично, если вы добавили код в контент-страницу, то в потоке укажите действие "Без действия" для контент-страницы.

После настройки просто направьте трафик на ту страницу, в которую вы добавили код.

### WordPress и другие CMS

Обратная PHP-интеграция удобна для интеграции Adspect в сайты, построенные на WordPress или других подобных CMS
Expand Down
2 changes: 2 additions & 0 deletions overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,8 @@ Adspect поддерживает три типа интеграции, кото

## Хостинг

Adspect можно использовать на выделенных серверах, VPS и виртуальном хостинге.

**Не используйте следующие хостинги:**

* Виртуальный хостинг Namecheap
Expand Down

0 comments on commit cdc0465

Please sign in to comment.