Skip to content

flaxytop/SpWorldsApiForCS

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

53 Commits
 
 
 
 

Repository files navigation

Image alt

SpWorldsApiForCS 2.1.2

Это библиотека C# для управлением API SpWorlds. Документация к API тут.

Как начать?

Подключение библиотеки происходит через nuget

nuget

dotnet add package spw --version 2.1.2

Команды

Примечание

Можно использывать асиннхронные и синхронные методы

Деректива подключения

using spw;

Создание класса

SpWorlds sp = new SpWorlds("id", "token");

Правильный token и id

await sp.IsSpWalletAsync();
//or
sp.IsSpwallet();

Возвращает bool

Получить баланс

await sp.GetCardInfoAsync();
//or
sp.GetCardInfo();

Возвращает SPCardUser (Типы)

Получить никнейм по DiscordId

await sp.GetUserAsync("DiscordId");
//or
sp.GetUser("DiscordId");

Возвращает SPUser (Типы)

Отправить АРы

await sp.SendPaymentAsync(amount, "receiver", "message");
//or
sp.SendPayment(amount, "receiver", "message");

Возвращает int (баланс вашей карты после оплаты)

Создать ссылку на оплату

await sp.CreatePaymentAsync(payment); //class SPPayment
//or
sp.CreatePayment(payment); //class SPPayment

Возвращает string(url)

Проверка оплаты

await sp.ValidatorAsync("webhook", "Xbody_hash");
//or
sp.Validator("webhook", "Xbody_hash");

Возвращает bool

Получение аккаунта владельца токена

await sp.GetAccountAsync();
//or
sp.GetAccount();

Возвращает SPAccount (Типы)

Получение карт игрока

await sp.GetCardsAsync(username);
//or
sp.GetCards(username);

Возвращает SPCard[] (Типы)

Установка вебхука для карты

await sp.SetWebhookAsync(webhook);
//or
sp.SetWebhookAsync(webhook);

Возвращает bool

Types

SPAccount

Используется (в return): GetAccount() Содержимое:

int id 
string username 
string status
string minecraftUUID 
string[] roles 
SPCity city 
SPCard[] cards
string createdAt

SPCard

Используется (в return): GetCards(username) Содержимое:

string name 
string number 

SPCardUser

Используется: ** Содержимое:

int balance 
string webhook 

SPCity

Используется (в return): GetAccount() Содержимое:

string id 
string name 
int x 
int y 
bool isMayor
string description

SPItem

Используется (в return): CreatePayment() Содержимое:

string name 
int count 
int amount 
string comment // can be null

SPPayment

Используется: CreatePayment() Содержимое:

SPItem item 
string redirectUrl 
string webhookUrl
string data 

SPTransaction

Используется: После устоновления webhook {SetWebhookAsync(webhook)}, приходят транзакции (для парса) Содержимое:

string id 
string name 
string type 
SPWebhookUser sender
SPWebhookUser receiver
string comment 
string createdAt 

SPUser

Используется: GetCardInfo() Содержимое:

string username 
string uuid //Minecraft uuid

SPWebhookUser

Содержимое:

string username 
string number 

Exceptions

BabRequestException

Неправильная форма запроса

UnathorizedException

Неверный token или id

BadGatewayException

spworlds api отключен

About

Api SpWorlds for c#

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages