Skip to content

Commit

Permalink
Update API chapter
Browse files Browse the repository at this point in the history
  • Loading branch information
enclaved committed Mar 6, 2022
1 parent 55e2d53 commit 1695414
Showing 1 changed file with 24 additions and 3 deletions.
27 changes: 24 additions & 3 deletions api.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,20 @@
# REST API

Adspect предоставляет REST API для программного управления потоками. API использует JSON-кодирование
данных и поддерживает несколько методов для всех основных операций над потоками. Для аутентификации
Adspect предоставляет REST API для программного управления потоками. API поддерживает
JSON- и XML-кодирование данных и имеет набор точек вызова для операций с потоками.
В примерах ниже будет использовано JSON-кодирование для простоты.

## Аутентификация

Для аутентификации в Adspect REST API
используется [HTTP-аутентификация типа Basic](https://developer.mozilla.org/ru/docs/Web/HTTP/%D0%90%D0%B2%D1%82%D0%BE%D1%80%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F#Basic_authentication_scheme),
в которой ключ API передается в качестве имени пользователя, а пароль оставляется пустым. Ваш ключ API
находится в вашем профиле.

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

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

Поле `<authKey>` в заголовке Authorization формируется следующим образом (пример кода на PHP):
Expand Down Expand Up @@ -204,6 +210,21 @@ GET /streams
* `per-page=20` --- задает число потоков на страницу, по умолчанию 20;
* `name=substr` --- выводит только те потоки, в имени которых содержится `substr` (без учета регистра).

### Данные о списке потоков

```
HEAD /streams
```

Эта точка вызова возвращает заголовки с общей информацией о числе потоков и страниц:

* `X-Pagination-Total-Count: 1000` --- общее число потоков;
* `X-Pagination-Page-Count: 50` --- общее число страниц.

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

* `per-page=20` --- задает число потоков на страницу, по умолчанию 20.

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

```
Expand Down

0 comments on commit 1695414

Please sign in to comment.