Zum Hauptinhalt springen
Mit der Billing API änderst du Nutzerpläne, Limits für den Workspace und für Gruppen und Budgets von Agenten aus deinen eigenen Systemen. Nutze sie, wenn die Änderung eines Admins Langdock aktualisieren soll, ohne dass jemand die Nutzungseinstellungen öffnet. Du kannst außerdem Nutzungslimit-Anfragen auflisten und eine Anfrage ablehnen, die noch offen ist. Die User Management API lädt Personen ein, ändert Rollen und deaktiviert Mitglieder. Die Billing API macht das nicht. Gruppenmitgliedschaften ändert sie ebenfalls nicht.
Die Routen unten gelten, wenn GET /billing/v1/mode den Modus bring-your-own-keys liefert. Ein Dedicated Deployment liefert immer diesen Modus, auch wenn Langdock die Modellschlüssel verwaltet. Beträge sind US-Dollar. In der Cloud kannst du den Scope Billing API nur vergeben, wenn Langdock ihn für den Workspace freigeschaltet hat. Ist der Modus ein anderer, antworten diese Routen mit 409.

​
Bevor du startest

  • API-Key-Scope: BILLING_API an einem Workspace-API-Schlüssel. In der Scope-Auswahl heißt der Scope Billing API und steht in der Gruppe Billing, nach User Management und vor Audit Log. Persönliche API-Schlüssel können den Scope nicht bekommen. Bestehende Workspace-Schlüssel erhalten ihn nicht von allein.
  • Besitzer: Der Schlüssel gehört einem Service Account, der nicht gelöscht ist und eine aktive Admin-Mitgliedschaft hat. Schreibzugriffe laufen als dieser Service Account. Fehlt die Mitgliedschaft, kommt 403 mit code BILLING_API_ADMIN_REQUIRED.
  • Namen und E-Mails: Nutzerobjekte enthalten immer id, den Plan und die Limits. email und name sind nur dabei, wenn derselbe Schlüssel auch USER_MANAGEMENT_API hat. Ein Filter auf email ohne diesen Scope gibt 403 mit code USER_MANAGEMENT_API_REQUIRED zurück.
Starte mit der Modusabfrage und rufe danach nur die Routen dieses Modus auf. Der andere Modus antwortet mit 409, code BILLING_MODE_MISMATCH und dem Workspace-Modus in details.mode.

​
Basis-URL

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

​
Billing-Modus

Die Pläne in diesem Modus sind standard (Standard) und power_user (Power User). Es gibt keine Seats-Route. Ein Pfad, den es in diesem Modus nicht gibt, zum Beispiel ein Seats-Pfad, gibt 404 zurück.

​
Limits

Ein Limit schickst und liest du in einer dieser Formen. Nur limited enthält amount.
Ein begrenztes Workspace-Limit muss größer als null sein. Ein begrenzter Betrag an einem Plan, einem Mitglied oder einer Gruppe darf null sein. Ein begrenztes Agent-Budget muss größer als null sein. Extra-Usage-Budgets in diesem Modus akzeptieren auch { "type": "none" }. Agent-Budgets akzeptieren none ebenfalls. none entfernt das Extra-Kontingent oder das eigene Agent-Budget. Ein PATCH braucht mindestens ein Feld, das du schreiben darfst. Felder, die du weglässt, bleiben, auch ein Plan, den du in monthlyBudgetPerPlan nicht mitschickst. Unbekannte Felder werden abgelehnt.

​
Listen und Ausgaben

Listen liefern standardmäßig 50 Einträge. limit liegt zwischen 1 und 250. Gib cursor aus dem nextCursor der vorigen Seite zurück und behalte dieselben Filter. Auf der letzten Seite fehlt nextCursor. Gib den Cursor unverändert zurück. GET liefert Ausgaben, wenn der Workspace die Ausgaben pro Nutzer zeigt. Sind sie ausgeblendet, ist das Ausgabenfeld null. Schreibzugriffe auf Nutzer, Einstellungen und Agenten setzen die Ausgaben immer auf null, damit ein erfolgreicher Schreibzugriff nicht an einer nachgeladenen Summe scheitert. Lies die Ressource danach erneut, um die Ausgaben zu bekommen.

​
Verfügbare Endpoints

​
Fehler

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.