Начало

Документация для разработчиков

С помощью API Glitch ваши программы могут писать в каналы сообществ. Сервер сборки сообщает, что новая версия готова. Игровой сервер пишет, кто зашёл и кто победил. Мониторинг присылает тревогу, когда что-то упало. Всё это приходит в канал обычными сообщениями, которые участники видят в приложении на телефоне, компьютере и в браузере.

Адрес API один для всех запросов.

https://api.glitchapp.online/v10

Совместимость с Discord

API Glitch устроено так же, как API Discord версии 10. У нас те же адреса ручек, те же поля в запросах и ответах, те же коды ошибок и тот же способ ограничивать частоту запросов. Поэтому программа, которая уже отправляет сообщения в Discord, переносится на Glitch заменой адреса. Готовые библиотеки discord.py и discord.js тоже работают, в них нужно поменять одну строку. Как это сделать, показано на странице Библиотеки.

Glitch всё же не копия Discord, и некоторые вещи у нас устроены иначе. Все такие места собраны на странице Отличия от Discord. Если в запросе есть то, чего у нас нет, API не станет молча это пропускать. Вы получите отказ с кодом 50035 и названием параметра, и сразу будет понятно, что пошло не так.

Что можно сделать сейчас

Вебхуки. Вебхук — это адрес, через который программа пишет в один текстовый канал сообщества. Через него можно отправить текст, до 10 картинок или файл, карточки с заголовком, полями и картинкой. Имя и аватарку автора можно задать отдельно для каждого сообщения. Отправленное сообщение потом можно изменить или удалить. Создаётся вебхук в настройках канала, отдельная регистрация для этого не нужна.

GitHub и Slack. Адрес вебхука сам принимает события GitHub и сообщения в формате входящих вебхуков Slack. Коммиты, запросы на слияние и выпуски появляются в канале без промежуточного сервера.

Что появится позже

Боты. У бота будет свой аккаунт и ключ. Он сможет читать и отправлять сообщения в каналах, где его пустили, получать события в реальном времени и отвечать на команды «/». Разделы о ботах уже есть в оглавлении и заполнятся, когда боты станут доступны.

Портал разработчика. Это страница, где создаются приложения и боты и выдаются их ключи.

С чего начать

Быстрый старт. Создайте вебхук и отправьте первое сообщение. Это займёт пару минут.
Как устроено API. Здесь описано, в каком виде отправлять запросы и что приходит в ответ.
Вебхук. Полное описание всех возможностей вебхука с примерами.
Пределы частоты и Ошибки. Их стоит прочитать до того, как программа пойдёт в работу.

Если что-то не работает или в документации чего-то не хватает, напишите на support@glitchapp.online.