Ключи API
Обзор возможностей
Расширьте возможности, которые вам предоставляет Merchant Portal с помощью наших API:
| API | Softline Checkout | Softline Payments |
| Products API Создание и управление продуктами в каталоге, включая настройку цен, подписок, дополнительных продуктов и т.п. После подключения рекомендуем обратиться в службу поддержки для настройки способа генерации лицензии по умолчанию. |
Используется | Не используется |
| Dynamic Product Checkout API Создание специальных ссылок на покупку, с передачей характеристик продуктов и данных покупателя для предзаполнения в корзине См. также сравнение возможностей управления через API и Merchant Portal |
Используется | Не используется |
| Promotions API Предоставление покупателям скидок на продукты (мгновенно применяемые скидки, скидки с активацией по промокоду) |
Используется | Не используется |
| Orders API Получение информации о заказе по его номеру и другим характеристикам. Создание заявок на возврат |
Используется | Используется |
| Subscriptions API Управление подписками покупателей в заказах. Получение информации, изменение, отмена, восстановление подписки |
Используется | Не используется |
| Authentication API Получение авторизационного токена для работы с другими API |
Используется | Используется |
| Payments API Создание платежей и проведение автоплатежей |
Не используется | Используется Для подключения напишите в нашу службу поддержки |
Для авторизации при работе с API вам необходим токен, который вы можете получить через Authentication API.
С помощью этого раздела вы можете:
- Создать учетные записи для работы с API для тестовой и боевой среды
- Изменить пароль, который используется при получении токена для авторизации при работе с API
Создание учетной записи для работы с API
Для начала работы с API вам необходимо создать учетную запись. Данные этой учетной записи (username и password) вы будете использовать в дальнейшем при получении токена через Authentication API.
При создании учетной записи для вас также будут предоставлены доступы ко всем API, перечисленным выше.
Чтобы создать учетную запись:
- Откройте Merchant Portal и пройдите авторизацию
- Проверьте режим работы с порталом
- Если вы работаете в Режиме тестирования, то учетная запись будет предназначена для работы с API в тестовой среде
- Если режим тестирования выключен, то учетная запись будет предназначена для работы с API в боевой среде
- Перейдите в раздел Разработчикам / Ключи API
- Нажмите кнопку Создать пароль
- После этого система создаст для вас учетную запись и настройки подключения ко всем вышеперечисленным API
- На вашем экране появится информация о созданном подключении, в которой будут данные (API логин и пароль) необходимые для работы с Authentication API
- Важно! Обязательно сохраните эти данные на своей стороне. После того, как вы закроете окно с данными, вы не сможете повторно посмотреть пароль.
Вы можете создать только одну учетную запись для каждой среды (тестовой / боевой).
Использование учетной записи при работе с API
После того, как вы создали учетную запись, вы получили данные для авторизации (API логин и пароль). Используйте их при отправке запроса к Authentication API, чтобы получить авторизационный токен:
|
Данные учетной записи, созданной через портал |
Данные для отправки запроса на получение токена авторизации |
|
API логин |
|
|
Пароль |
Используйте токен для авторизации при работе с другими нашими API. Дополнительной настройки на нашей стороне для начала работы с API не требуется. Посмотрите дополнительные инструкции по работе с каждым API
Просмотр учетной записи
После того, как учетная запись создана, вы можете посмотреть информацию о ней в разделе API keys.
- Откройте Merchant Portal и пройдите авторизацию
- Перейдите в раздел Разработчикам / Ключи API
В зависимости от того, включен или выключен тестовый режим вы видите свою учетную запись для тестовой или боевой среды.
Для вашей учетной записи выводится следующая информация:
- Логин API (используется в качестве username при работе с Authentication API)
- Данные о пароле:
- 4 последних символа
Обратите внимание, возможности посмотреть пароль полностью – нет. Если вы потеряли пароль, то измените его - Дата последнего обновления пароля
- 4 последних символа
Изменение пароля учетной записи
Вы можете изменить пароль для учетной записи после ее создания. При этом старый пароль перестанет действовать.
Для этого:
- Откройте Merchant Portal и пройдите авторизацию
- Проверьте режим работы с порталом
- Если режим тестирования включен, то учетная запись предназначена для работы с API в тестовой среде
- Если режим тестирования выключен, то учетная запись предназначена для работы с API в боевой среде
- Перейдите в раздел Разработчикам / Ключи API
- В блоке ранее созданной учетной записи нажмите кнопку Изменить пароль
- После этого система создаст новый пароль для вашей учетной записи и отобразит его на экране. Обратите внимание, старый пароль при этом перестанет действовать
- Важно! Обязательно сохраните новый пароль на своей стороне. После того, как вы закроете окно с паролем, вы не сможете повторно его посмотреть