spk_api
v1.0.5
Published
spk_api - API for https://spk.jakksoft.com
Downloads
2
Readme
spk_api
Установка:
$ npm install spk_apiПример:
const SPK = require("spk_api");
const spk = new SPK("token", "response_key", "spk");
(async () => {
console.log(await spk.test());
})()API Reference
P.S: deprecated методы будут удалены после обновления API на сайте https://spk.jakksoft.com
Методы
- 1 - Тестовое разрешение.
- 2 - Чтение информации о банковских счетах.
- 3 - Чтение уведомлений.
- 4 - Пометка уведомлений прочитанными.
spkAPI
Kind: global class
new spkAPI(token, responseKey)
Модуль создан Qugalego (Andrmist) для серверов SP, SPM, SPK.
| Param | Type | Default | Description | | --- | --- | --- | --- | | token | String | | Секретный TOKEN вашего приложения. | | responseKey | String | | Ключ ответа. Используется для проверки подлинности источника серверного ответа. | | server | String | spk | Сервер на котором вы хотите использовать API. "sp", "spm" или "spk" |
~~spkAPI.get_permission()~~
Deprecated
Тоже самое, что и getPermission
Kind: instance method of spkAPI
~~spkAPI.permission_test()~~
Deprecated
Тоже самое, что и permissionTest
Kind: instance method of spkAPI
~~spkAPI.get_cards_info()~~
Deprecated
Тоже самое, что и getCardsInfo
Kind: instance method of spkAPI
~~spkAPI.get_unread_notifications()~~
Deprecated
Тоже самое, что и getUnreadNotifications
Kind: instance method of spkAPI
~~spkAPI.mark_notifications_as_read()~~
Deprecated
Тоже самое, что и markNotificationsAsRead
Kind: instance method of spkAPI
run ⇒ Object
Прямое обращение к SPK API
Kind: global variable
| Param | Type | Description | | --- | --- | --- | | data | Object | что передать на сервер |
test ⇒ Object
Запрос, не выполняющий никаких действий. Создан для настройки и проверки работоспособности API.
Kind: global variable
pay ⇒ Object
API, позволяющее производить банковские транзакции. Предназначено для оплаты услуг и товара на Ваших сайтах. Оплата производится в АР, получателем средств является банковский счёт, указанный в параметрах Вашего приложения в разделе SP Dev. Комиссии за переводы отсутствуют
Kind: global variable
| Param | Type | Description | | --- | --- | --- | | spPayCode | String | Временный код, полученный в кошельке на этом сайте. | | sum | String | Number | Сумма АР которая будет снята. | | transactionMessage | String | Описание транзакции. |
getPermission ⇒ Object
При первом запуске Вашего приложения, вы можете сразу рассказать пользователю, какие разрешения вам необходимы для работоспособности приложения и запросить их все с помощью данного запроса. Полный список всех разрешений:
- 1 - Тестовое разрешение.
- 2 - Чтение информации о банковских счетах.
- 3 - Чтение уведомлений.
- 4 - Пометка уведомлений прочитанными.
Kind: global variable
| Param | Type | Description | | --- | --- | --- | | license_key | String | Ключ лицензии пользователя, у которого запрашивается разрешение. | | permission_id | String | Number | ID запрашиваемого разрешения. |
permissionTest ⇒ Object
Запрос, не выполняющий никаких действий. Создан для проверки работы механизма выдачи прав доступа.
Kind: global variable
| Param | Type | Description | | --- | --- | --- | | license_key | String | Ключ лицензии пользователя, у которого запрашивается разрешение. |
getCardsInfo ⇒ Object
Получение данных о банковских счетах пользователя.
Kind: global variable
| Param | Type | Description | | --- | --- | --- | | license_key | String | Ключ лицензии пользователя, у которого запрашивается разрешение. |
getUnreadNotifications ⇒ Object
Получение списка непрочитанных уведомлений.
Kind: global variable
| Param | Type | Description | | --- | --- | --- | | license_key | String | Ключ лицензии пользователя, у которого запрашивается разрешение. |
markNotificationsAsRead ⇒ Object
Пометка всех непрочитанных уведомлений пользователя как "прочитано".
Kind: global variable
| Param | Type | Description | | --- | --- | --- | | license_key | String | Ключ лицензии пользователя, у которого запрашивается разрешение. |