Usagey दस्तावेज़ीकरण

Usagey के साथ उपयोग-आधारित मूल्य निर्धारण को लागू करना सीखें

शुरुआत करना
Usagey के साथ शुरुआत करने के लिए आपको जो कुछ भी जानना चाहिए

Usagey आपके एप्लिकेशन में उपयोग-आधारित बिलिंग लागू करने के लिए एक संपूर्ण टूलकिट है। यह गाइड आपको उपयोग ट्रैकिंग शुरू करने, मूल्य निर्धारण योजनाएं सेट अप करने, और ग्राहकों को उनके उपभोग के आधार पर बिल करने में मदद करेगी।

त्वरित प्रारंभ चरण:

  1. एक खाता बनाएं और अपना संगठन सेट अप करें
  2. अपने एप्लिकेशन के लिए एक API कुंजी बनाएं
  3. अपने कोड में उपयोग ट्रैकिंग लागू करें
  4. मूल्य निर्धारण योजनाएं और बिलिंग सेट अप करें
  5. डैशबोर्ड में उपयोग और राजस्व की निगरानी करें
इंस्टॉलेशन
अपने एप्लिकेशन में Usagey को कैसे इंस्टॉल और सेट अप करें

Node.js SDK का उपयोग (अनुशंसित)

npm install usagey

Yarn का उपयोग

yarn add usagey

प्रत्यक्ष API एकीकरण

यदि आप SDK के बिना सीधे हमारे API के साथ एकीकरण करना पसंद करते हैं, तो आप हमारे एंडपॉइंट्स पर 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 कुंजी को Bearer टोकन के रूप में Authorization हेडर में शामिल करें।

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