SIGMA OTP NodeJS SDK

Введение

SDK предоставляет удобный интерфейс к сервису авторизации SIGMA по различным каналам. Подробнее о сервисе.
SIGMA OTP SDK для NodeJS помогает быстро интегрировать функционал в ваше приложение, предлагая гибкие настройки для уникальных требований проекта.

Установка и настройка

Убедитесь, что у вас установлен Node.js версии 12 и выше, и выполните следующую команду для установки SDK:

npm install @sigmamessaging/otp-sdk

Быстрая интеграция

1. Добавьте виджет на свой Frontend.
2. Импортируйте SDK и используйте предоставленные контроллеры для NestJS, Express, Fastify, Bun.
3. Добавьте в Backend финальную проверку статуса и завершение процесса аутентификации вызвав команду checkStatusAndComplete.

• Подробная документация
• Подключение виджета

Пример с Express:

import express from 'express';
import {
  registerExpressRoutes,
  SigmaOtpSDKEnvironmentEnum
} from '@sigmamessaging/otp-sdk';

const app = express();
app.use(express.json());

registerExpressRoutes(app, {
  apiToken: API_TOKEN,
  apiUrl: `${API_BASE_URL}/api/n/otp-handler`,
  environment: SigmaOtpSDKEnvironmentEnum.production
});

app.listen(3000, () => {
    console.log(`Server running on port 3000`);
});

Принцип работы

1. Загрузка данных формы: Frontend запрашивает данные у Backend, который обращается к SDK.
2. Инициация сессии авторизации: Пользователь вводит номер телефона, и система инициирует процесс авторизации.
3. Отображение формы авторизации: Предоставляется способ авторизации, который отображается пользователю.
4. Завершение: Пользователь завершает авторизацию, а Frontend отправляет данные о завершении авторизации в Backend.
5. Проверка статуса и завершение: Backend проверяет статус авторизации и завершает процесс вызывая команду checkStatusAndComplete.

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

Подробнее в документации по SDK

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

Информацию по ошибкам смотрите в документации по ошибкам, а так же в документации каждого метода.

События

SDK предоставляет возможность подписаться на определенные события в процессе авторизации. Подробнее в инструкции по работе с событиями.

Дополнительные ресурсы

• Поддержка