Ключі API

Ключ API — це токен для програм: скрипта, який кудись зберігає записи, іншого застосунку, що показує ваші стрічки, резервного копіювання. Він дає той самий доступ, що й ваш вхід в акаунт, але без пароля і без терміну дії.

Як створити ключ

Відкрийте Settings (налаштування) → API keys (ключі API), дайте ключу назву і створіть його. Ключ показують лише один раз, тож скопіюйте його одразу. Кожен ключ можна відкликати в тому самому списку, а скільки ключів можна мати, залежить від тарифу (на безкоштовному тарифі — жодного).

Як ним користуватися

Передавайте ключ у заголовку X-Auth-Token у запитах до https://microrss.com/api/reader/…:

curl -H "X-Auth-Token: <key>" https://microrss.com/api/reader/feeds

Ресурси:

шлях	що повертає
me	кому належить ключ, тариф і його ліміти
feeds, feeds/counters	ваші підписки і кількість непрочитаного в них
feeds/<id>/entries, categories/<id>/entries, entries	записи; параметри запиту — status, search, order і published_after
entries/<id>	один запис; PUT з {"status": "read"} позначає його
entries/<id>/bookmark	додає або знімає закладку
mark-all-as-read	позначає прочитаним цілий обсяг одразу
opml	GET завантажує ваші підписки, POST імпортує файл

Там, де API збігаються, формат даних такий самий, як у Miniflux API, тож у програмах, написаних для Miniflux, зазвичай досить змінити адресу й заголовок.

Як уберегти ключ

Ключ у скрипті, що потрапив у чужі руки, — це ключ до вашого акаунта. Відкличте його в Settings і створіть новий: зміна пароля ключі не відкликає.