nikitos42050/paper-scroll-sdk-php

PaperScroll SDK для PHP 7.0+ простая реализация методов API PaperScroll

PaperScroll SDK для PHP 7.0+

PaperScroll SDK для PHP 7.0+ простая реализация методов API PaperScroll

СЛЕДИТЕ ЗА ОБНОВЛЕНИЯМИ! ТЕКУЩАЯ ВЕРСИЯ: 1.0

Полезные ссылки:

Документация PaperScroll API

Установка

Пример:

require_once('paperscrollclient.php'); 
ИЛИ
include_once('paperscrollclient.php');


$paperscroll = new PaperScrollClient('merchant_id','token');
Готовый вариант:
$paperscroll = new PaperScrollClient('128','wU6GlVB0yCnbZb1UBEp1YY2LBaRurCwCpzZdblZ6slFpjIOCbH70AhGaEdi2KG');

Параметр	Тип	Обязательно?	Описание
merchant_id	int	да	merchant_id - идентификатор магазина
token	string	да	token - секретный ключ, полученный при создании

ВНИМАНИЕ! Для использования, у Вас также должно быть установлено расширение cURL.

Формат ответа

При вызове любого метода API возвращается массив с двумя полями - true или false.

Поле	Тип	Описание
status	bool	true - успешно. false - произошла ошибка.
response	array	Возвращает массив, содержащий ответ от API, только если status == true.
error	string	Возвращает строку с ошибкой cURL, только если status == false.

Получение информации о магазине, по его индификатору.

Пример:

$paperscroll->getMerchants('ТУТ ИД МАГАЗИНА')['response']['ТУТ ПАРАМЕТР, КОТОРЫЙ ВАМ НУЖЕН'];
Список параметров, которые можно получить: merchant_id || owner_id || group_id || name || avatar || balance || create_date
group_id, name, avatar - могу вернуть NULL, если сообщество не привязано.

Например:
$paperscroll->getMerchants('1')['response']['balance'];

Остальные методы также подробно описаны в самом коде.

Методы SDK

API Метод	Метод в коде
merchants.get	getMerchants
merchants.edit	editMerchant
users.get	getUsers
users.getBalances	getUsersBalances
transfers.create	createTransfer
transfers.get	getTransfers
transfers.getHistory	getHistoryTransfers
storage.getDisinfectants	getDisinfectantsStorage
storage.getItems	getItemsStorage
webhooks.get	getWebhook
webhooks.create	createWebhook
webhooks.delete	deleteWebhook
webhooks.getLogs	getLogsWebhook

Баги и PR

Репозиторий открыт для изменений! Если вы заметили какую-то ошибку связанную с кодом, откройте Issue и если знаете, как эту ошибку решить, открывайте Pull Request