pro Model HubDocs
Grundlagen

Konto und API-Keys

Accounts, Pakete, Nutzer, Rollen und API-Keys mit Modellbeschränkung, Credit-Limit und Ablaufdatum.

Account und Nutzer

Ein Account ist dein Kundenkonto: Er hat ein gemeinsames Paket und bekommt eine gemeinsame Rechnung. Im Account kann es mehrere Nutzer geben, jeder mit eigenem Login und eigenen API-Keys.

Paket aktivieren

Bevor API-Keys funktionieren, braucht dein Account ein aktives Paket. Nach der Freischaltung deines Accounts aktiviert der Owner im Portal unter Paket das Starter-Paket für 30 Tage kostenlos oder bestellt gleich ein größeres Paket. Ohne aktives Paket antwortet die API mit 403 und dem Code no_package (Fehler).

Das Paket bestellt und ändert nur der Owner. Credits, Requests pro Minute und parallele Requests des Pakets teilen sich alle Nutzer und Keys des Accounts. Details zu Paketen, Testphase und Wechsel stehen unter Abrechnung.

RolleDarf
Owneralles, auch Nutzer anlegen und verwalten und das Paket bestellen, wechseln oder kündigen; wird bei der Registrierung automatisch angelegt
AdminNutzer anlegen, bearbeiten, sperren und löschen; alle Keys im Account sehen und widerrufen; Paket, Preise, Abrechnungen und den Verbrauch des ganzen Accounts sehen; Ansprechpartner im Profil ändern
Membereigene API-Keys verwalten, Playground nutzen, den eigenen Verbrauch und das eigene Credit-Limit sehen

Was Member sehen

Member sehen kein Paket, keine Preise und keine Abrechnungen. Unter Kosten & Verbrauch stehen ihr eigener Verbrauch pro Modell im laufenden Abrechnungszeitraum und

  • ihr eigenes Credit-Limit mit verbrauchten und verfügbaren Credits, wenn der Owner oder ein Admin eines gesetzt hat,
  • sonst der Credit-Stand des Accounts (verbraucht und verfügbar).

Auf der Übersicht zeigt das Diagramm Members nur ihren eigenen Verbrauch pro Tag, auch wenn darüber der Credit-Stand des Accounts steht (die Überschriften sagen, wessen Zahlen es sind).

Ist das Kontingent des Accounts aufgebraucht, sehen auch Member einen Hinweis im Portal, selbst wenn ihr eigenes Limit noch nicht erreicht ist: Der Stopp bei 100 % gilt für den ganzen Account. Um ein größeres Paket oder ein höheres Limit kümmern sich Owner und Admins.

Firmendaten und Rechnungsadresse

Über Unternehmen und profihost Kundennummer ordnen wir deinen Account deinem profihost-Kundenkonto zu, die Rechnungsadresse gehört zur Rechnung. Deshalb gilt:

  • Unternehmen und profihost Kundennummer gibst du bei der Registrierung an. Danach ändert sie nur noch der Support.
  • Rechnungsadresse und USt-IdNr. gibst du bei der ersten Bestellung (auch der Aktivierung der Testphase) an. Danach ändert sie nur noch der Support.
  • Fehlt eine Angabe noch, z. B. bei älteren Accounts oder wenn du die USt-IdNr. bei der Bestellung leer gelassen hast, kannst du sie einmal nachtragen: bei der nächsten Bestellung oder im Portal unter Paket.
  • Vorname, Nachname und Telefon des Ansprechpartners ändern Owner und Admins jederzeit im Portal unter Profil.

Im Portal stehen die gesperrten Angaben unter Profil und Paket nur zum Lesen. Für eine Änderung, z. B. nach einer Umfirmierung oder einem Umzug, wende dich an den Support.

Nutzer verwaltest du im Portal unter Team. Pro Nutzer lassen sich festlegen:

  • Erlaubte Modelle – der Nutzer und alle seine Keys können nur diese Modelle aufrufen.
  • Credit-Limit – Credits pro Abrechnungszeitraum, gilt für alle Keys des Nutzers zusammen.
  • Sperren – alle Keys des Nutzers werden sofort gesperrt; beim Entsperren funktionieren sie wieder.

API-Keys

Jeder Nutzer kann bis zu 25 aktive API-Keys anlegen, z. B. einen pro Anwendung oder Umgebung. Einstellungen pro Key:

EinstellungWirkung
Namenur zur Unterscheidung im Portal
Modellbeschränkungder Key kann nur diese Modelle aufrufen – zusätzlich zur Beschränkung des Nutzers (es gilt die Schnittmenge)
Credit-LimitCredits, die dieser Key im laufenden Abrechnungszeitraum verbrauchen darf
Ablaufdatumdanach lehnt die API den Key ab; ohne Datum gilt er unbegrenzt

