API: как создать ключ и вебхуки?
Интеграция — это процесс объединения двух или более сервисов с использованием API. Она позволяет системам обмениваться информацией и функциями, обеспечивая их слаженную работу.
На сайте lava.top можно настроить интеграцию с Telegram-ботом, что даст возможность принимать и отслеживать оплаты, а также контролировать статусы подписок. Это сделает рабочие процессы более удобными.
Первое, что необходимо узнать - это ключевые термины:
● Public API — это инструмент, который позволяет программам и приложениям взаимодействовать друг с другом через интернет.
● API-ключ — это уникальный код, который открывает определённый API. Он работает, как ключ к сейфу: без него вы не можете получить доступ к данным или функциям, которые предоставляет API.
● Webhook — это инструмент, который позволяет приложениям автоматически обмениваться данными. Например, у вас есть платный канал, доступ к которому должны иметь только те, кто оформил подписку. Вместо того чтобы отслеживать оплаты вручную, можно настроить интеграцию и автоматизировать процесс предоставления доступа.
Для того, чтобы начать настройку интеграции на платформе, потребуется создать API-ключ и добавить вебхуки. Рассмотрим весь процесс немного подробнее.
Чтобы создать API-ключ нужно выполнить следующие шаги:
1. Перейдите в раздел «Моя страница» и нажмите на «Профиль» в правом углу страницы.
2. Перейдите в раздел «Интеграция» и нажмите «Добавить API-ключ»:
Чтобы добавить вебхук нужно выполнить следующие шаги:
1. Создайте API-ключ и подтвердите, что вы его сохранили.
2. Нажмите на кнопку «Добавить Webhook».
3. Заполните поля:
● URL — это ссылка на сервис, куда будут отправляться вебхуки;
● Тип события:
«Результат платежа» — обычная покупка: этот вебхук можно использовать для единоразовых платежей, а также для первого платежа по подписке.
«Регулярный платёж» – покупка подписки: используется для оплаты второго, третьего и последующих платежей по подписке.
Важно! Чтобы настроить подписку, нужно создать два вебхука. Первый будет иметь тип «результат платежа», и на него будут приходить первые платежи по подписке. Второй вебхук, с типом «регулярный платеж», будет получать все последующие оплаты.
Для Basic введите логин и пароль от вашего сервиса, куда будут отправляться вебхуки.
Для API key введите API-ключ от вашего сервиса, куда будут отправляться вебхуки. Максимальная длина ключа - 80 символов.
Как добавить вебхуки для уже созданных ключей:
Для этого нажмите на три точки рядом с нужным ключом и выберите «Добавить Webhook».
Готово! API-ключ и вебхук созданы. После выполнения этих шагов можно перейти к документации и продолжить работу. Если возникнут вопросы, ответ найдется в следующей статье «Документация API».