Onpay.ru Wiki

Это старая версия документа.

---

h1. API 2.0

toc

API построено на REST архитектуре. JSON возвращается в ответ на все запросы к API, в том числе и при возникновении ошибок. Имеет предсказуемые, ресурсо-ориентированные URL-адреса, использует HTTP-коды для передачи состояния ошибок, а также использует встроенные функции HTTP-аутентификации и методы GET, POST, PUT, DELETE.

h1. Запросы от OnPay к сайту мерчанта

h2. Check

Для check запроса используются параметры:

Пример запроса: <pre>

{
	"type":"check",
	"pay_for":"55446",
	"expired_at":"2014-02-03T18:43:21+04:00"
	"amount":50000,
	"way":"RUR",
	"mode":"fix",
	"signature":"82f67760dbc5331963b7e00bc6df77f1"
}

</pre>

h3. Ответ мерчанта

Пример: <pre>

{
	"code":0,
	"type":"check",
	"pay_for":"55446",
	"signature":"172de16ada92791b3753b3121d471f5c"
}

</pre>

h2. Pay

Для pay запроса используются параметры:

Пример запроса: <pre>

{
	"type":"pay",
	"pay_for":"55446",
	"signature":"82f67760dbc5331963b7e00bc6df77f1",
	"user":{
		"email":"mail@mail.ru",
		"phone":"9631478946",
		"note":""
	},
	"payment":{
		"id":7121064,
		"date_time":"2013-12-05T12:07:09+04:00",
		"amount":10200,
		"way":"USD",
		"rate":33121445,
		"release_at":null
	},
	"balance":{
		"amount":"3300",
		"way":"RUR"
	}
}
</pre>

h3. Ответ мерчанта

Пример: <pre>

{
	"code":0,
	"type":"pay",
	"pay_for":"55446",
	"signature":"172de16ada92791b3753b3121d471f5c"
}

</pre>

h1. Запросы от мерчанта к OnPay

h2. Получить данные платежа

адрес - json_interfaces/payments/:id, где id - номер платежа в системе OnPay

Используется для получения данных о прошедшем платеже. Используемые параметры:

Пример запроса: <pre>

{
	"login":"onpay",
	"signature":"1d15f90df20da53d7206e9f7db7d2c9d"
}

</pre>

В ответ будет выдан JSON с данными:

Пример ответа: <pre>

{
	"signature":"172de16ada92791b3753b3121d471f5c",
	"user":{
		"email":"mail@mail.ru",
		"phone":"9631478946",
		"note":""
	},
	"payment":{
		"id":"7121064",
		"date_time":"2013-12-05T12:07:09+04:00",
		"amount":10200,
		"way":"USD",
		"rate":33121445,
		"release_at":null
	},
	"balance":{
		"amount":"3300",
		"way":"RUR"
	}
}
</pre>

h2. Получить курс обмена

адрес - json_interfaces/rates/:from/to/:to, где from и to - валюта из и валюта назначения соответственно

Используется для получения текущего курса валют

Пример запроса: <pre>

{
	"login":"onpay",
	"signature":"65ded5353c5ee48d0b7d48c591b8f430"
}

</pre>

В ответ будет выдан JSON с данными:

Пример ответа: <pre>

{
	"from":"USD",
	"to":"RUR",
	"rate":33121445
	"signature":"4671aeaf49c792689533b00664a5c3ef"
}

</pre>

h2. Купоны

Общий адрес интерфейса - json_interfaces/coupons/

h3. Создание Купона

метод - POST адрес - json_interfaces/coupons/

Пример запроса для процентной скидки: <pre>

{
	"login":"onpay",
	"type":"percent",
	"percent_off":10,
	"max_amount":100000,
	"value":0,
	"min_amount":0,
	"max_redemptions":1,
	"expired_at":"2013-12-05T12:07:09+04:00",
	"signature":"1d15f90df20da53d7206e9f7db7d2c9d"
}

</pre>

Пример запроса для постоянной скидки: <pre>

{
	"login":"onpay",
	"type":"const",
	"percent_off":0,
	"max_amount":0,
	"value":10000,
	"min_amount":100000,
	"max_redemptions":1,
	"expired_at":"2013-12-05T12:07:09+04:00",
	"signature":"d41d8cd98f00b204e9800998ecf8427e"
}

</pre>

В ответ будет выдан JSON с данными:

Пример ответа для процентной скидки: <pre>

{
	"code":"3whhZ4U0J9B0tATiOb",
	"type":"const",
	"percent_off":10,
	"max_amount":100000,
	"value":0,
	"min_amount":0,
	"max_redemptions":1,
	"expired_at":"2013-12-05T12:07:09+04:00",
	"redemptions_count":0,
	"state":"new",
	"signature":"172de16ada92791b3753b3121d471f5c"
}

</pre> Пример ответа для постоянной скидки: <pre>

{
	"code":"3whhZ4U0J9B0tATiOb",
	"type":"const",
	"percent_off":0,
	"max_amount":0,
	"value":10000,
	"min_amount":100000,
	"max_redemptions":1,
	"expired_at":"2013-12-05T12:07:09+04:00",
	"redemptions_count":0,
	"state":"new",
	"signature":"172de16ada92791b3753b3121d471f5c"
}

</pre>

h3. Получение купона

метод - GET адрес - json_interfaces/coupons/:code, где code - уникальный код купона

Используется для просмотра текущего состояния купона.

Пример запроса: <pre>

{
	"login":"onpay",
	"signature":"1d15f90df20da53d7206e9f7db7d2c9d"
}

</pre>

Ответ будет аналогичен как и у запроса для создания купона.

h3. Удаление купона

метод - DELETE адрес - json_interfaces/coupons/:code, где code - уникальный код купона

Используется для отключения купона до истечения его срока годности или исчерпания количества использований.

Пример запроса: <pre>

{
	"login":"onpay",
	"signature":"1d15f90df20da53d7206e9f7db7d2c9d"
}

</pre>

Ответ будет аналогичен как и у запроса для создания купона.

h1. Ошибки

В любом ответе могут присутствовать данные об ошибке, они записываются в конец сообщения в следующем формате:

JSON вида: <pre>

{
	"error":{
		"params":[
			{
				"code":"required",
				"message":"Description cannot be blank.",
				"name":"description"
			}
		],
		"type":"invalid_param_error",
		"message":"Invalid data parameters"
	}
}

</pre>

h1. Примечания

1) Для хеширования строки подписи используется алгоритм SHA1

2) Методы запросов: