Download the PHP package nazbav/vk-coin-api without Composer
On this page you can find all versions of the php package nazbav/vk-coin-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download nazbav/vk-coin-api
More information about nazbav/vk-coin-api
Files in nazbav/vk-coin-api
Informations about the package vk-coin-api
VK Coin API
Задать вопрос можно в беседе. Библиотека для работы с VK Coin API. Основана на "документации".
Подключение
-
Через Composer:
- С обработкой исключений:
Параметр | Тип | Описание |
---|---|---|
$merchantId | int | ID странички, для которой был получен платёжный ключ |
$key | string | Платёжный ключ |
$checkResponse | string | Отлов ошибок, по умолчанию true (см. Получение ошибок ниже). |
Функции
CallBack | Транзакции
Установка callBack.
Удаление callBack.
Параметр | Тип | Описание |
---|---|---|
url | string | Адрес для отправки уведомлений |
Валидация запроса:
Параметр | Тип | Описание |
---|---|---|
id | int | номер транзакции |
from_id | int | от кого |
amount | int | Количество |
payload | int | Число от -2000000000 до 2000000000. |
key | string | Ключ |
Получение списка неудавшихся запросов
Параметр | Тип | Описание |
---|---|---|
status | int | Получение логов |
Настройка магазина
Установка названия магазина
Параметр | Тип | Описание |
---|---|---|
name | string | Название магазина |
Получение списка транзакций
Пример:
Параметр | Тип |
---|---|
type | int |
last | int |
Перевод
Пример:
Параметр | Тип | Описание |
---|---|---|
to | int | ID пользователя, которому будет отправлен перевод |
amount | int | Сумма перевода в тысячных долях (500 = 0,500 коин) |
fromFloat | bool | amount задан в float (см. функции библиотеки ниже)? |
fromPercent | bool | amount задан в процентах? |
Получение баланса
Пример:
Параметр | Тип |
---|---|
userIds | array |
Получение ссылки на оплату
Пример:
Параметр | Тип | Описание |
---|---|---|
sum | int | Сумма перевода |
payload | int | Любое число от -2000000000 до 2000000000. Поставь 0, дальше сделаем все сами ;) |
fixed_sum | bool | Фиксация суммы перевода |
hex | bool | Генерация hex-ссылки |
Псевдонимы (Aliases)
Их вы можете указывать в параметре метода, для упращения работы.
Имя | Псевдоним | Описание |
---|---|---|
set | config | Параметры магазина |
set | settings | Параметры магазина |
tx | getTransactions | Список транзакций |
tx | transactions | Список транзакций |
link | getPayLink | Платежная ссылкка |
link | getLink | Платежная ссылкка |
send | transfer | Отправка перевода |
send | sendTransfer | Отправка перевода |
send | pay | Отправка перевода |
alias | getAliases | Список псевдонимов |
alias | aliases | Список псевдонимов |
score | getBalance | Баланс игрока |
score | balance | Баланс игрока |
Формат ответа
Имя поля | Тип | Описание |
---|---|---|
status | bool | true , если запрос выполнен без критических ошибок. |
response | array | Массив с данными (за место него может быт выдан error ) |
error | array | Для получения этого массива см. Получение ошибок |
Данному формату не подчиняются методы начинающиеся с .
Получение ошибок
По стандарту библиотека сама обрабатывает ошибки и выдает VkCoinException на этот счет. Для того чтобы самостоятельно обрабатывать ошибки необходимо передать всего один параметр при инициализации:
Error code 100
В случай если библиотеке не удалось получить данные c сервера, и т.д. (ошибки curl). Будет выдана 100 ошибка:
Функции библиотеки
Получение Key
Получение MerchantId
Перевод числа с плавающей точкой в коины
Пример: отправка 1 коина (1.000) пользователю:
Перевод коинов в число с плавающей точкой
Пример: запрос баланса мерча, разбор ответа, конвертация в float:
Получение процента (A) от числа (B)
Пример: 75% от 10.000 VKC = 7.500 VKC:
Процент числа A от числа B
Пример: на сколько процетов баланс пользователя id1 больше баланса пользователя id2:
Сколько процентов составляет баланс пользователя id2 от баланса пользователя id1:
Даные в примерах:
All versions of vk-coin-api with dependencies
ext-curl Version *
ext-json Version *