API-Schlüssel

Erstellen, prüfen und widerrufen Sie die API-Schlüssel Ihrer Organisation für die Direct API und die Partner-API.

Mit einem API-Schlüssel kann ein anderes System Morphic nutzen, ohne dass jemand Morphic öffnet: Es startet Ihre Workflows über die Partner-API oder erzeugt und bearbeitet Medien über die Direct API. Die Registerkarte „API-Schlüssel“ ist nur für Admins sichtbar.

Direkt dorthin: studio.morphic.com/settings/api-keys

Die Seite API-Schlüssel mit Basis-URL, Organisations-ID und der Schaltfläche zum Erstellen eines Schlüssels

Ein Schlüssel gehört der Organisation

Nicht der Person, die ihn erstellt hat. Er funktioniert weiter, wenn sie das Unternehmen verlassen; jeder Admin sieht ihn aufgelistet und kann ihn widerrufen, und jeder Lauf, den er startet, wird der Organisation in Rechnung gestellt.

Einen Schlüssel erstellen

Öffnen Sie die Registerkarte

Öffnen Sie das Organisations-Dropdown (das Morphic-Logo oben links), wählen Sie Einstellungen und klicken Sie dann in der linken Seitenleiste auf „API-Schlüssel“.

Die Seitenleiste der Einstellungen mit ausgewähltem Eintrag API-Schlüssel, dem letzten der Organisationsbildschirme

Klicken Sie auf Neuer Schlüssel

Geben Sie ihm einen Namen, den Sie in einem Monat wiedererkennen werden: das System, in dem er verwendet wird, nicht „Schlüssel 2“.

Das Formular für einen neuen API-Schlüssel: Name, Bereiche, Workflows, Credit-Limits und Ablaufdatum

Wählen Sie seine Berechtigungsbereiche

Wählen Sie nur, was der Schlüssel braucht. Die ersten drei gehören zur Partner-API, die übrigen zur Direct API; diese erscheinen, sobald Morphic die Direct API für Ihre Organisation freigeschaltet hat.

  • workflows:read: einen Workflow lesen und die Eingaben, die er annimmt
  • runs:write: Läufe starten und Webhook-Endpunkte registrieren
  • runs:read: den Status eines Laufs und seine fertigen Artefakte lesen und Webhook-Endpunkte auflisten
  • projects:read: Projekte und ihre Dateien lesen
  • assets:read: Assets finden und lesen
  • assets:write: Assets hochladen und bearbeiten
  • generations:write: Bilder, Videos und Audio erzeugen, was Credits verbraucht

Setzen Sie dann das Häkchen, um den Morphic-Nutzungsbedingungen zuzustimmen, einschließlich des Abschnitts zur Developer API.

Auf bestimmte Workflows beschränken

Optional und sinnvoll. Aktivieren Sie „Diesen Schlüssel auf bestimmte Workflows beschränken“ und wählen Sie sie aus. Ein Lauf von allem anderen wird abgelehnt, was den Schaden begrenzt, falls der Schlüssel geleakt wird. Wenn es nicht aktiviert ist, kann der Schlüssel jeden Workflow der Organisation ausführen.

Im Formular für einen neuen Schlüssel ist „Diesen Schlüssel auf bestimmte Workflows beschränken“ aktiviert, mit einem Suchfeld und den Workflows der Organisation zur Auswahl

Legen Sie seine Credit-Limits fest

Legen Sie „Credits, die dieser Schlüssel insgesamt ausgeben darf“ fest oder wählen Sie „Kein Gesamtlimit (unbegrenzt)“. Tages- und Monatslimits sind optional; lassen Sie eines leer, um dieses Zeitfenster unbegrenzt zu lassen.

Eine Gesamtsumme lohnt sich. Wählen Sie sie danach, wie viel die Integration ausgeben können soll, bevor jemand erneut darauf schaut, nicht danach, was sie ausgeben wird: Sie ist ein Schutzschalter, kein Budget. Ein Fensterlimit kann nicht höher sein als die Gesamtsumme, weil sonst die Gesamtsumme zuerst greift.

Credits für einen Lauf, der mit dem Schlüssel gestartet wurde, werden der Organisation in Rechnung gestellt und auf die Limits dieses Schlüssels angerechnet. Ein Lauf, den der Schlüssel gestartet hat, wird weiterhin auf ihn angerechnet, auch wenn später jemand in den Chat einspringt und übernimmt. Andernfalls würde ein Kollege, der eine Frage beantwortet, den Rest des Laufs auf den allgemeinen Pool der Organisation verschieben. Das eigene Credit-Limit dieser Person, falls vorhanden, gilt ebenfalls.

