Инструменты пользователя
Это старая версия документа.
API в классическом понимании этого слова имеет следующее определение:
Интерфейс программирования приложений (иногда интерфейс прикладного программирования) (англ. application programming interface, API [эй-пи-ай])[1] — набор готовых классов, процедур, функций, структур и констант, предоставляемых приложением (библиотекой, сервисом) для использования во внешних программных продуктах. Используется программистами для написания всевозможных приложений.
В системе Onpay API это набор переменных и правил, задействованных в коммуникации между сервером Мерчанта и сервером Onpay, позволяющих автоматизировать прием платежей и осуществлять их тонкую настройку. Также API может называться Протокол уведомления о платежах.
API Onpay состоит из двух частей:
1. Платежная ссылка. Ссылка имеет вид
http://secure.onpay.ru/pay/{merchant_login}?pay_mode=fix&price=481.19¤cy=WMZ&pay_for=123
После знака «вопрос» передаются параметры платежной ссылки, позволяющие генерировать ссылки для разных целей и задач.
В данном примере - Платеж на фиксированную сумму 481.19 WMZ за счет №123.
Мерчант может генерировать ссылки как через Личный Кабинет, так и в простом HTML, использую семантику API.
Более подробно см. в Спецификации на платежные ссылки.
2. Протокол обмена данными. Используется в первую очередь для уведомлений при автоматизации платежей.
API позволяет обмениваться данными между сервером Onpay и сервером Мерчанта в безопасном режиме.
Таким образом, можно избавиться от ручной сортировки оплаченных покупок, неоплаченных заявок и т.п. - просто прописав что должен делать Ваш сервер для того или иного статуса заказа.
Протокол обмена данными реализован на РНР, фреймворках Джанго и ASP, а также для множества популярных CMS.