Pushy — это комбинация REST API и получателей, которая позволяет отправлять уведомления о новых событиях в чаты или пользователям через простые HTTP-запросы. В этом руководстве приведены примеры того, что может делать Pushy.

Быстрый старт

После создания рассылки (например, в Telegram-боте) вы получите API-ключ. Этот ключ API передается в большинство методов API как параметр api_key.

Вы можете сохранить его как переменную окружения, чтобы нижеуказанные примеры работали:

export API_KEY=ak000000000000000000 # Замените на полученный ранее API-ключ

Типичное использование можно попробовать, подписавшись на рассылку и проверив ее, отправив запрос POST /v1/feeds/{api_key}/text с api_key, который вы получили ранее, и текстом уведомления в теле запроса.

Это можно сделать с помощью curl:

curl -X POST \
 "https://api.pushy.tg/v1/feeds/$API_KEY/text" \
 -d 'Привет, мир!'

Уведомление с текстом Привет, мир! будет отправлено всем подписчикам рассылки.

Редактирование

Команда выше вернет уникальный post_key, который вы можете использовать для редактирования существующих уведомлений. Не забудьте сохранить его вместе с API-ключом.

export EDIT_KEY=pk000000000000000000 # Замените на полученный ранее ключ поста

Теперь все, что вам нужно, — это подставить этот ключ в параметр edit_key запроса PUT /v1/feeds/{api_key}/text/{edit_key}:

curl -X PUT \
 "https://api.pushy.tg/v1/feeds/$API_KEY/text/$EDIT_KEY" \
  -d 'Привет, Pushy!'

Теги

Вы можете добавить теги к отправляемым уведомлениям. Это можно сделать с помощью параметра tags в вышеуказанных запросах:

curl -X POST \
 "https://api.pushy.tg/v1/feeds/$API_KEY/text?tags=hello,world" \
  -d 'Привет, мир!'

Узнайте больше об этой функции в специальном разделе документации.

Медиа

Поддерживается отправка медиа-вложений некоторых форматов.

Медиа можно отправить по его URL:

curl -X POST \
 "https://api.pushy.tg/v1/feeds/$API_KEY/text?media_url=docs.pushy.tg/img/logo.png" \
 -d 'Вот логотип!'

Медиа также можно загрузить напрямую:

curl -X POST \
 "https://api.pushy.tg/v1/feeds/$API_KEY/media?media_type=image&media_caption=И здесь тоже!" \
 --data-binary '@logo.png'

Дополнительные сведения о поддерживаемых форматах медиа можно найти в специальном разделе.