Loading...Данный API эндпоинт позволяет создавать URL-ы для оплаты без предварительной аутентификации пользователя. API автоматически создает пользователя, если он не существует, и возвращает URL для оплаты.
Эндпоинт
Аутентификация
Для использования API необходимо добавить заголовок
x-api-key с действительным API ключом.Как получить API ключ:
- Войдите в свой аккаунт
- Перейдите в раздел "Настройки" → "API Ключи"
- Создайте новый API ключ или скопируйте существующий
- Используйте этот ключ в заголовке запроса
Параметры Запроса
URL Параметры
- paywallId (строка, обязательный) - ID paywall в URL
Тело Запроса
Как получить ID цены? Используйте это API: Get prices
Как получить айди пейвола? Перейдите в настройки пейвола в ЛК и возьмите его из URL.
Пример:
https://monetize.software/en/publisher/paywalls/547
Paywall ID здесь 547
Параметры:
- email (строка, обязательный) - Email пользователя
- priceId (строка/число, обязательный) - ID цены
- successUrl (строка, необязательный) - URL для перенаправления при успешной оплате
- errorUrl (строка, необязательный) - URL для перенаправления при ошибке оплаты
- shopUrl (строка, необязательный) - URL магазина для возврата
- ignoreActivePurchase (булево, необязательный) - Игнорировать проверку активной покупки
Пример Запроса
Успешный Ответ
Возможные Ошибки
400 - Неверный Запрос
401 - Неавторизован
409 - Конфликт
500 - Внутренняя Ошибка Сервера
Логика Работы
- Проверка параметров - проверяет наличие всех обязательных параметров и корректность формата email
- Проверка URL - проверяет корректность формата successUrl, errorUrl и shopUrl
- Аутентификация - проверяет API ключ
- Проверка пользователя - ищет пользователя в базе данных по email
- Создание пользователя - если пользователь не найден, создает нового
- Привязка к paywall - связывает пользователя с указанным paywall
- Проверка активных покупок - проверяет наличие активных покупок
- Создание checkout - создает платежную сессию и возвращает URL
Безопасность
- API ключ должен храниться в безопасном месте
- Рекомендуется использовать HTTPS для всех запросов
- API автоматически проверяет формат email
- API проверяет формат предоставленных URL
- Проверяются активные покупки для предотвращения дублирования
- Используются безопасные URL по умолчанию
Интеграция
После получения
checkoutUrl, перенаправьте пользователя на этот URL для завершения оплаты:Часто Задаваемые Вопросы
Как проверить статус оплаты?
Для отслеживания статуса оплаты рекомендуется использовать вебхуки.
Альтернативные методы проверки:
- URL перенаправления - обработка успешных/неудачных перенаправлений
- Портал клиента - проверка статуса подписки
Вебхуки являются наиболее надежным способом отслеживания платежей, поскольку они гарантируют доставку уведомлений даже если пользователь закроет браузер после оплаты.