Веб-магазин / Получение информации о подписках
 На главную

Веб-магазин

  • Настройка продажи в Веб-магазине с прямым пополнением

  • Настройка продажи в Веб-магазине с аутентификацией пользователя

  • Получение информации о подписках

    Если в веб-магазине планируется продажа подписок, реализуйте получение информации о действиях с подписками одним из способов:

    Настройка через методы API

    В клиентской части вашего приложения реализуйте получение информации о подписках пользователя с использованием HTTP GET-запроса.

    API Иксоллы использует HTTP-аутентификацию. Запрос должен содержать заголовок Authorization: Bearer <client_user_jwt>, где <client_user_jwt> — уникальный токен, закодированный по стандарту Base64. Используйте для его получения:

    В качестве path-параметра укажите projectId — ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта. В качестве query-параметров укажите:

    • limit — лимит количества элементов на странице (по умолчанию на странице выдается 15 записей).
    • offset — номер элемента, с которого выполняется вывод на странице (нумерация ведется с 0).
    • locale — язык интерфейса, принимает значения в соответствии со стандартом ISO 639-1 (по умолчанию английский).

    Copy
    Full screen
    Small screen
    Пример запроса:
      'https://subscriptions.xsolla.com​/api/user/v1/projects/{projectId}/subscriptions?locale=ru&limit=5&offset=5 ' \
      -H 'accept: application/json' \
      -H 'Authorization: Bearer client_user_jwt'

    Copy
    Full screen
    Small screen
    Пример ответа:
    {
      "items": [
        {
          "id": 13371337,
          "plan_id": 66053,
          "plan_external_id": "TestChangePlanBase",
          "plan_name": "package_recurrent_name_66053",
          "plan_description": "package_recurrent_description_66053",
          "product_id": null,
          "product_external_id": null,
          "product_name": null,
          "product_description": null,
          "status": "active",
          "date_create": "2021-03-11T13:50:11+03:00",
          "date_next_charge": "2031-04-11T13:51:02+03:00",
          "date_last_charge": "2021-03-11T13:51:02+03:00",
          "charge": {
            "amount": "0.2500",
            "currency": "USD"
          },
          "period": {
            "value": 5,
            "unit": "day"
          }
        }
      ],
      "has_more": true
    }
    

    Настройка вебхуков

    1. Настройте параметры для получения вебхуков:
      1. Откройте ваш проект в Личном кабинете.
      2. Нажмите Настройки проекта в боковом меню.
      3. Перейдите на вкладку Вебхуки.
      4. Установите переключатель Вебхуки в положение Вкл.
      5. В поле URL вебхука укажите URL-адрес, на который вы хотите получать вебхуки.
      6. Секретный ключ проекта для подписи вебхуков генерируется по умолчанию. Если вы хотите изменить его, нажмите значок обновления.
      7. Нажмите Сохранить настройки.

    1. В приложении реализуйте обработку следующих типов вебхуков:

    1. Протестируйте вебхуки:
      1. В Личном кабинете в разделе Настройки проекта > Вебхуки перейдите на вкладку Подписки.

      1. Чтобы проверить работу системы вебхуков, укажите значения из вашего проекта (User ID, Invoice ID), которые будут отправлены в запросе на указанный URL. При отсутствии реальных значений допускается ввод произвольных значений. Заполните поля:
        • ID пользователя;
        • ID заявки в Иксолле;
        • сумма;
        • валюта;
        • ID плана;
        • продукт подписки (опционально);
        • Invoice ID — внутренний номер заказа (опционально);
        • пробный период (для тестирования оплаты подписки без пробного периода или тестирования продления подписки укажите значение 0).

    Note
    В Личном кабинете вы можете протестировать только базовые вебхуки Проверка существования пользователя и Успешный платеж.

      1. Нажмите Тестировать.
      2. Убедитесь, что сообщение об успешном завершении тестирования получено. При успешной обработке запроса ваш сервер должен вернуть:
        • 204 HTTP-код без тела сообщения в случае успешного ответа.
        • 400 или 500 HTTP-коды с описанием проблемы, если указанный пользователь не был найден или если передана недействительная подпись.

    1. Протестируйте получение остальных вебхуков:
      1. Используйте тестовое окружение, чтобы протестировать покупку и продление подписки и получить вебхуки Создание подписки, Изменение подписки, Отмена подписки.
      2. Используйте боевое окружение, чтобы протестировать покупку подписки на реальных платежах и получить вебхуки Возврат платежа, Отмена подписки.

    Прогресс интеграции
    Спасибо за обратную связь!
    Последнее обновление: 12 мая 2022

    Нашли опечатку или ошибку в тексте? Выделите ее и нажмите Ctrl+Enter.

    Сообщите о проблеме
    Мы постоянно улучшаем качество нашей документации. Ваш отзыв поможет нам в этом.
    Укажите email-адрес, чтобы мы могли связаться с вами
    Спасибо за обратную связь!