API. Подключение
МФО — https://api.vepay.online/mfo
Краудфандинг — https://api.vepay.online/kfapi
Мерчант/виджет — https://api.vepay.online/merchant
Передача информации по бенефициарам (для краундфайндинга) — http://test.vepay.online:806/kfapi#/Benific/post_benific_reg
Адрес сервера для запросов — https://api.vepay.online/, тестовый — https://test.vepay.online
Данные передаются в теле POST запроса с JSON формате, кодировка UTF-8.
Идентификатор и ключ МФО/Мерчанта выдается после регистрации в системе.
В заголовке запроса передаются параметра авторизации:
X-Mfo (для API МФО) X-Login (API Краутфандинг, Мерчант)
|
int
|
Идентификатор МФО/Мерчанта
|
X-Token
|
string
|
Токен авторизации
|
Токен формируется по алгоритму:
sha1(sha1(ключ)+ sha1(тело запроса)), где sha1 возвращает 40-символьную строку с шестнадцатеричным числом хэша.
При успешной обработке запроса возвращается код ответа HTTP 200. При ошибке авторизации код HTTP 401 Unauthorized. При других ошибках возвращается ошибка 500 Internal Server Error или соответствующая.
Также в теле запроса возвращаются поля в формате JSON:
Имя параметра
|
Описание
|
Пример
|
name
|
HTTP описание ошибки
|
Unauthorized
|
message
|
Дополнительное сообщение об ошибке
|
|
code
|
Ошибка
|
0
|
status
|
HTTP код ошибки
|
401
|
Пример кода, подключения к API
<?php
$data = json_encode(["id" => 123]);
$login="123";
$key="12345456780";
$token=sha1(sha1($key).sha1($data));
$link = "https://api.vepay.online/mfo/out/state";
$curl=curl_init();
curl_setopt($curl,CURLOPT_RETURNTRANSFER,true);
curl_setopt($curl,CURLOPT_POSTFIELDS,$data);
curl_setopt($curl,CURLOPT_CUSTOMREQUEST,'POST');
curl_setopt($curl,CURLOPT_URL,$link);
curl_setopt($curl,CURLOPT_HEADER,false);
curl_setopt($curl,CURLOPT_HTTPHEADER, [
'Content-type: application/json',
'Accept: application/json',
'X-Mfo: '.$login,
'X-Token: '.$token
]);
curl_setopt($curl,CURLOPT_SSL_VERIFYPEER,0);
curl_setopt($curl,CURLOPT_SSL_VERIFYHOST,0);
$out=curl_exec($curl);
curl_close($curl);
$Response=json_decode($out,true);
print_r($Response);
Пример оплаты услуг через API мерчанта
1. Оплата - через API отправляется запрос оплаты/merchant/pay
{
"amount": 100,
"extid": "4",
"descript": "Заказ 4"
}
Ответ:
{
"status": 1,
"id": 11022,
"url": "https://test.vepay.online/pay/form/11022",
"message": ""
}
2. Пользователь перенаправляется на страницу оплаты (по url из ответа)
3. Если не используется получение статуса через обратный запрос, то необходимо проверить его статус:/merchant/state
{
"id": 11022
}
Ответ:
{
"status": 1,
"message": "Успешно"
}