tbank-id

Библиотека для взаимодействия с API T-Bank ID (T-ID). Предназначена для использования в различных проектах на Bun/Node.js.

Возможности

• Полная поддержка TypeScript с детальной типизацией ответов.
• Поддержка бизнес-API и ГОСТ-API T-Банка.
• Работа через нативный fetch (оптимизировано для Bun).
• Интеграция с TLS (необходимо для ГОСТ-эндпоинтов).
• Обработка специфичных ошибок T-ID.

Установка

bun add tbank-id
# или
npm install tbank-id

Быстрый старт

import { TBankID } from "tbank-id";

const client = new TBankID({
  apiToken: "your_api_token",
  // tls: { ... } // Опционально для ГОСТ-эндпоинтов
});

// Получение информации о пользователе (UserInfo)
const userInfo = await client.getUserInfo();
console.log(userInfo.givenName, userInfo.familyName);

// Проверка статуса самозанятого
const { isSelfEmployed } = await client.getSelfEmployedStatus();

API Методы

Библиотека поддерживает широкий спектр методов T-Bank ID:

• Документы: ИНН (getInn), СНИЛС (getSnils), Паспорт (getPassport, getPassportShort), Водительские удостоверения (getDriverLicensesV2).
• Статусы: Черный список (getBlacklistStatus), Самозанятый (getSelfEmployedStatus), Публичное должностное лицо (getPdlStatus), Иностранный агент (getForeignAgentStatus).
• Прочее: Адреса (getAddresses), Счета (getDebitAccounts), Подписки (getSubscription), Делегированная идентификация (getDelegatedIdentification).

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

Библиотека выбрасывает исключение TBankIDError, которое содержит детальную информацию об ошибке от API:

import { TBankIDError } from "tbank-id";

try {
  await client.getUserInfo();
} catch (error) {
  if (error instanceof TBankIDError) {
    console.error(`Status: ${error.status}`);
    console.error(`Message: ${error.message}`);
    console.error(`Request ID: ${error.requestId}`);
  }
}

Сборка

Для сборки библиотеки используется Bun:

bun run build

Результат сборки будет в директории dist/.

Лицензия

GPL-3.0-only