Usagey dokumentáció

Tanulja meg, hogyan valósítsa meg a használat alapú árképzést a Usagey-vel

Első lépések
Minden, amit tudnia kell a Usagey használatának megkezdéséhez

A Usagey egy teljes eszközkészlet a használat alapú számlázás megvalósításához az alkalmazásaiban. Ez az útmutató segít a használat követésének megkezdésében, az árképzési tervek beállításában és az ügyfelek számlázásában a fogyasztásuk alapján.

Gyors kezdés lépései:

  1. Hozzon létre fiókot és állítsa be szervezetét
  2. Hozzon létre API kulcsot az alkalmazásához
  3. Valósítsa meg a használat követését a kódjában
  4. Állítsa be az árképzési terveket és a számlázást
  5. Kövesse nyomon a használatot és a bevételt a vezérlőpulton
Telepítés
Hogyan telepítse és állítsa be a Usagey-t az alkalmazásában

A Node.js SDK használata (ajánlott)

npm install usagey

A Yarn használata

yarn add usagey

Közvetlen API integráció

Ha inkább közvetlenül az API-nkkal szeretne integrálni SDK nélkül, HTTP kéréseket küldhet a végpontjainkra. A részletekért tekintse meg az API referencia szakaszt.

Használat követése
Hogyan kövesse nyomon a használati eseményeket az alkalmazásában
import { UsageyClient } from 'usagey';

// A kliens inicializálása az API kulcsával
const usagey = new UsageyClient('YOUR_API_KEY', {
  baseUrl: 'https://api.usagey.com' 
});

// Használati esemény követése
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 referencia
Teljes referencia a Usagey API-hoz

Végpontok

POST
/api/usage

Használati esemény követése

Részletek megtekintése
GET
/api/usage

Használati események lekérése

Részletek megtekintése
GET
/api/usage/stats

Használati statisztikák lekérése

Részletek megtekintése

Hitelesítés

Minden API kérés hitelesítést igényel API kulcs használatával. Tartalmazza az API kulcsát az Authorization fejlécben Bearer tokenként.

Authorization: Bearer YOUR_API_KEY
Node.js SDK
Használja a hivatalos Node.js SDK-nkat a könnyebb integrációért

Telepítés

npm install usagey

Alapvető használat

import { UsageyClient } from 'usagey';

// A kliens inicializálása az API kulcsával
const usagey = new UsageyClient('YOUR_API_KEY');

// Használati esemény követése
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 funkciók

  • Használati események követése egyéni metaadatokkal
  • API kulcsok kezelése (létrehozás, újragenerálás, törlés)
  • Használati statisztikák és korlátok lekérése
  • Átfogó hibakezelés
  • TypeScript támogatás teljes típusdefiníciókkal
Usagey Documentation - Usage-Based Billing SDK & API Guide