Если вдруг что-то останется непонятным — напишите нам в поддержку: https://t.me/lava_sup_bot

Для того, чтобы начать настройку интеграции на платформе, потребуется создать API key и добавить webhook.

1. Перейдите в раздел Интеграции в основном меню, выберите тип интеграции Public API.

2. Нажмите Настроить API key.

3. Платформа создаст ключ автоматически: скопируйте и сохраните его на своём устройстве.

1. Создайте API key и подтвердите, что вы его сохранили.
2. Нажмите на кнопку Добавить Webhook.

3. Заполните поля:

• URL — это ссылка на сервис, куда будут отправляться webhook (сервер, который будет обрабатывать запросы);
• Тип события:

1. Результат платежа — обычная покупка: этот webhook можно использовать для единоразовых платежей, а также для первого платежа по подписке.
2. Регулярный платеж — покупка подписки: используется для оплаты второго, третьего и последующих платежей по подписке.

4. Выберите тип аутентификации:

• Basic - введите логин и пароль от вашего сервиса, куда будут отправляться webhook.

• API key вашего сервиса - введите API key от вашего сервиса, куда будут отправляться webhook. Максимальная длина ключа — 80 символов.

Для этого нажмите на три точки рядом с нужным ключом и выберите Добавить Webhook.

Products - для работы с цифровыми продуктами: получение списка продуктов и изменение их параметров (например, цены).

Invoices - для создания контрактов на покупку и проверку их статуса.

Reports - для получения данных для аналитики по продажам через API.

Subscriptions - для управления подписками пользователей.

Donate - для получения ссылок на донат.

1. укажите API key:

• нажмите кнопку Authorize в верхнем углу страницы:

• заполните ApiKeyAuth (apiKey), (используйте API key, который вы получили в ЛК Автора в пользовательском интерфейсе lava.top Интеграции → Public API → Создать API key (более подробно рассказывали про это здесь)):

2. нажмите кнопку Try it out, введите необходимые данные и выберите опцию Execute:

Скачайте пакет с PyPI, обычно с помощью pip:

1.pip install lava-top-sdk

Убедитесь, что при установке библиотеки lava-top-sdk также устанавливаются все её зависимости.

Доступно на npm

1.npm install --save lava-top-sdk

Подключите пакет из репозитория Maven

1.<dependency>
2.	<groupId>top.lava</groupId>
3.	<artifactId>lava-top-kotlin-sdk</artifactId>
4.	<version>1.0.0</version>
5.</dependency>

Если webhook не были доставлены, система предпримет попытки повторно отправить их на указанный URL. Повторные попытки осуществляются по логике: сначала 1с, 5с, 15с, далее 10 попыток с интервалом в 1 мин, далее, если не удалось, еще 5 попыток с интервалом в 1 час.

Всего будет сделано до 20 попыток.

Историю можно найти в карточке аккаунта. Для этого перейдите в редактирование Интеграции → Public API → История webhooks.

Здесь фиксируются события, на которые настроены соответствующие webhook. Эти события различаются по типу, статусу и паре API Key+webhook. В деталях платежа можно увидеть тело запроса, отправленного в момент события, а также историю попыток отправки (при неудачном списании по подписке webhook приходит только по последней попытке списания (т.е. если было 3 попытки списания, то webhook придет только по третей), при возвратах webhook не отправляется). Чтобы просмотреть детали платежа, нужно кликнуть по строке webhook.

Чтобы найти нужный webhook можно использовать расширенные фильтры - искать по Почте покупателя, ID инвойса или Названию или ID продукта.

Каждое событие привязано к типу платежа и статусу контракта.

Типы платежей:

• оплата (покупка цифрового продукта, курса, консультации или первый платёж по подписке);
• рекуррентный платёж (продление или отмена подписки).

Статусы контракта:

• success (успешный платёж);
• failed (незавершённый платёж, например, недостаточно средств на балансе клиента);
• cancelled (отменённый, в случае подписки).

Поэтому в истории можно встретить следующие Типы событий:

• payment.successpayment.success — успешная покупка продуктов (не донатов) или первая оплата подписки;
• payment.failedpayment.failed — неуспешная покупка продуктов (не донатов) или первая оплата подписки;
• subscription.recurring.payment.successsubscription.recurring.payment.success — успешное продление подписки (второй, третий и последующие платежи);
• subscription.recurring.payment.failedsubscription.recurring.payment.failed — неуспешное продление подписки (второй, третий и последующие платежи);
• subscription.cancelledsubscription.cancelled — отмена ранее купленной подписки.

Чтобы получать эти события, нужно настроить соответствующие webhook. При их создании нужно выбрать один из двух типов событий:

• Webhook с типом «Результат платежа» (принимает только события payment.successpayment.success и payment.failedpayment.failed .)
• Webhook с типом «Регулярный платеж» (принимает только события subscription.recurring.payment.successsubscription.recurring.payment.success , subscription.recurring.payment.failedsubscription.recurring.payment.failed и subscription.cancelledsubscription.cancelled ).

Статус показывает был ли получен webhook.

Может быть только два статуса:

• DELIVERED (доставлено) — webhook успешно доставлен.
• FAILED (не доставлено) — произошел сбой при доставке.

Статус webhook определяется HTTP-кодом, который поступает вместе с событием.

Платформа lava.top использует HTTP-коды ответа для обозначения успешного выполнения или ошибки при обработке API-запросов.

В случае получения кода о неудачной доставке lava.top повторяет попытки отправки до 19 раз.

Если webhook не были доставлены, система предпримет попытки повторно отправить их на указанный URL. Повторные попытки осуществляются по логике: сначала 1с, 5с, 15с, далее 10 попыток с интервалом в 1 мин, далее, если не удалось, еще 5 попыток с интервалом в 1 час.

Всего будет сделано до 20 попыток.

При каждой попытке отправить webhook в историю будет добавляться событие с соответствующим HTTP-кодом. Если статус-код указывает на успех, то появится одно событие об успешной или неуспешной оплате. При неуспешном ответе может быть до 20 попыток (они прекращаются после успешной отправки или после 19 попыток). Все эти события можно просмотреть в разделе «История попыток отправки» в деталях webhook. 

Наиболее популярные коды ответов:

• Код 401 / Код 403 — неверные данные авторизации, нельзя получить доступ к методу принятия webhook;
• Код 404 — в webhook прописан неверный URL
• Код 500 — ошибка на стороне сервера автора, который принимает webhook.

С помощью кнопки стрелки каждый webhook можно отправить повторно.

Нажмите и подтвердите отправку.

Добавлена возможность отправки донатов через Stripe.

Доработан запрос GET /invoices: теперь возвращается поле parentInvoiceId (ID родительской транзакции при оформлении подписки).

Добавлена возможностью оплаты через PayPal:

• оплата подписок,
• отправка доната.

Улучшен функционал работы с webkook:

• возможность повторной отправки,
• получение списка webhook,
• добавление типа (события) в тело webhook,
• возможность поиска webhook по Product ID в ЛК кабинете автора (Интеграции → Public API → История webhooks).

Добавлена поддержка UTM-меток.

Добавлена возможность оплаты цифровых продуктов через провайдера Stripe.