Key nur einmal sichtbar

Wir speichern nur einen Hash des Keys. Nach dem Anlegen kann ihn niemand mehr anzeigen, auch der Support nicht. Wenn du ihn verlierst, erzeuge ihn neu.

Neu erzeugen und widerrufen

  • Neu erzeugen (Rotation): Du bekommst einen neuen Key mit denselben Einstellungen, der alte wird sofort ungültig. Der Verbrauch des neuen Keys für sein Credit-Limit beginnt bei 0.
  • Widerrufen: Der Key wird sofort ungültig. Sein bisheriger Verbrauch bleibt in der Abrechnung sichtbar.

Was bei einem Limit passiert

Mit Credit-Limits teilst du das Kontingent deines Pakets im Team auf. Überschreitet ein Key sein Credit-Limit oder der Nutzer das Nutzerlimit, wird der Key gesperrt und die API antwortet mit 401 (Fehler). Die Sperre hebt sich automatisch auf, wenn du das Limit erhöhst oder ein neuer Abrechnungszeitraum beginnt.

Ist dagegen das Kontingent des ganzen Pakets verbraucht, antwortet die API für alle Keys mit 429 und dem Code insufficient_quota (Abrechnung).

Der Verbrauch wird etwa einmal pro Minute ausgewertet. Bis die Sperre greift, können deshalb noch einzelne Requests über das Limit hinaus durchgehen – plane das Limit mit etwas Puffer.

Passwort ändern

Jeder Nutzer, ob Owner, Admin oder Member, ändert sein Passwort im Portal unter Mein Konto. Dafür gibst du dein aktuelles Passwort ein und zweimal das neue (mindestens 12 Zeichen).

  • Nach dem Ändern sind alle anderen Anmeldungen mit deinem Zugang beendet, auch in anderen Browsern. Du selbst bleibst im Portal angemeldet. Eine E-Mail bestätigt die Änderung.
  • Gibst du das aktuelle Passwort fünfmal falsch ein, ist die Änderung 15 Minuten gesperrt. Das schützt dich, falls jemand eine offene Sitzung von dir benutzt. Hast du dein Passwort vergessen, hilft Passwort vergessen, das auch während der Sperre funktioniert und sie aufhebt.
  • API-Keys bleiben unverändert, sie hängen nicht am Passwort.

Passwort vergessen

Auf der Anmeldeseite unter Passwort vergessen? gibst du die E-Mail-Adresse deines Zugangs ein. Du bekommst einen Link, mit dem du ein neues Passwort festlegst (mindestens 12 Zeichen).

  • Der Link ist 60 Minuten gültig und funktioniert einmal. Forderst du einen neuen an, wird der alte ungültig.
  • Nach dem Ändern sind alle bisherigen Anmeldungen beendet, auch in anderen Browsern. Eine E-Mail bestätigt die Änderung.
  • Aus Sicherheitsgründen sagt die Seite nicht, ob es zur Adresse einen Zugang gibt. Kommt keine E-Mail an, prüfe den Spam-Ordner und die Schreibweise der Adresse.
  • Gesperrte Nutzer und noch nicht freigeschaltete Accounts bekommen keinen Link.

Benachrichtigungen per E-Mail

AnlassWer bekommt die E-Mail
Registrierung eingegangendie Person, die sich registriert hat
Account freigeschaltetOwner und Admins
Testphase aktiviert, Paket bestellt, Upgrade, Downgrade vorgemerkt, KündigungOwner und Admins
Paket durch profihost geändertOwner und Admins
75 % und 90 % der Credits verbraucht (je einmal pro Zeitraum)Owner und Admins
Passwort zurücksetzen, Passwort geändertnur der betroffene Nutzer

E-Mails kommen in der Sprache, die du im Portal eingestellt hast (Deutsch oder Englisch). Wechselst du die Sprache im Portal, gilt sie auch für künftige E-Mails.

Sicherheit

  • Setze den Key als Umgebungsvariable oder in einem Secret-Store, nie im Quellcode oder im Frontend.
  • Verwende getrennte Keys pro Anwendung. Dann kannst du einen einzelnen Key widerrufen, ohne alle anderen zu tauschen.
  • Beschränke Keys auf die Modelle, die die Anwendung braucht, und setze ein Credit-Limit.
  • Schicke den Key nur an https://api.promodelhub.de – im Header Authorization: Bearer <key>.

Auf dieser Seite