README

Подробнее

Laravel Библиотека, для работы с API SPWorlds

Установка

С помощью Composer

composer require anvilm/spworlds

Публикация файла конфигурации

php artisan vendor:publish --provider='AnvilM\SPWorlds\Providers\SPWorldsServiceProvider'

Использование

Инициализация объекта класса

use Anvilm\SPWorlds\API;

$SPWorlds = new API($id, $token);

Информация о карте

Метод возвращает JSON строку с балансом карты и вебхуком

$SPWorlds->APIService->cardInfo()

Получение ника пользователя

Метод возвращает JSON строку с ником и UUID

$discordId = 'discord_id'; //Discord id игрока

$SPWorlds->APIService->getUsername($discordId);

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

Метод возвращает JSON строку с массивом карт игрока: имя карты и номер

$username = 'user_name'; //Ник игрока

$SPWorlds->APIService->getCards($username);

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

Метод возвращает JSON строку с данными игрока: Аккаунт: id, username, minecraftUUID, status, roles, city, cards, createdAt. Город: id, name, description, x, z, isMayor Карта: id, name, number, color

$SPWorlds->APIService->getOwner();

Оплата на вашем сайте

Метод возвращает JSON строку с сылкой на страницу оплаты. После успешной оплаты сервер отправит POST запрос на webhookUrl

//Массив предметов на покупку
$items = [
    [
        'name' => 'item_name', //Имя предмета
        'count' => '10', //Количество предметов
        'price' => '1', //Цена за штуку
        'comment' => 'some comment' //Комментарий
    ]
];

$redirectUrl = 'https://redirect.url'; //Ссылка для переадрессации пользователя
$webhookUrl = 'https://webhook.url'; //Вебхук

$data = 'some data'; //Любая информация

$SPWorlds->APIService->payment($items, $redirectUrl, $webhookUrl, $data);

Банковские переводы

Метод возвращает JSON строку с новым балансом карты

$receiver = 'receiver card'; //Номер карты получателя
$ammount = '10'; //Сумма
$comment = 'some comment'; //Комментарий к переводу

$SPWorlds->APIService->transaction($receiver, $ammount, $comment);

Изменение вебхука карты

Метод возвращает JSON строку с id карты и новым вебхуком

$webhook = 'https://webhook.url'; //Вебхук

$SPWorlds->APIService->setWebhook($webhook);

Валидация оплаты

Метод возвращает true или false

$body = $request->getContent(); //JSON тело запроса
$hashHeader = $request->header('X-Body-Hash'); //Хеш тела запроса

$SPWorlds->APIService->validateHash($body, $hashHeader);

Токен авторизации

Метод возвращает Bearer токен

$SPWorlds->APIService->getAuthorization();

anvilm / spworlds

Maintainers

Details