Ein Tag ist ein UTC-Tag und ein Monat ein UTC-Kalendermonat. Eine Belastung, die den Schlüssel über eines seiner Limits hinausbringen würde, wird abgelehnt, und die Meldung nennt den Schlüssel und das Limit, auf das er gestoßen ist.

Wählen Sie ein Ablaufdatum

Nie, 30 Tage, 90 Tage oder ein Jahr. Ein abgelaufener Schlüssel hört von selbst auf, sich zu authentifizieren, was die günstigste Form der Rotation ist.

Das Geheimnis kopieren

Das Geheimnis wird nur einmal angezeigt. Morphic speichert davon nur einen Hash, sodass es nicht erneut angezeigt werden kann. Kopieren Sie es in Ihren Secret-Manager, bevor Sie den Dialog schließen.

Jeder, der den Schlüssel besitzt, kann Läufe starten, die die Credits Ihrer Organisation verbrauchen. Nie einchecken, nie in einen Browser einfügen, nie per E-Mail oder Chat senden. Wenn er geleakt wird, widerrufen Sie ihn.

Was die Liste zeigt

Jeder Schlüssel zeigt seinen Namen, ob es sich um einen Live- oder Testschlüssel handelt, die ersten Zeichen seines Geheimnisses (genug, um es mit Ihren eigenen Aufzeichnungen abzugleichen), seine Berechtigungsbereiche, wie viele Workflows er ausführen kann, seine Credit-Limits und wann er zuletzt verwendet wurde. Abgelaufene und widerrufene Schlüssel bleiben aufgelistet, damit Sie sehen können, was mit ihnen passiert ist.

Eine Organisation kann bis zu 10 Schlüssel, die sich authentifizieren können, auf einmal besitzen. Abgelaufene und widerrufene Schlüssel zählen dabei nicht mit.

Ändern Sie die Credit-Limits eines Schlüssels

  1. Finden Sie den Schlüssel in der Liste.
  2. Klicken Sie auf das „…“-Menü daneben und wählen Sie „Limits bearbeiten“.
  3. Ändern Sie die Gesamtsumme oder ein Tages- bzw. Monatslimit und speichern Sie. Löschen Sie ein Limit, um es aufzuheben.

Die neuen Limits gelten ab der nächsten Belastung des Schlüssels, auch für Läufe, die er bereits gestartet hat. Das ist die Lösung, wenn ein Lauf am Limit des Schlüssels stoppt, und es funktioniert auch bei einem widerrufenen Schlüssel: Seine Läufe werden weiterhin dagegen angerechnet, daher stoppt man sie, indem man seine Limits senkt.

Einen Schlüssel widerrufen

  1. Finden Sie den Schlüssel in der Liste.
  2. Klicken Sie auf das „…“-Menü daneben und wählen Sie „Schlüssel widerrufen“.
  3. Bestätigen.

Aufrufe, die ihn verwenden, schlagen innerhalb von Sekunden fehl. Bereits laufende Läufe werden beendet und ebenfalls in Rechnung gestellt. Das Widerrufen kann nicht rückgängig gemacht werden. Um einen Schlüssel zu rotieren, erstellen Sie zuerst den Ersatz, verschieben Sie Ihren Traffic darauf und widerrufen Sie dann den alten Schlüssel.

Wo die Ausgaben erscheinen

Credits, die über die API ausgegeben werden, werden der Organisation in Rechnung gestellt und dem Schlüssel zugerechnet, der sie ausgegeben hat. In der Credit-Nutzung erscheint die API-Ausgabe als ein weiteres Mitglied, „API“, und eine Belastung durch einen benannten Schlüssel als „API · “ und der Name des Schlüssels.

  • Schalten Sie in „Übersicht“ „API nach Schlüssel aufteilen“ ein, um die Ausgaben der API pro Schlüssel aufzuschlüsseln.
  • Ein Lauf der Partner-API, der mit einer user_email gestartet wird, die keinem Ihrer Mitglieder gehört, wird im „Nutzungsverlauf“ unter dieser E-Mail-Adresse aufgeführt, sodass Sie sehen, was jeder Ihrer eigenen Nutzer ausgegeben hat. Ein Lauf, dessen user_email einem Mitglied gehört, zählt für dieses Mitglied. Siehe Einen Workflow-Lauf starten.

Wenn Sie Probleme haben oder Fragen haben, können Sie sich gerne an uns wenden. Wir helfen Ihnen gerne. Schreiben Sie uns an support@morphic.com.

Auf dieser Seite