Skip to content

Commit

Permalink
Getting Scan Status
Browse files Browse the repository at this point in the history
  • Loading branch information
enclaved committed Nov 15, 2021
1 parent 1776abd commit 5ca7390
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 3 deletions.
6 changes: 3 additions & 3 deletions api.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,6 @@ $authKey = base64_encode($apiKey . ':');
(например, [Python Requests](https://docs.python-requests.org/en/latest/) предоставляет класс `requests.auth.HTTPBasicAuth`).
В этом случае укажите ваш ключ API в качестве имени пользователя и оставьте пароль пустым.

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

## Формат потоков

Каждый поток представляется в виде JSON-объекта, который содежит следующие свойства:
Expand Down Expand Up @@ -187,6 +184,9 @@ $authKey = base64_encode($apiKey . ':');

## Методы

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

* `GET /streams` --- возвращает массив всех потоков в аккаунте;
* `GET /streams/<id>` --- возвращает указанный поток;
* `POST /streams` --- создает и возвращает новый поток; укажите объект потока в JSON-формате в теле запроса;
Expand Down
28 changes: 28 additions & 0 deletions integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,34 @@ WordPress имеет файл `index.php` в корневой папке. Име
**Обратите внимание: при обновлении WordPress перезапишет этот файл `index.php`, тем самым удалив код интеграции,
и ее придется выполнить заново.**

### Статус сканирования

When transferring control to other PHP files or doing reverse PHP integration into them, you may obtain
scan status information about each click using the `$_adspect` global PHP variable. It contains an array
of the following structure:
При передаче управления в другие PHP-файлы или при обратной PHP-интеграции в них вы можете получить информацию
о статусе сканирования каждого перехода из глобальной PHP-переменной `$_adspect`. В ней содержится ассоциативный
массив следующей структуры:

```php
array (
'cid' => 'fd808d23604d84fbc5e81d7b954c4f9a',
'ok' => true,
'js' => false,
'action' => 'local',
'target' => 'page.php?utm_campaign=test',
)
```

Значение элементов массива:

* **cid** --- внутренний уникальный идентификатор перехода, строка (будет одинаковым на всех этапах обработки перехода);
* **ok** --- был ли переход посчитан целевым, логический;
* **js** --- требуется ли отдать посетителю код сбора JS-отпечатка, логический (всегда будет иметь значение `false`,
так как сбор отпечатков происходит до того, как управление будет передано в ваш код);
* **action** --- действие, выполненное для этого перехода, строка (обычно или `local`, или `noop`);
* **target** --- цель для выполненного действия (URL, путь к файлу, код), строка.

### Скрытые URL-параметры

Иногда бывает необходимо передать в Adspect URL-параметр, которого физически нет в ссылке. Например, при работе
Expand Down

0 comments on commit 5ca7390

Please sign in to comment.