Документация
Подробные инструкции по установке и использованию наших веб-модулей и плагинов
Начало работы
MiApi предоставляет веб-модули и плагины для вашего проекта. Наши модули разработаны с учетом простоты использования и высокой производительности.
Для начала работы вам потребуется зарегистрироваться и получить API-ключ в личном кабинете.
Установка
Выберите способ установки
Мы поддерживаем несколько способов установки наших модулей в зависимости от вашего проекта
npm install @miapi/core @miapi/payments
Доступные модули
Платежи
Интеграция с популярными платежными системами
- Поддержка более 20 платежных систем
- Автоматическая конвертация валют
- Защита от мошенничества
- Рекуррентные платежи
Аутентификация
Безопасная система аутентификации пользователей
- OAuth 2.0 интеграция
- Двухфакторная аутентификация
- Управление ролями и правами
- Защита от брутфорс-атак
Уведомления
Система отправки уведомлений пользователям
- Email-уведомления
- Push-уведомления
- SMS-уведомления
- Шаблоны и персонализация
Аналитика
Сбор и анализ данных о пользователях
- Отслеживание поведения пользователей
- Сегментация аудитории
- A/B тестирование
- Экспорт данных
Примеры использования
Интеграция платежной системы
// Инициализация платежного модуля import { MiApi, PaymentModule } from '@miapi/core'; import { YooKassaProvider } from '@miapi/payments'; // Создание экземпляра API const miapi = new MiApi({ apiKey: 'YOUR_API_KEY', modules: [ new PaymentModule({ provider: new YooKassaProvider({ shopId: 'YOUR_SHOP_ID', secretKey: 'YOUR_SECRET_KEY' }) }) ] }); // Создание платежа async function createPayment() { const payment = await miapi.payments.create({ amount: 1000, currency: 'RUB', description: 'Оплата заказа #12345', returnUrl: 'https://your-site.ru/success', metadata: { orderId: '12345' } }); // Перенаправление на страницу оплаты window.location.href = payment.confirmationUrl; }
Часто задаваемые вопросы
Как получить API-ключ?
API-ключ можно получить после регистрации в личном кабинете. Перейдите в раздел "Настройки" и нажмите на кнопку "Создать API-ключ".
Какие платежные системы поддерживаются?
Мы поддерживаем все основные платежные системы: ЮKassa, Stripe, PayPal, WebMoney, QIWI и другие. Полный список доступен в документации.
Как обрабатывать вебхуки?
Для обработки вебхуков создайте эндпоинт на вашем сервере, который будет принимать POST запросы от нашего API. Укажите URL этого эндпоинта в настройках вашего проекта.
Есть ли ограничения на количество запросов?
Да, в зависимости от вашего тарифного плана. Базовый план включает 1000 запросов в день. Подробнее о лимитах можно узнать на странице тарифов.