Tài liệu Usagey

Tìm hiểu cách triển khai định giá dựa trên sử dụng với Usagey

Bắt đầu
Mọi thứ bạn cần biết để bắt đầu với Usagey

Usagey là một bộ công cụ hoàn chỉnh để triển khai thanh toán dựa trên sử dụng trong các ứng dụng của bạn. Hướng dẫn này sẽ giúp bạn bắt đầu với việc theo dõi sử dụng, thiết lập kế hoạch định giá và thanh toán cho khách hàng dựa trên mức tiêu thụ của họ.

Các bước bắt đầu nhanh:

  1. Tạo tài khoản và thiết lập tổ chức của bạn
  2. Tạo khóa API cho ứng dụng của bạn
  3. Triển khai theo dõi sử dụng trong mã của bạn
  4. Thiết lập kế hoạch định giá và thanh toán
  5. Giám sát sử dụng và doanh thu trên bảng điều khiển
Cài đặt
Cách cài đặt và thiết lập Usagey trong ứng dụng của bạn

Sử dụng Node.js SDK (Khuyên dùng)

npm install usagey

Sử dụng Yarn

yarn add usagey

Tích hợp API trực tiếp

Nếu bạn muốn tích hợp trực tiếp với API của chúng tôi mà không sử dụng SDK, bạn có thể thực hiện các yêu cầu HTTP đến các endpoint của chúng tôi. Xem phần Tham khảo API để biết chi tiết.

Theo dõi sử dụng
Cách theo dõi các sự kiện sử dụng trong ứng dụng của bạn
import { UsageyClient } from 'usagey';

// Khởi tạo client với khóa API của bạn
const usagey = new UsageyClient('YOUR_API_KEY', {
  baseUrl: 'https://api.usagey.com' 
});

// Theo dõi sự kiện sử dụng
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();
Tham khảo API
Tham khảo đầy đủ cho API Usagey

Endpoints

POST
/api/usage

Theo dõi sự kiện sử dụng

Xem chi tiết
GET
/api/usage

Lấy sự kiện sử dụng

Xem chi tiết
GET
/api/usage/stats

Lấy thống kê sử dụng

Xem chi tiết

Xác thực

Tất cả các yêu cầu API đều yêu cầu xác thực bằng khóa API. Bao gồm khóa API của bạn trong header Authorization dưới dạng Bearer token.

Authorization: Bearer YOUR_API_KEY
Node.js SDK
Sử dụng SDK Node.js chính thức của chúng tôi để tích hợp dễ dàng hơn

Cài đặt

npm install usagey

Sử dụng cơ bản

import { UsageyClient } from 'usagey';

// Khởi tạo client với khóa API của bạn
const usagey = new UsageyClient('YOUR_API_KEY');

// Theo dõi sự kiện sử dụng
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);
  }
}

Tính năng SDK

  • Theo dõi sự kiện sử dụng với metadata tùy chỉnh
  • Quản lý khóa API (tạo, tái tạo, xóa)
  • Lấy thống kê sử dụng và giới hạn
  • Xử lý lỗi toàn diện
  • Hỗ trợ TypeScript với định nghĩa kiểu đầy đủ
Usagey Documentation - Usage-Based Billing SDK & API Guide