|
|
|
|
|
|
|
|
|
|
|
Perso API
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
СПРАВОЧНОЕ РУКОВОДСТВО ПО API
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Оглавление
1. Введение 3
1.1. Термины и сокращения 3
1.2. Область действия 3
1.3. Адрес Web - сервиса. 3
2. Формат сообщения Web-сервиса 4
3. Передача информации 5
3.1. МОДУЛЬ APP 5
Метод "/api/App/CreateApp ". 5
Метод "/api/App/AppGetStatus ". 7
1. Введение
Данный документ описывает API Web-сервиса WCARD, разработанного компанией ООО «GENESIS INNOVATION». Взаимодействие ведется по протоколу HTTP
1 и представляет
собой набор методов, с помощью которых совершаются запросы и возвращаются ответы для каждой операции. Все ответы приходят в виде JSON структур.
Для защиты конфиденциальной информации используется расширение протокола HTTP, а именно - HTTPS
2, предоставляющее криптографическую защиту при передаче информации между пользователем и сервером. Проверка подлинности предъявленного пользователем идентификатора (логин и пароль) происходит по схеме базовой аутентификации
3.
1.1. Термины и сокращения
|
|
API
|
Application Program Interface
|
CVC
|
Card Verification Code
|
CVR
|
Card Verification Results
|
CVV
|
Card Verification Value
|
PIN
|
Personal Identification Number
|
SV
|
Smart Vista
|
АМСТ
|
Автомототранспортное средство
|
БД
|
База данных
|
БПК Банковская Пластиковая Карта
1.2. Область действия
В документе описываются следующие возможности Web-сервиса Perso:
регистрацию заявки;
получение ПАН
1.3. Адрес Web - сервиса.
Адрес Web-сервиса Perso для проведения разработки и тестирования предоставляется по специальному запросу. Разработчики предпринимают все необходимые действия, чтобы документация полностью соответствовала программной реализации, была понятна и удобна в использовании.
Замечания и предложения к документации, просьба, направлять по электронной почте на адрес info@igenius.uz
2. Формат сообщения Web-сервиса
Веб-сервис Perso использует JSON для передачи заросов. Согласно спецификации, JSON работает, отсылая запросы к серверу, реализующему протокол. Клиентом обычно является программа, которой нужно вызвать метод на удалённой системе.
Все передаваемые данные – простые записи, сериализованные в JSON. Запрос – вызов определённого метода, предоставляемого удалённой системой. Он должен содержать следующие обязательные свойства:
Content-Type – Строка содержащее значение: “application/json; charset=utf-8”;
Accept – Строка содержащее значение: “application/json”;
Authorization – Строка содержащая данные авторизации в кодировке Base64.
Сервер должен отослать правильный ответ на каждый полученный запрос. Ответ должен содержать следующие свойства:
result – Данные, которые вернул метод. Если произошла ошибка во время выполнения метода, это свойство должно быть установлено в null.
error - Код и текст ошибки, если произошла ошибка во время выполнения метода, иначе null.
Примеры
3. Передача информации
3.1. МОДУЛЬ APP
Модуль содержит следующие методы:
|
/api/App/CreateApp
|
Метод для создания заявки на карту.
|
|
/api/App/AppGetStatus
|
Метод для получение статуса заявки
|
Метод "/api/App/CreateApp ".
Тип запроса:
|
POST
|
Назначение:
|
Метод для для создания заявки на карту.
|
Параметры запроса:
Параметр
|
Тип
|
Описание
|
type
|
String
|
Номер телефона держателя карты
|
agent
|
String
|
МФО
|
appId
|
String
|
Ид заявки
|
userId
|
String
|
ИД пользователя в АБС
|
cardHolder
|
cardHolder
|
Картодержатель
|
firstName
|
String
|
Имя
|
secondName
|
String
|
Фамилия
|
passportSn
|
String
|
Серия паспорт
|
passportExp
|
String
|
Срок паспорта
|
pinfl
|
String
|
ПИНФЛ
|
inn
|
String
|
ИНН
|
dateOfBirth
|
Date
|
Дата рожедня
|
address
|
String
|
Адрес
|
card
|
card
|
Карта
|
contractId
|
Int
|
Номер контракта
|
printPIN
|
Boolean
|
С выдачей ПИН конверта/Без ПИН конверта
|
account
|
account
|
Счет
|
acctNum
|
String
|
Номер счета
|
Additional
|
Additional
|
Дополнительно
|
sms
|
sms
|
Настройки СМС
|
service
|
String
|
Параметры сервиса (ON/OFF)
|
phone
|
String
|
Номер телефона
|
Параметры ответа:
Параметр
|
Тип
|
Описание
|
appId
|
String
|
Ид заявки
|
status
|
Int
|
Статус заявки (0-новый в процессе,1-успешный,2-уже зарегистрирован)
|
description
|
String
|
Описание статуса
|
Пример запроса:
[
{
"type": "btrt01",
"agent": "88888",
"appId": "11232",
"userId": "1111",
"cardHolder": {
"firstName": "firstName",
"secondName": "secondName",
"passportSn": "passportSn",
"passportExp": "passportExp",
"pinfl": "pinfl",
"inn": "inn",
"dateOfBirth": "01.01.1999",
"address": "address"
},
"card": {
"contractId": 555,
"printPIN": true
},
"account": {
"acctNum": "12312156456"
},
"additional": {
"sms": {
"service": "ON",
"phone": "998946465955"
}
}
}
]
|
Пример успешного ответа:
[
{
"appid": "11232",
"status" : 0,
"description ": "App Job success added"
}
]
|
Пример не успешного ответа:
[
{
"appid": "11232",
"status" : 2,
"description ": "App Job existed"
}
]
|
Метод "/api/App/AppGetStatus ".
Тип запроса:
|
POST
|
Назначение:
|
Метод для получение статуса карты
|
Параметры запроса:
Параметр
|
Тип
|
Описание
|
appId
|
String
|
Номер заявки
|
mfo
|
String
|
МФО
|
Параметры ответа:
Параметр
|
Тип
|
Описание
|
appId
|
String
|
Номер заявки
|
mfo
|
String
|
МФО
|
cardNumber
|
String
|
Номер карты
|
expDate
|
String
|
Срок карты
|
Пример запроса:
/api/App/AppGetStatus?appId=12312132132&mfo=88888"
|
Пример ответа:
{
"appId": "12312132132",
"mfo": "88888",
"cardNumber": "6262123456789011",
"expDate": "2512"
}
|
