Skip to content

Commit

Permalink
REST API: edits and clarifications
Browse files Browse the repository at this point in the history
  • Loading branch information
enclaved committed Dec 7, 2022
1 parent 5c19c36 commit 7b533be
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions api.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,15 @@ API поддерживает JSON- и XML-кодирование данных.

Каждый запрос к API должен содержать два обязательных заголовка:

1. `Content-Type` для выбора способа кодирования данных:
1. `Authorization: Basic <authKey>` для аутентификации в Adspect.
2. `Content-Type` для выбора способа кодирования данных:
* `Content-Type: application/json` для выбора JSON-кодирования;
* `Content-Type: application/xml` для выбора XML-кодирования;
2. `Authorization: Basic <authKey>` для аутентификации в Adspect.

Поле `<authKey>` в заголовке Authorization формируется следующим образом (пример кода на PHP):
Поле `<authKey>` в заголовке Authorization формируется путем [base64-кодирования](https://ru.wikipedia.org/wiki/Base64)
строки, составленной из ключа API и добавленного в конце двоеточия.

Пример кода на PHP:

```php
<?php
Expand All @@ -46,8 +49,8 @@ $authKey = base64_encode($apiKey . ':');

Каждый поток представляется в виде объекта, который содежит следующие свойства:

* `stream_id` --- ID потока в формате UUID;
* `account_id` --- ID аккаунта в формате UUID, только для чтения;
* `stream_id` --- ID потока, только для чтения;
* `account_id` --- ID аккаунта, только для чтения;
* `name` --- название потока, строка;
* `tags` --- теги, массив строк;
* `mode` --- режим потока, строка, одна из `Filter`, `Review`, `Money` или `White`;
Expand Down Expand Up @@ -248,7 +251,8 @@ DELETE /streams/<id>

## Гостевой доступ к статистике

Управление гостевым доступом к статистике производится при помощи сохраненных запросов:
Гостевой доступ к статистике позволяет третьим лицам просматривать заранее определенные фрагменты вашей статистики
без необходимости входа в систему. Управление гостевым доступом производится при помощи сохраненных запросов:

1. Создается сохраненный запрос к статистике, в котором указываются параметры выгрузки отчета (даты и фильтры);
2. В ответ API передает ID сохраненного запроса;
Expand All @@ -259,9 +263,6 @@ DELETE /streams/<id>

Каждый сохраненный запрос представляется в виде объекта, который содежит следующие свойства:

* `created_at` --- Unix-время создания запроса, только для чтения;
* `updated_at` --- Unix-время изменения запроса, только для чтения;
* `expires_at` --- Unix-время прекращения доступа к запросу;
* `query_id` --- ID сохраненного запроса в формате UUID, только для чтения;
* `owner_id` --- ID аккаунта-владельца в формате UUID, только для чтения;
* `date_from` --- минимальное Unix-время, начиная с которого выгружается отчет;
Expand Down

0 comments on commit 7b533be

Please sign in to comment.