Zum Inhalt springen

Das Proxynet-Panel arbeitet mit einem Organisationsmodell wie bei GitHub. Eine Organisation bündelt Dienste, Guthaben, Stufe und Tokens. Berechtigte Mitglieder der Organisation erstellen und verwalten Proxys im Panel; die API erledigt dieselben Aufgaben über ein Token.

Was zur Organisation gehört

Dienste

Alle Proxy-Bestellungen laufen auf die Organisation. GET /orders listet die Dienste der Organisation auf.

Guthaben und Stufe

Bestellungen werden aus dem Guthaben der Organisation bezahlt; die Preise ergeben sich aus der Stufe (Tier) der Organisation.

API-Tokens

Ein Token wird in einer Organisation erstellt und sieht nur deren Dienste.

Aktivität

Jede Änderung über die API wird auf der Seite „Aktivität“ der Organisation protokolliert.

Zu welcher Organisation ein Token gehört

Das Feld organization in der Antwort von GET /me nennt die Organisation des Tokens, das Feld access, was dieses Token in der Organisation sehen darf.

GET /me (gekürzt)
{
  "data": {
    "token": { "name": "Monitoring-Server", "scopes": ["orders:read"] },
    "organization": { "id": "…", "name": "Stax", "slug": "stax" },
    "access": { "order_visibility": "all", "logs": true },
    "plan": { "name": "Tier 2", "custom_credentials": true },
    "billing": { "balance": 124.5, "currency": "USD" }
  }
}
  • access.order_visibility: welche Dienste der Organisation das Token sehen darf. Listen- und Detail-Endpoints wenden dieselbe Sichtbarkeit an wie das Panel.
  • access.logs: ob die Log-Endpoints für dieses Token freigegeben sind. Der Log-Zugriff setzt außerdem voraus, dass die Stufe Log-Zugriff umfasst.

Stufe und Preis

Die Stufe gilt auf Organisationsebene. /me, /catalog und /pricing nutzen dieselbe Quelle für die Stufe, deshalb stimmen ein Preisangebot und der bei der Bestellung abgebuchte Betrag überein. Hat eine Organisation keine zugewiesene Stufe, gilt die niedrigste Stufe, und in den Antworten erscheint price_source: base_plan.

plan.custom_credentials gibt an, ob Sie Benutzername und Passwort bei der Bestellung selbst wählen dürfen. Ohne diese Erlaubnis liefert eine Anfrage, die diese Felder mitsendet,403 tier_required; lassen Sie die Felder weg, werden die Werte automatisch erzeugt.

Mehrere Organisationen

Ein Benutzer kann Mitglied mehrerer Organisationen sein; ein Token gehört dagegen genau einer Organisation. Erstellen Sie für jede Organisation ein eigenes Token und legen Sie in Ihrer Integration die Organisation über die Wahl des Tokens fest.

ZurückAuthentifizierungWeiterTokens und Berechtigungen