/races-api

SDK для Races API во ВКонтакте

Primary LanguageTypeScriptMIT LicenseMIT

Установка

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()

Если нашли ошибку напишите мне