Инструменты пользователя
api-notify
Различия
Здесь показаны различия между двумя версиями данной страницы.
| Both sides previous revision Предыдущая версия Следущая версия | Предыдущая версия Последняя версия Both sides next revision | ||
|
api-notify [2014/10/20 07:23] admin |
api-notify [2023/08/22 07:11] admin [Описание и очередность транзакций] |
||
|---|---|---|---|
| Строка 10: | Строка 10: | ||
| Для включения работы по API, Вам нужно:\\ | Для включения работы по API, Вам нужно:\\ | ||
| 1. Активировать функцию **“Уведомление по API”** в разделе Настройки Магазина в Кабинете Продавца Onpay\\ | 1. Активировать функцию **“Уведомление по API”** в разделе Настройки Магазина в Кабинете Продавца Onpay\\ | ||
| - | 2. Указать **API URL** в соответствии со скриптом API на Вашем сервере.\\ | + | 2. Указать **API URL** в соответствии со скриптом API на Вашем сервере. В **API URL** возможно использование кириллицы.\\ |
| 3. Установить секретный ключ для “уведомлений по API”, который должен быть таким же, как в скрипте на Вашем сервере, чтобы позволить генерацию контрольных подписей.\\ | 3. Установить секретный ключ для “уведомлений по API”, который должен быть таким же, как в скрипте на Вашем сервере, чтобы позволить генерацию контрольных подписей.\\ | ||
| + | Разрешается использование параметров в указываемом API URL, по которому будут приходить уведомления. При этом накладывается ограничение в виде списка зарезервированных API Onpay параметров, которые запрещается использовать в API URL настроек магазина. Список зарезервированных параметров прилагается:\\ | ||
| + | //onpay_id\\ | ||
| + | pay_for\\ | ||
| + | order_amount\\ | ||
| + | order_currency\\ | ||
| + | balance_amount\\ | ||
| + | balance_currency\\ | ||
| + | exchange_rate\\ | ||
| + | type\\ | ||
| + | comment\\ | ||
| + | paymentDateTime\\ | ||
| + | md5// | ||
| ====Описание и очередность транзакций==== | ====Описание и очередность транзакций==== | ||
| - | \\ | ||
| **Onpay.ru производит 2 вида запросов к системе Продавца через API:**\\ | **Onpay.ru производит 2 вида запросов к системе Продавца через API:**\\ | ||
| 1. Запрос **“check”** используется, чтобы получить разрешение от системы Продавца на прием платежа от Клиента. После удачного получения разрешения, Onpay.ru одобрит платёж. С этого момента, если Клиент действительно производит платёж, Продавец может видеть его во вкладке **“Платежи”** в [[http://wiki.onpay.ru/doku.php?id=cabinet|Кабинете Продавца]].\\ | 1. Запрос **“check”** используется, чтобы получить разрешение от системы Продавца на прием платежа от Клиента. После удачного получения разрешения, Onpay.ru одобрит платёж. С этого момента, если Клиент действительно производит платёж, Продавец может видеть его во вкладке **“Платежи”** в [[http://wiki.onpay.ru/doku.php?id=cabinet|Кабинете Продавца]].\\ | ||
| 2. Запрос **“pay”** является, по сути, уведомлением для системы Продавца, о том, что для него принят платеж. После получения уведомления, система Продавца может автоматически отправить заказанные товары или сервисы Клиенту.\\ | 2. Запрос **“pay”** является, по сути, уведомлением для системы Продавца, о том, что для него принят платеж. После получения уведомления, система Продавца может автоматически отправить заказанные товары или сервисы Клиенту.\\ | ||
| - | \\ | ||
| - | **Onpay.ru имеет несколько типов АПИ:**\\ | ||
| - | 1. Основное АПИ (версия 2.0). В Кабинете продавца выбран по умолчанию (поле селектора на HTTPS 2.0). | ||
| - | 2. API 1.0. Старое апи. С этим АПИ, в частности, работают все загружаемые модули с onpaysolutions.ru\\ | ||
| - | 3. Специальное АПИ для Insales (его настройка [[insales|описана отдельно]])\\ | ||
| - | 4. Гибридные АПИ для упрощения миграции (переход с [[robokassa-migration|Робокассы]] и [[interkassa-migration|Интеркассы]])\\ | ||
| \\ | \\ | ||
| **Очередность транзакции:**\\ | **Очередность транзакции:**\\ | ||
| Строка 38: | Строка 43: | ||
| \\ | \\ | ||
| Продавцы могут помечать платежи, как “Принятые” вручную во вкладке **“Платежи”** если API не доступен.\\ | Продавцы могут помечать платежи, как “Принятые” вручную во вкладке **“Платежи”** если API не доступен.\\ | ||
| - | \\ | + | ==== Типы API Onpay.ru ==== |
| - | + | 1. Основное АПИ (версия 2.0). В Кабинете продавца выбран по умолчанию (поле селектора на HTTPS 2.0). | |
| - | * [[description_of_the_api|Описание API (2.0)]] | + | 2. API 1.0. Старое апи. С этим АПИ, в частности, работают все загружаемые модули с onpaysolutions.ru\\ |
| + | 3. Специальное АПИ для Insales (его настройка [[insales|описана отдельно]])\\ | ||
| + | 4. Гибридные АПИ для упрощения миграции (переход с [[robokassa-migration|Робокассы]] и [[interkassa-migration|Интеркассы]])\\ | ||
| + | * **[[description_of_the_api|Описание API (2.1)]]** | ||
| * [[description_of_the_old_api|Старое API (1.0)]] | * [[description_of_the_old_api|Старое API (1.0)]] | ||
| - | |||
| * [[Insales-api|API Insales]] | * [[Insales-api|API Insales]] | ||
| + | * [[interkassa-migration|Миграция с Интеркассы]] | ||
| + | * [[robokassa-migration|Миграция с Робокассы]] | ||
| - | |||
| - | ====== Справочная информация ====== | ||
| ====Недоступность сервера магазина==== | ====Недоступность сервера магазина==== | ||
| Строка 55: | Строка 62: | ||
| Если сервер магазина недоступен для “pay” запроса, система Onpay будет повторно отправлять запрос несколько раз в течение следующих 72 часов. Повторяющиеся запросы посылаются с увеличивающимися интервалами. При этом платеж будет зачислен на счет магазина. | Если сервер магазина недоступен для “pay” запроса, система Onpay будет повторно отправлять запрос несколько раз в течение следующих 72 часов. Повторяющиеся запросы посылаются с увеличивающимися интервалами. При этом платеж будет зачислен на счет магазина. | ||
| - | |||
| - | ====Возвращаемые ошибки==== | ||
| - | |||
| - | На стороне сервера Onpay в зависимости от ответа сервера магазина могут быть сгенерированы следующие ошибки (и в дальнейшем показаны в личном кабинете): | ||
| - | |||
| - | 7.1.1. С сервером магазина нет соединения. http://wiki.onpay.ru/doku.php?id=oshibki#7.1.1\\ | ||
| - | 7.1.2. Платеж отклонен получателем. http://wiki.onpay.ru/doku.php?id=oshibki#7.1.2\\ | ||
| - | 7.1.3. Ошибка авторизации - подпись не совпадает. http://wiki.onpay.ru/doku.php?id=oshibki#7.1.3\\ | ||
| - | 7.1.4. Магазин возвращает неверные данные - pay_for не совпадает. http://wiki.onpay.ru/doku.php?id=oshibki#7.1.4\\ | ||
| - | 7.1.5. Магазин возвращает неверные данные - неверное значение поля (code). http://wiki.onpay.ru/doku.php?id=oshibki#7.1.5\\ | ||
| - | 7.2.1. С сервером мерчанта нет соединения. http://wiki.onpay.ru/doku.php?id=oshibki#7.2.1\\ | ||
| - | 7.2.2. Ошибка авторизации - подпись не совпадает. http://wiki.onpay.ru/doku.php?id=oshibki#7.2.2\\ | ||
| - | 7.2.3. Магазин возвращает неверные данные - pay_for не совпадает. http://wiki.onpay.ru/doku.php?id=oshibki#7.2.3\\ | ||
| - | 7.3.1. Магазин возвращает данные в некорректном формате (требуется XML или упрощенный текстовый формат). http://wiki.onpay.ru/doku.php?id=oshibki#7.3.1\\ | ||
| - | 7.3.2. Магазин возвращает неверные данные - отсутствует обязательный параметр (code). http://wiki.onpay.ru/doku.php?id=oshibki#7.3.2\\ | ||
| - | 7.3.3. Магазин возвращает неверные данные - отсутствует обязательный параметр (pay_for). http://wiki.onpay.ru/doku.php?id=oshibki#7.3.3\\ | ||
| - | 7.3.4. Магазин возвращает неверные данные - отсутствует обязательный параметр (md5). http://wiki.onpay.ru/doku.php?id=oshibki#7.3.4\\ | ||
| - | 7.3.5. Ошибка в параметрах запроса. http://wiki.onpay.ru/doku.php?id=oshibki#7.3.5\\ | ||
| - | 7.3.6. Ошибка авторизации. http://wiki.onpay.ru/doku.php?id=oshibki#7.3.6\\ | ||
| - | 7.3.7. Временная ошибка. http://wiki.onpay.ru/doku.php?id=oshibki#7.3.7\\ | ||
| - | 7.2.5. Если возвращен код отличный от 0, сообщение ошибки берется из поля "comment".\\ | ||
api-notify.txt · Последние изменения: 2023/09/25 07:57 — admin