Client for TGStat API (original) (raw)

Установка

На данный момент пакет rtgstat можно устновить из CRAN:

# install.packages("devtools")
devtools::install_github("selesnow/rtgstat")

Авторизация

Для прохождения авторизации вам необходимо активировать в своём профиле TGStat один из доступных тарифов TGStat API.

Токен доступа к API

Более подробно о токенах и работе с ними читай в официальной справке.

Пример использования

Пример запроса данных из TGStat API:

Опции пакета

В пакете доступны следующие опции:

tg.api_token - Позволяет задать API токен в рамках текущей сессии;
tg.channel_id - Идентификатор канала в рамках сессии;
tg.check_api_quote - Позволяет отключать проверку квоты API, по умолчанию TRUE, для отключения устновите FALSE;
tg.api_quote_alert_rate - Задаёт порог предупреждений об израсходованной квоте API, по умолчанию значение 0.9, т.е. предупреждение будет отображаться если вы израсходовали какую то квоту API более чем на 90%;
tg.max_tries - Позволяет задать количество повторных отправок запроса, в случае сбоя API;
tg.interval - Позволяет задать паузу между повторными отправками запросов, по умолчанию пакет сам управляет паузами;
tg.base_url - Базовый URL обращения к API, крайне не рекомендуется изменять данную опцию.

Для установки каждой опции в rtgstat есть вспомогательная функция с именем заданным следующим щаблоном tg_set_имя_опции(значение_опции). Т.е. установить любую опцию можно двумя способами:

Посмотреть текущие значения опций rtgstat можно с помощью функции [tg_options()](reference/tg%5Foptions.html):

tg_options()

rtgstat options:
tg.api_token: <hidden>
tg.base_url: https://api.tgstat.ru/
tg.max_tries: 1
tg.check_api_quote: TRUE
tg.api_quote_alert_rate: 0.9

Переменные среды

Для удобства работы вы можете использовать переменные среды для установки значений по умолчанию:

TG_API_TOKEN - Ваш токен доступа к TGStat API;
TG_CHANNEL_ID - Идентификатор основного канала для работы с TGStat API.

Прописать переменные среды можно в файле .Renviron, или использовать интерйес операционной системы.