1.1.1-fix-markdown • Published 3 years ago
races-api v1.1.1-fix-markdown
Установка
npm install races-apiИспользование
import { Races } from "races-api"
const race = new Races("token")Все ниже перечисленные функции возвращают Promise
merchant
merchant.get
Получить информацию о вашем проекте
race.merchant.get()merchat.edit
Отредактировать ваш проект
race.merchant.edit({
name: "swedesjs",
description: "Project description",
groupId: 1,
avatar: "https://imgur.com/letter.png"
})| Опция | Тип | Описание |
|---|---|---|
| name? | string | Название Вашего проекта |
| description? | string | Описание Вашего проекта |
| groupId? | number | ID сообщества VK, которое принадлежит проекту |
| avatar? | string | URL аватара проекта, принимаются URL только от источника imgur, и только png\jpg\jpeg форматы |
payment
payment.getHistory
Получить историю переводов
race.payment.getHistory({
count: 5,
type: "out",
offset: 5
})| Опция | Тип | Описание |
|---|---|---|
| count? | number | Количество записей, от 1 до 100, по дефолту 100 |
| type? | "in" | "out" | Входящие - in, исходящие - out, по дефолту - все сразу |
| offset? | number | Сместить поиск на указанное количество записей |
payment.getHistoryByIds
Получить информацию о платеже по его ID
race.payment.getHistoryByIds({
ids: [1, 3],
type: "in"
})| Опция | Тип | Описание |
|---|---|---|
| ids | number | number[] | Список ID платежей, информацию о которых нужно получить |
| type: | "in" | "out" | Входящие - in, исходящие - out, по дефолту - все сразу |
payment.send
Совершить перевод другому пользователю
race.payment.send({
field: "coin",
id: 1,
amount: 1000
})| Опция | Тип | Описание |
|---|---|---|
| field | "coin" | "diamonds" | Передаваемая валюта, coin - доллары, diamonds - алмазы |
| id | number | ID человека, которому нужно передать валюту |
| amount | number | Сумма перевода |
users
users.get
Получить информацию о пользователе
race.users.get({
userIds: 1
})| Опция | Тип | Описание |
|---|---|---|
| userIds? | number | number[] | ID пользователя или пользователей, информацию о которых Вы хотите получить |
webhooks
webhooks.create
Установить адрес вебхука, на который будут присылаться уведомления о новых платежах
race.webhooks.create({
url: "https://vk.com"
})| Опция | Тип | Описание |
|---|---|---|
| url | string | URL, на который будут присылаться уведомления. Должен иметь протокол http или https, может быть указан как домен, так и IP адрес. |
webhooks.get
Получить URL текущего вебхука
race.webhooks.get()startPollingPayment
Получать входящие платежи
race.startPollingPayment(ctx => {
console.log(ctx)
}, "https://ngrok.io")getLink
Получить ссылку на проект
race.getLink()Если нашли ошибку напишите мне