Инструменты пользователя

Инструменты сайта


description_of_the_api

Различия

Здесь показаны различия между двумя версиями данной страницы.

Ссылка на это сравнение

Both sides previous revision Предыдущая версия
Следущая версия
Предыдущая версия
description_of_the_api [2015/04/20 11:38]
admin [Ответ мерчанта]
description_of_the_api [2017/07/27 12:05] (текущий)
admin [API 2.0]
Строка 1: Строка 1:
-========API 2.0========+========API 2.1========
  
 ======Общая информация====== ======Общая информация======
Строка 20: Строка 20:
 | way | string | Валюта платежа | | way | string | Валюта платежа |
 | mode | string | Тип платежа,​ fix или free | | mode | string | Тип платежа,​ fix или free |
 +| user_email | string | Email плтельщика |
 | signature | string | Контрольная подпись,​ SHA1 от строки - "​check;​pay_for;​amount;​way;​mode;​secret_key"​ | | signature | string | Контрольная подпись,​ SHA1 от строки - "​check;​pay_for;​amount;​way;​mode;​secret_key"​ |
 | additional_params.onpay_ap_xxx | string | Дополнительные параметры,​ переданные в платежной ссылке(см документацию по платежным ссылкам). Данных параметров в запросе НЕ будет, если они не были переданы в платежной ссылке. Алгоритм их формирования смотрите ниже | | additional_params.onpay_ap_xxx | string | Дополнительные параметры,​ переданные в платежной ссылке(см документацию по платежным ссылкам). Данных параметров в запросе НЕ будет, если они не были переданы в платежной ссылке. Алгоритм их формирования смотрите ниже |
