Dokumentasi Usagey

Pelajari cara menerapkan penetapan harga berbasis penggunaan dengan Usagey

Memulai
Semua yang perlu Anda ketahui untuk memulai dengan Usagey

Usagey adalah toolkit lengkap untuk menerapkan penagihan berbasis penggunaan di aplikasi Anda. Panduan ini akan membantu Anda memulai dengan pelacakan penggunaan, menyiapkan rencana harga, dan menagih pelanggan berdasarkan konsumsi mereka.

Langkah-langkah Memulai Cepat:

  1. Buat akun dan siapkan organisasi Anda
  2. Buat kunci API untuk aplikasi Anda
  3. Implementasikan pelacakan penggunaan dalam kode Anda
  4. Siapkan rencana harga dan penagihan
  5. Pantau penggunaan dan pendapatan di dashboard
Instalasi
Cara menginstal dan menyiapkan Usagey di aplikasi Anda

Menggunakan Node.js SDK (Direkomendasikan)

npm install usagey

Menggunakan Yarn

yarn add usagey

Integrasi API Langsung

Jika Anda lebih suka mengintegrasikan langsung dengan API kami tanpa menggunakan SDK, Anda dapat membuat permintaan HTTP ke endpoint kami. Lihat bagian Referensi API untuk detailnya.

Pelacakan Penggunaan
Cara melacak peristiwa penggunaan di aplikasi Anda
import { UsageyClient } from 'usagey';

// Inisialisasi klien dengan kunci API Anda
const usagey = new UsageyClient('YOUR_API_KEY', {
  baseUrl: 'https://api.usagey.com' 
});

// Lacak peristiwa penggunaan
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();
Referensi API
Referensi lengkap untuk API Usagey

Endpoint

POST
/api/usage

Lacak peristiwa penggunaan

Lihat Detail
GET
/api/usage

Dapatkan peristiwa penggunaan

Lihat Detail
GET
/api/usage/stats

Dapatkan statistik penggunaan

Lihat Detail

Autentikasi

Semua permintaan API memerlukan autentikasi menggunakan kunci API. Sertakan kunci API Anda dalam header Authorization sebagai token Bearer.

Authorization: Bearer YOUR_API_KEY
Node.js SDK
Gunakan SDK Node.js resmi kami untuk integrasi yang lebih mudah

Instalasi

npm install usagey

Penggunaan Dasar

import { UsageyClient } from 'usagey';

// Inisialisasi klien dengan kunci API Anda
const usagey = new UsageyClient('YOUR_API_KEY');

// Lacak peristiwa penggunaan
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);
  }
}

Fitur SDK

  • Lacak peristiwa penggunaan dengan metadata khusus
  • Kelola kunci API (buat, regenerasi, hapus)
  • Ambil statistik dan batas penggunaan
  • Penanganan kesalahan yang komprehensif
  • Dukungan TypeScript dengan definisi tipe lengkap
Usagey Documentation - Usage-Based Billing SDK & API Guide