cmtt-ru / api

Публичная документация API TJournal

TJournal API documentation

Открытая документация API TJournal.

Внимание! API находится в режиме постоянной разработки, ответы от сервера могут меняться. (Но мы постараемся обо всех изменениях предупреждать :-)

Содержание

1. Выполнение запросов
2. Ошибки
3. Методы API
   • Пользователь
     • Информация о пользователе
     • Записи пользователя
   • Клуб
     • Записи Клуба
     • Конкретная запись
     • Поиск
   • Твиты
   • Новости
     • Топ новостей
     • Список категорий
   • Прочее
     • Отправка опечаток
     • Определение статьи по URL

Выполнение запросов

Для обращения к API необходимо сделать GET- или POST-запрос по адресу https://api.tjournal.ru/{v}/{section}/{action}, где:

• {v} — текущая версия API (на данный момент — 2.3);
• {section} и {action} — метод API.

Ответ вернётся в JSON.

Ошибки

API может возвращать различные ошибки в следующем формате:

{
    "error": {
        "code": 404,
        "message": "Method Not Found"
    }
}

Пользователь

Информация о пользователе

GET /2.3/account/info

Параметр	Описание	Варианты	По умолчанию
userId	ID пользователя	1 – ∞

🚀 Test endpoint

---

Записи пользователя

GET /2.3/account/posts

Параметр	Описание	Варианты	По умолчанию
userId	ID пользователя	1 – ∞	текущий пользователь
count	количество	1 – 50	30
offset	отступ от начала	0 – ∞	0

🚀 Test endpoint

Клуб

Записи Клуба

GET /2.3/club

Параметр	Описание	Варианты	По умолчанию
count	количество	1 – 50	30
offset	отступ от начала	0 – ∞	0
type	тип записи	0 (все), 1 (новости), 2 (оффтоп), 3 (видео), 4 (статьи)	0
sortMode	вид сортировки	mainpage, recent, week, unadmitted, editorial	mainpage

🚀 Test endpoint

---

Конкретная запись

GET /2.3/club/item

Параметр	Описание	Варианты	По умолчанию
entryId	ID записи	1 – ∞

🚀 Test endpoint

---

Поиск

GET /2.3/search

Параметр	Описание	Варианты	По умолчанию
q	Поисковая строка (может быть хэштегом)
count	количество	1 – 50	30
offset	отступ от начала	0 – ∞	0
type	тип поиска	1 (клуб), других вариантов пока нет	1

🚀 Test endpoint

Твиты

Топ твитов

GET /2.3/tweets

Параметр	Описание	Варианты	По умолчанию
count	количество твитов	1 – 50	50
offset	отступ от начала	0 – ∞	0
listId	категория	1,2,3	1
interval	период времени	3hours, fresh, week, month	fresh

🚀 Test endpoint

Новости

Топ новостей

GET /2.3/news

Параметр	Описание	Варианты	По умолчанию
count	количество новостей	1 – 50	50
listId	категория	1,2...
interval	период времени	fresh, popular	popular

🚀 Test endpoint

---

Список категорий

GET /2.3/news/lists

Параметр	Описание	Варианты	По умолчанию
listId	категория (если нужно получить конкретную)	0,1,2...
showSources	показывать источники	0,1	1

🚀 Test endpoint

Прочее

Отправка опечаток

POST /2.3/misprints/new

Параметр	Описание	Варианты	По умолчанию
text	опечатка
url	адрес статьи

---

Определение статьи по URL

GET /2.3/content/reveal

Параметр	Описание	Варианты	По умолчанию
url	адрес статьи

🚀 Test endpoint