SPapi 1.1.2

API for jakksoft.com

SPapi v1.1.2

Модуль создан Spagetik для серверов СП, СПм, СПк.

1. Начало работы

1.1 Установка и импортирование модуля

Для начала работы с модулем нужно установить сам модуль командой:

Для Windows

> pip install SPapi

Для Linux

$ sudo apt pip3 install SPapi

После установки модуля следует импортировать все классы из модуля:

from SPapi import *

Сразу после импортирования следует создать переменные server, token, response_key:

from SPapi import *

token = 'Your_Token'
server = 'Your_Server'
response_key = 'Your_Response_Key'

api = SpApi(server, token, response_key)

Param	Type	Description
server	Str	Сервер с которым будет работать API. ('sp', 'spm', 'spk')
token	Str	Секретный TOKEN вашего приложения. Получить здесь.
response_key	Str	Ключ ответа. Используется для проверки подлинности источника серверного ответа. Получить здесь.

1.2 Пример отправки тестового запроса

Код:

from SPapi import *

token = 'Your_Token'
server = 'Your_Server'
response_key = 'Your_Response_Key'

api = SpApi(server, token, response_key)

response = api.test()

print(response)

Пример вывода:

<success=True>
<response_key=kaSfzshJQXWOU8OOTcZy2IPq>
<data=['Hello world!']>

2. Классы модуля

SpApi

Основной класс модуля для оправки запросов на сайт.

Response

Класс получаемых ответов с сервера. Нужен для удобства получения данных с сервера.

Card

Класс для удобного доступа к данным карт, запрошенным методом get_cards_info().

Notify

Класс для удобного доступа к данным карт, запрошенным методом get_unread_notifications().

3. Методы классов

3.1 Класс SpApi

3.1.1 test() ⇒ Response

Тестовый метод для проверки работоспособности кода и соединения с сайтом. Не требует дополнительных аргументов.

3.1.2 permission_test() ⇒ Response

Тестовый метод для проверки выданных вами разрешений приложению. Требует дополнительные аргументы: your_license_key

Param	Type	Description
your_license_key	str	ВАШ ключ-лицензия. Найти можно тут.

3.1.3 pay() ⇒ Response

Метод для оплаты через SP-pay. Требует дополнительные аргументы: sp_pay_code, summa, trans_mes

Param	Type	Description
sp_pay_code	int	Код, полученный игроком на сайте.
summa	int	Сумма оплаты. ВАЖНО! Должна соответствовать сумме указанной, при получении кода
trans_mes	str	Сообщение, сопровождающее транзакцию оплаты. (Опционально)

3.1.4 get_permission() ⇒ Response

Метод для запроса разрешений у пользователя. Требует дополнительные аргументы: license_key, permission_id

Param	Type	Description
license_key	str	Ключ-лицензия игрока, у которого запрашиваются разрешения.
permission_id	int	id требуемого разрешения. Посмотреть все разрешения можно тут.

3.1.5 get_cards_info() ⇒ Response

Метод для запроса информации о картах игрока. Требует дополнительные аргументы: license_key

Param	Type	Description
license_key	str	Ключ-лицензия игрока, у которого запрашиваются данные.

3.1.6 get_cards_info() ⇒ Response

Метод для запроса непрочитанных уведомлений игрока. Требует дополнительные аргументы: license_key

Param	Type	Description
license_key	str	Ключ-лицензия игрока, у которого запрашиваются данные.

3.1.7 get_cards_info() ⇒ Response

Метод для пометки непрочитанных уведомлений игрока как прочитанные. Требует дополнительные аргументы: license_key

Param	Type	Description
license_key	str	Ключ-лицензия игрока, у которого запрашиваются данные.

4. Атрибуты классов

4.1 Класс SpApi

Param	Type	Description
.server	str	Сервер с которым работает класс.
.token	str	Токен приложения.
.response_key	str	Ключ ответ приложения.

4.2 Класс Response

Param	Type	Description
.success	boolean	Удачен ли запрос. True or False.
.response_key	str	Ключ ответ приложения.
.data	list list of class <Card> list of class <Notify>	Список данных. Либо список карт пользователя (class <Card>) при использовании get_card_info() Либо список уведомлений пользователя (class <Notify>) при использовании get_unread_notifications()
.errors	list	Список ошибок, если есть.

4.3 Класс Card

Param	Type	Description
.id	int	ID Счета игрока.
.name	str	Название счета игрока.
.balance	int	Баланс счета игрока.
.bg_color	str	Цвет фона карты в формате #xxxxxx.
.font_color	str	Цвет текста карты в формате #xxxxxx.
.image	str	Ссылка на изображение фона карты.

4.4 Класс Notify

Param	Type	Description
.id	int	ID уведомления.
.type	int	Тип уведомления.
.type_title	str	Название типа уведомления.
.message	str	Текст уведомления.
.time	int	Unix-время когда пришло уведомление в секундах.

Made with love by Spagetik from SPk ♥