Аккаунт
Методы группы «Аккаунт». Справа — пример запроса и ответа для каждого.
Кто я
GET
/v1/me/0 единицвсе тарифы, включая «API.Max Тест»
Кто вы для API: пользователь и организация ключа, оплаченные продукты, тариф API, лимиты запросов за период (30 дней с оплаты) и в секунду, сколько израсходовано и осталось, остаток пакетов запросов. Баланс организации — только ключу владельца, только для чтения. Метод бесплатный (0 единиц): по нему удобно проверять ключ и остаток.
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
id | число | ID пользователя |
email | строка | Почта владельца ключа |
organization | строка | Название организации, от имени которой ключ |
organization_id | число | Номер организации в datool.ru |
products | список | Оплаченные продукты: max, tg, vk, dzen, com, collector, api_max (API.Max), all (единая подписка) |
api_key | строка | Маскированный ключ, которым сделан запрос |
api_tariff | строка | Тариф API организации, например «API.Max Старт» |
requests_period | число или null | Запросов за период (30 дней с оплаты) по тарифу; null — по договору |
requests_per_second | число или null | Запросов в секунду по тарифу; null — по договору |
period_start | дата и время | Начало текущего периода лимита (ISO 8601, по Москве): каждые 30 дней с оплаты тарифа |
period_end | дата и время | Конец текущего периода (ISO 8601, по Москве) — тогда лимит обновится |
used_period | число | Израсходовано единиц в этом периоде |
remaining_period | число или null | Осталось единиц в этом периоде; null — без предела |
packs_left | число | Осталось в пакетах запросов — тратится после лимита тарифа |
limits_enforced | да / нет | Ограничивают ли лимиты запросы (включаются вместе с продажей тарифов API) |
balance | строка или null | Баланс организации в рублях — только ключу владельца, иначе null |
Ошибки
| Код | code | Когда |
|---|---|---|
| 401 | not_authenticated / authentication_failed | Нет ключа, ключ неверный или отозван, участник приостановлен или организация ключа в архиве. |
| 429 | rate_limited / throttled | Слишком часто — больше запросов в секунду, чем по тарифу; сколько ждать — в заголовке Retry-After. |
Формат ошибок, заголовки лимитов и что делать при каждой — в статье «Ошибки».