qiwi-sdk

NodeJS QIWI SDK

Язык: (🇷🇺 Русский / 🇬🇧 English)

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

1. Она написана на TypeScript, покрыта тестами
2. Покрывает Wallet Personal и P2P Payments секции API
3. Документация появляется прямо в редакторе, так-как используется JSDoc
4. Безопасная (Относительно)
5. Много примеров
6. Поддерживаются даже редко-используемые возможности, например:
   1. Персональные Вебхуки
   2. Блокировка метода оплаты P2P
   3. API работы с картами Qiwi Master.

📦 Установка

Используя NPM

npm i qiwi-sdk

Используя Yarn

yarn add qiwi-sdk

Используя pnpm

pnpm add qiwi-sdk

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

Совместимость

После обновления до версии 3.0 большая часть старого кода осталось совместимой. Подробнее об изменениях читайте в CHANGELOG.md

Если кратко, чтобы код остался совместимым, замените использование класса Detector на DetectorCompat.

Все остальные классы должны остаться совместимыми

Импорт

// TypeScript или ESM
import { P2p, Wallet, Detector } from "qiwi-sdk";

// CommonJS
const { P2p, Wallet, Detector } = require("qiwi-sdk");

Обзор API

// Personal - API, отвечающее за работу с конкретным кошельком
// Документация от QIWI:
// https://developer.qiwi.com/ru/qiwi-wallet-personal
const qiwi = Wallet.create(process.env.QIWI_TOKEN, process.env.QIWI_WALLET);

// P2P - удобное API для выставления счетов
// Документация от QIWI:
// https://developer.qiwi.com/ru/p2p-payments
const p2p = P2p.create(process.env.QIWI_SECRET_KEY, process.env.QIWI_PUBLIC_KEY);

// Detector - API для определения Provider ID по номеру телефона или карты
// Содержит всего 1 метод
const detector = Detector.create();

Переменные окружения:

• QIWI_TOKEN - токен киви, полученный на https://qiwi.com/api
• QIWI_WALLET - номер телефона кошелька, к которому привязан токен. Формат: 79123456789
• QIWI_SECRET_KEY и QIWI_PUBLIC_KEY - пара ключей, созданные на https://qiwi.com/p2p-admin/transfers/api

🤝 Интеграция

Примеры:

1. 🥝 Получение информации о кошельке
2. 📬 Отправка платежа куда угодно
3. 🛠️ Создание ключей P2P и создание счёта
4. 🔐 Получение лимитов (на ESM)
5. 🤖 Телеграм бот с оплатой напрямую (по номеру кошелька)
6. 🖥️ Магазин на Express
7. 🌐 Использование прокси

Документация:

1. 👴 Миграция с 1.x
2. ⚙️ Список методов
3. 🧑‍⚖️ Лицензия - MIT
4. 🆙 Список изменений

О пакете

Цели пакета

• Покрыть все API QIWI (в том числе для юридических лиц)
  • API QIWI Кошелька - (все API)
  • Прием платежей
  • Денежные выплаты
  • Bank as a Service
  • Идентификация клиентов
• Сохранять обратную совместимость
  • v2 и v3
  • v1 и v2
• Обеспечить максимальную надёжность и качество кода
  • Типы: TypeScript
  • Тесты: Jest, Codecov
  • Авто-тесты в репозитории: Github Actions
  • Линтинг: Eslint, Prettier, Editorconfig
  • Безопасность: Eslint Плагин, Code QL, ручная проверка в Snyk

❤️ Контрибьютинг

1. ⁉️ Не стесняйтесь писать Issues
2. 🛠️ Если хотите что-то поправить в коде, следуйте CONTRIBUTING.md
3. 💸 Так-же можете отправить донат 👉 https://qiwi.com/n/ALEXXGRIB
4. 🌟 Или поставить библиотеке звёздочку, если она вам понравилась

🙋 Поддержка

Вы можете написать Issue, а если я долго не отвечаю пишите в

Telegram: @AlexXanderGrib

Пакет для YooMoney

Интересует приём платежей от физ. лиц по РФ?

Попробуйте мою другую библиотеку - SDK для ЮMoney 👉 github.com/AlexXanderGrib/yoomoney-sdk