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 სახელმძღვანელო
Usagey API-ს სრული სახელმძღვანელო

ენდპოინტები

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