/yoomoney-sdk

:bank: YooMoney (formerly Yandex.Money) (yoomoney.ru) API SDK for node JS. Fully Typed

Primary LanguageTypeScriptMIT LicenseMIT

YooMoney SDK

Типизированный SDK для API YooMoney для NodeJS

YooMoney SDK

Test Status Downloads last commit codecov GitHub yoomoney-sdk Known Vulnerabilities Quality npm license MIT Size Codacy Badge

🍬 Почему именно эта библиотека?

  1. Полная. Покрывает следующие API:
  2. Простая. на каждое API всего 1 класс
  3. Надёжная. Библиотека написана на TypeScript и покрыта тестами.
  4. Безопасная. У библиотеки всего 2 зависимости, и она постоянно сканируется Code QL и Snyk на наличие уязвимостей.

📦 Установка

  • Используя npm
    npm i yoomoney-sdk
  • Используя Yarn
    yarn add yoomoney-sdk
  • Используя pnpm
    pnpm add yoomoney-sdk

🛠️ Использование

  1. ⚙️ Список методов
  2. 🦄 Примеры
  3. 🧑‍⚖️ Лицензия - MIT

Обработка ошибок

Если вызов метода API возвращает ошибку (то-есть есть поле error в ответе), то библиотека кидает ошибку YMApiError, которая содержит поля:

  • code - Значение поля error в ответе
  • response - Ответ полностью

Получение личного токена

# Клонируем репозиторий
git clone https://github.com/AlexXanderGrib/yoomoney-sdk.git

# Заходим в папку
cd yoomoney-sdk

# Устанавливаем зависимости
npm install

# Собираем библиотеку
npm run build

# Запускаем скрипт
node examples/4-get-token.js

Использование

# .env
YOOMONEY_TOKEN=4100117723869225.C277E77...
// index.js
const { API } = require("yoomoney-sdk");
const { config } = require("dotenv");

// Подгружаем файл .env
config();

const api = new API(process.env.YOOMONEY_TOKEN);

api.accountInfo().then((info) => console.log(info));

Лицензия

Проект распространяется под лицензией MIT. Смотрите LICENSE.txt

FOSSA Status

❤️ Содействие (Contributing)

Что делаем?:

  1. ⁉️ Не стесняемся писать Issue
  2. 🛠️ Если хотите что-то поправить следуйте гайду CONTRIBUTING.md
  3. 💸 Донатим 👉 https://sobe.ru/na/yoomoney_sdk
  4. 🌟 Ставим звёздочки, если библиотека понравилась.

🙋 Поддержка

Библиотека - маленькая, я отвечаю быстро. Не стесняйтесь писать Issue, даже если кажется что они глупые. Если что, можете писать в

Telegram: @AlexXanderGrib

Интересует приём и отправка P2P платежей по РФ на NodeJS?

У нас есть точно такое-же типизированное SDK для QIWI 👉 github.com/AlexXanderGrib/node-qiwi-sdk