# Click API

С помощью API click.ru можно автоматизировать рутинные операции, выгружать статистику в сторонние системы и решать другие задачи.

# [0.17.3] - 2023-04-27

# Добавлено

  • В метод POST /users добавлены новые поля: email, password

# [0.17.2] - 2023-03-14

# Добавлено

  • В методы GET /campaigns, GET /campaigns/start, GET /campaigns/pause добавлена поддержка кампаний VK Реклама

# [0.17.1] - 2023-01-25

# Изменено

  • В POST /tools/competitors_ads изменен формат данных на входе (domain вместо domains) и выходе

Использовать API могут все зарегистрированные пользователи Системы. API является бесплатным.

# Ограничения

На вызовы методов API существуют ограничения:

В случае превышения лимита будет отдан http-код ответа 429.

Также, для отдельных методов могут применяться другие ограничения вызовов. Эта информация содержится в описании метода.

# Авторизация

Доступна обоим типам аккаунтов - мастер-аккаунтам и аккаунтам пользователей. При этом мастер-аккаунт может делать запросы от имени своих пользовательских аккаунтов.
Для того, чтобы сделать запрос от имени пользовательского аккаунта, нужно использовать HTTP-заголовок X-Auth-UserId.

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

Токен для запросов можно получить в профиле пользователя. Токен можно пересоздавать, в этом случае старый токен будет неактивен.

# Авторизация от имени пользовательского аккаунта

Передаём в HTTP заголовке X-Auth-UserId: 123.

# Использование

Токен передаём в HTTP заголовке X-Auth-Token.

Пример: X-Auth-Token: 1234567890

В случае ошибки авторизации (неправильный токен, неактивный) будет возвращён код ответа 401.

# Запросы к API

Формат взаимодействия мы используем JSON.

# Запрос со страницы описания метода через cURL

Пример получения профиля пользователя:

Командная строка:

curl -X GET "https://api.click.ru/V0/user"
     -H "Accept: application/json"
     -H "X-Auth-Token: 1234567890"
     -H "X-Auth-UserId: 123"

Вернёт:

{
  "response": {
    "id": 10001,
    "email": "user@example.com",
    "login": "test123"
  }
}