Zum Hauptinhalt springen
Liste aktive menschliche Mitglieder, ändere einen Plan und setze das Extra-Usage-Budget über dem enthaltenen Kontingent. Beträge sind US-Dollar. Die Aufrufe laufen über den BILLING_API Scope des Workspace-API-Schlüssels. Schreibzugriffe laufen als der Service Account, dem der Schlüssel gehört. Diese API lädt niemanden ein und deaktiviert niemanden. Dafür nutzt du die User Management API.

Basis-URL

Dedicated DeploymentsErsetze api.langdock.com durch <your-deployment-url>/api/public in allen Anfragen.

Voraussetzungen

  • API-Schlüssel mit dem Scope BILLING_API
  • Der Besitzer ist ein Service Account, der nicht gelöscht ist und eine aktive Admin-Mitgliedschaft hat
  • USER_MANAGEMENT_API am selben Schlüssel, wenn du email, name oder einen E-Mail-Filter brauchst
Ein Mitgliedsobjekt enthält email und name nur, wenn der Schlüssel auch USER_MANAGEMENT_API hat. Ohne den Scope fehlen die Felder. name kann null sein, wenn es enthalten ist.
monthlyBudget.effective ist das enthaltene Monatsbudget. Es ist der höhere Wert aus Planbudget und Gruppenbudgets. Unbegrenzt schlägt begrenzt. Bei gleichem Betrag gewinnt der Plan gegen eine Gruppe. Setzen zwei Gruppen denselben Betrag, ist die Quelle die Gruppe, deren Name zuerst kommt. source ist plan oder group mit groupId und groupName. Dieses Monatsbudget setzt das Wochenkontingent (Monat geteilt durch 4) und das Session-Kontingent (Woche geteilt durch 3). extraUsageBudget ist das Kontingent, nachdem diese Fenster aufgebraucht sind. Es ist none, unlimited oder limited. extraUsagePeriodSpend misst diese Extra Usage. Der Wert ist null, wenn der Workspace die Ausgaben pro Nutzer ausblendet. Wer kein aktives menschliches Mitglied ist, gibt 404 zurück.
Langdock blockiert bewusst Browser-basierte Anfragen, um deinen API-Schlüssel zu schützen und die Sicherheit deiner Anwendungen zu gewährleisten. Weitere Informationen findest du in unserem Guide zu Best Practices für API-Schlüssel.