Документація Usagey

Дізнайтеся, як впровадити ціноутворення на основі використання з Usagey

Початок роботи
Все, що вам потрібно знати для початку роботи з Usagey

Usagey — це повний набір інструментів для впровадження біллінгу на основі використання у ваших додатках. Цей посібник допоможе вам розпочати відстеження використання, налаштувати плани ціноутворення та виставляти рахунки клієнтам на основі їх споживання.

Кроки швидкого початку:

  1. Створіть обліковий запис і налаштуйте вашу організацію
  2. Створіть API ключ для вашого додатка
  3. Впровадіть відстеження використання у вашому коді
  4. Налаштуйте плани ціноутворення та біллінг
  5. Відстежуйте використання та дохід на панелі керування
Встановлення
Як встановити та налаштувати Usagey у вашому додатку

Використання Node.js SDK (Рекомендовано)

npm install usagey

Використання Yarn

yarn add usagey

Пряма інтеграція API

Якщо ви віддаєте перевагу прямій інтеграції з нашим API без використання SDK, ви можете робити HTTP запити до наших ендпоінтів. Дивіться розділ Довідник API для деталей.

Відстеження використання
Як відстежувати події використання у вашому додатку
import { UsageyClient } from 'usagey';

// Ініціалізуйте клієнта з вашим API ключем
const usagey = new UsageyClient('YOUR_API_KEY', {
  baseUrl: 'https://api.usagey.com' 
});

// Відстежити подію використання
async function trackApiCall() {
  try {
    const result = await usagey.trackEvent('api_call', 1, {
      endpoint: '/users',
      method: 'GET'
    });
    console.log('Event tracked:', result.event_id);
  } catch (error) {
    console.error('Error tracking event:', error);
  }
}

trackApiCall();
Довідник API
Повний довідник для API Usagey

Ендпоінти

POST
/api/usage

Відстежити подію використання

Переглянути деталі
GET
/api/usage

Отримати події використання

Переглянути деталі
GET
/api/usage/stats

Отримати статистику використання

Переглянути деталі

Аутентифікація

Усі запити API вимагають аутентифікації з використанням API ключа. Включіть ваш API ключ у заголовок Authorization як Bearer токен.

Authorization: Bearer YOUR_API_KEY
Node.js SDK
Використовуйте наш офіційний Node.js SDK для легшої інтеграції

Встановлення

npm install usagey

Основне використання

import { UsageyClient } from 'usagey';

// Ініціалізуйте клієнта з вашим API ключем
const usagey = new UsageyClient('YOUR_API_KEY');

// Відстежити подію використання
async function trackApiCall() {
  try {
    const result = await usagey.trackEvent('api_call', 1, {
      endpoint: '/users',
      method: 'GET'
    });
    console.log('Event tracked:', result.event_id);
  } catch (error) {
    console.error('Error tracking event:', error);
  }
}

Функції SDK

  • Відстеження подій використання з користувацькими метаданими
  • Керування API ключами (створення, перегенерація, видалення)
  • Отримання статистики використання та лімітів
  • Комплексна обробка помилок
  • Підтримка TypeScript з повними визначеннями типів
Usagey Documentation - Usage-Based Billing SDK & API Guide