1.12.6 • Published 3 years ago

domosed v1.12.6

Weekly downloads
22
License
ISC
Repository
github
Last release
3 years ago

Domosed API

NodeJS библиотека для работы с API сервиса "Домосед"

Установка

yarn yarn add domosed

npm npm i -S domosed

Подключение

const {
    Domosed
} = require('domosed')
const ds = new Domosed(token)

Методы API

call - универсальный метод отправки запроса

ПараметрТипОбязателенОписание
methodNamestringДаИмя метода
paramsobjectНетПараметры запроса

Пример:

async function run() {
    const info = await ds.call('merchants.merchants.edit', {
        name: 'My test app'
    })
    console.log(info)
}
run().catch(console.error);

getProjectInfo - Получить информацию о Вашем проекте

Пример:

async function run() {
    const info = await ds.getProjectInfo()
    console.log(info)
}
run().catch(console.error);

editProjectInfo - Редактировать информацию о Вашем проекте

ПараметрТипОбязателенОписание
namestringНетНазвание проекта
avatarstringНетПрямая ссылка на новый аватар проекта
group_idnumberНетID группы проекта
  • Хотя-бы 1 параметр должен быть передан

Пример:

async function run() {
    const info = await ds.editProjectInfo(
        'My app',
        'vk.com/images/camera_200.png',
        1
    );
    console.log(info)
};

run().catch(console.error);

sendVerify - Отправить Ваш проект на модерацию В случае успешной модерации - Вы будете опубликованы в разделе "развлечения" официального приложения Домосед.

Пример:

async function run() {
    const info = await ds.sendVerify();
    console.log(info);
};

run().catch(console.error);

sendPayment - Совершить перевод монет указанному пользователю

ПараметрТипОбязателенОписание
toIdnumberдаID пользователя, которому Вы собираетесь совершить перевод
amountnumberдаКоличество монет, которое Вы собираетесь перевести указанному пользователю

Пример:

async function run() {
    const info = await ds.sendPayment(1, 1);
    console.log(info);
};

run().catch(console.error);

getHistoryPayments - Получить историю последних платежей

ПараметрТипОбязателенОписание
typestringнетТип возвращаемых переводов(all — все, out — исходящие, in — входящие)
limitnumberнетКоличество возвращаемых переводов, от 1 до 50

Пример:

async function run() {
    const info = await ds.getHistoryPayments('all', 50);
    console.log(info);
};

run().catch(console.error);

getBalance - Получить баланс пользователей

ПараметрТипОбязателенОписание
userIdsArray/NumberдаМассив ID пользователей, чьи балансы нужно вернуть

Пример:

async function run() {
    const info = await ds.getBalance([73845201, 1]);
    console.log(info);
};

run().catch(console.error);

getPaymentLink - Получить ссылку на перевод монет проекту

Пример:

async function run() {
    const info = await ds.getPaymentLink();
    console.log(info);
};

run().catch(console.error);

Прослушивание входящих переводов:

Наша библиотека автоматически сверяет hash входящих переводов, защищая Вас от злоумышленников.

Для начала Вам стоит вызвать функцию start

ПараметрТипОбязателенОписание
pathstring\numberдаВаш IP адрес или домен
portnumberнетПрослушиваемый порт

Затем Вам нужно подписаться на входящие переводы, используя функцию onPayment, в параметры который нужно передать callback функцию.

Пример:

function run() {
    ds.start('myAwesomeDomen.ru', 80);

    ds.onPayment(context => {
        const {
            amount,
            fromId
        } = context;
        console.log(context);
    });
};

run().catch(console.error);
1.12.6

3 years ago

1.12.5

3 years ago

1.12.4

3 years ago

1.12.3

3 years ago

1.12.2

3 years ago

1.12.1

3 years ago

1.11.1

3 years ago

1.11.0

3 years ago

1.10.1

4 years ago

1.10.0

4 years ago

1.0.9

4 years ago

1.0.8

4 years ago

1.0.7

4 years ago

1.0.6

4 years ago

1.0.5

4 years ago

1.0.4

4 years ago

1.0.2

4 years ago

1.0.3

4 years ago

1.0.1

4 years ago

1.0.0

4 years ago