# Click API
С помощью API click.ru можно автоматизировать рутинные операции, выгружать статистику в сторонние системы и решать другие задачи.
# [0.5.0] - 2021-02-25
# Добавлено
- Новый метод
GET /billing/referrals
(начисления за приглашённых пользователей)
# [0.4.0] - 2021-02-24
# Добавлено
- В методе
GET /users/payers
добавлены новые типы плательщиков: физическое лицо, бонусный счёт
# [0.3.0] - 2021-02-10
# Добавлено
- Новый метод
GET /accounts/{accountId}
(получить информацию по одному аккаунту)
Использовать API могут все зарегистрированные пользователи Системы. API является бесплатным.
# Ограничения
На вызовы методов API существуют ограничения:
- 1 вызов в секунду;
- 3600 вызовов в час;
В случае превышения лимита будет отдан 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"
}
}