Строка 35: Строка 36:
  "​way":"​RUR",​  "​way":"​RUR",​
  "​mode":"​fix",​  "​mode":"​fix",​
 + "​user_email":"​test@test.com",​
  "​signature":"​37eacbf65fa2982be8e2f82d1cb6aef23bf88aa0"​  "​signature":"​37eacbf65fa2982be8e2f82d1cb6aef23bf88aa0"​
  "​additional_params":​{  "​additional_params":​{
Строка 137: Строка 139:
 | pay_for | string | Номер заказа | | pay_for | string | Номер заказа |
 | signature | string | Контрольная подпись,​ SHA1 от строки - "​pay;​status;​pay_for;​secret_key"​ | | signature | string | Контрольная подпись,​ SHA1 от строки - "​pay;​status;​pay_for;​secret_key"​ |
 +| receipt | json | Содержит информацию о списке покупок в чеке |
 +| receipt.items | array | Список товаров в чеке |
 +| receipt.items.name | string | Название товара |
 +| receipt.items.price | float | Цена за единицу товара |
 +| receipt.items.quantity | float | Количество |
 +| receipt.sum | float | Сумма чека |
  
   * "​pay"​ в строке для контрольной подписи - фиксированное слово (3 буквы),​ а не переменная   * "​pay"​ в строке для контрольной подписи - фиксированное слово (3 буквы),​ а не переменная
Строка 144: Строка 152:
 <code class="​json">​ <code class="​json">​
 { {
- "​status":​true,​ +  ​"​status":​true,​ 
- "​pay_for":"​55446",​ +  "​pay_for":"​55446",​ 
- "​signature":"​172de16ada92791b3753b3121d471f5c"+  "​signature":"​a25de68f9516e91ce8782b11abcd5801d7af20f4" 
 +  "​receipt":​ { 
 +    "​items":​ [ 
 +      { 
 +        "​name":​ "​product 1", 
 +        "​price":​ 100.00, 
 +        "​quantity":​ 2.8 
 +      }, 
 +      { 
 +        "​name":​ "​product 2", 
 +        "​price":​ 18.50, 
 +        "​quantity":​ 4 
 +      }, 
 +      { 
 +        "​name":​ "​product 3", 
 +        "​price":​ 500.00, 
 +        "​quantity":​ 1 
 +      } 
 +    ], 
 +    "​sum":​ 854.00 
 +  }
 } }
 </​code>​ </​code>​
Строка 242: Строка 270:
  
 ====Вывод в Кабинеты Покупателей==== ====Вывод в Кабинеты Покупателей====
 +
 +метод - POST
  
 адрес - /​json_interfaces/​wop_payouts адрес - /​json_interfaces/​wop_payouts
Строка 255: Строка 285:
 | phone.number | string | Телефон,​ на который зарегистрирован в кабинет покупателя. Допустимое значение - десять цифр без разделителей,​ первая цифра - 9 | | phone.number | string | Телефон,​ на который зарегистрирован в кабинет покупателя. Допустимое значение - десять цифр без разделителей,​ первая цифра - 9 |
 | phone.code | string | код страны для номера телефона. Допустимое значение - "​7"​ | | phone.code | string | код страны для номера телефона. Допустимое значение - "​7"​ |
-| signature | string | Контрольная подпись,​ SHA1 от строки login;​amount;​email;​api_in_key ​в случае передачи в запросе e-mail и SHA1 от строки login;​amount;​phone_codephone_number;​api_in_key ​в случае передачи в запросе номера телефона. Во втором случае производится конкатенация phone_code и phone_number. |+| signature | string | Контрольная подпись,​ SHA1 от строки login;​amount;​email;​secret_key ​в случае передачи в запросе e-mail и SHA1 от строки login;​amount;​phone_codephone_number;​secret_key ​в случае передачи в запросе номера телефона. Во втором случае производится конкатенация phone_code и phone_number. |
  
 В одном запросе могут быть переданы только хэш с номером телефона или E-mail. В одном запросе могут быть переданы только хэш с номером телефона или E-mail.
Строка 285: Строка 315:
 ^ Название ^ Тип ^ Описание ^ ^ Название ^ Тип ^ Описание ^
 | payment_id | integer | ID исходящего платежа в системе onpay | | payment_id | integer | ID исходящего платежа в системе onpay |
-| signature | string | SHA1 от строки payment_id;​login;​api_in_key ​|+| signature | string | SHA1 от строки payment_id;​login;​secret_key ​|
  
 Пример ответа:​ Пример ответа:​
Строка 296: Строка 326:
  
 ====Выставление счета в кабинет покупателя==== ====Выставление счета в кабинет покупателя====
 +
 +метод - POST
  
 адрес - /​json_interfaces/​payment_orders адрес - /​json_interfaces/​payment_orders
Строка 312: Строка 344:
 | note | string | Комментарий к платежному ордеру. Лимит - 255 символов. Необязательный параметр | | note | string | Комментарий к платежному ордеру. Лимит - 255 символов. Необязательный параметр |
 | login | string | Название сайта в системе Onpay | | login | string | Название сайта в системе Onpay |
-| signature | string | Цифровая подпись,​ sha1 от строки login;​user_email;​pay_for;​way;​amount;​api_in_key ​|+| signature | string | Цифровая подпись,​ sha1 от строки login;​user_email;​pay_for;​way;​amount;​secret_key ​|
  
 Пример запроса:​ Пример запроса:​
Строка 332: Строка 364:
 ^ Название ^ Тип ^ Описание ^ ^ Название ^ Тип ^ Описание ^
 | uniq_id | integer | Идентификатор платежного ордера,​ состоящий из девяти цифр, первая из которых 3 | | uniq_id | integer | Идентификатор платежного ордера,​ состоящий из девяти цифр, первая из которых 3 |
-| signature | string | Цифровая подпись,​ sha1 от строки login;​uniq_id;​api_in_key ​|+| signature | string | Цифровая подпись,​ sha1 от строки login;​uniq_id;​secret_key ​|
  
 Пример ответа:​ Пример ответа:​
description_of_the_api.1429529906.txt.gz · Последние изменения: 2015/04/20 11:38 — admin