Zum Hauptinhalt springen
Gesamte Dokumentation

API und Integrationen

Verbinden Sie eine Anwendung über die dokumentierte Inferenz-API oder Modelltraining-API, beschränkte Zugangsdaten sowie aktuelle Nutzungs- und API-Referenzen.

Ablauf
  1. API-Produkt auswählenUnterscheiden Sie Inferenz-Anfragen von Modelltraining-Abläufen.
  2. Vertrag lesenNutzen Sie die passende API-Dokumentation und OpenAPI-Referenz.
  3. Eingeschränkten Schlüssel erstellenErstellen und speichern Sie einen Kunden-API-Schlüssel sicher.
  4. Integrieren und prüfenSenden Sie eine dokumentierte Anfrage und prüfen Sie die Antwort.
  5. Überwachen und rotierenPrüfen Sie die Nutzung und widerrufen oder rotieren Sie Schlüssel bei Bedarf.

Passenden API-Ablauf auswählen

Die Inferenz-API verarbeitet Modell-Inferenz-Anfragen. Die Modelltraining-API beschreibt einen separaten Trainingsablauf mit Angeboten, Jobs, Sitzungen und Artefakten. Gehen Sie weder davon aus, dass ein Inferenz-Endpunkt das Training startet, noch dass Trainingsfunktionen Teil des Inferenz-Vertrags sind. Lesen Sie die Dokumentation des gewünschten Produkts und prüfen Sie, ob Modell oder Trainingsfunktion aufgeführt sind. Verwenden Sie die veröffentlichten Anfrage- und Antwortformate, statt Methodennamen aus einem vertrauten Drittanbieter-SDK abzuleiten.

  1. Feststellen, ob die Anwendung Inferenz oder Modelltraining benötigt.
  2. Dokumentation und API-Referenz des passenden Produkts öffnen.
  3. Prüfen, ob die gewünschte Funktion und das Modell dokumentiert sind.

API-Schlüssel erstellen und schützen

Erstellen Sie im angemeldeten API-Schlüsselbereich einen Kunden-API-Schlüssel und wählen Sie, sofern angeboten, nur die von Ihrer Integration benötigten Scopes. Das Geheimnis wird nur einmal angezeigt. Übertragen Sie es daher direkt in einen zugelassenen Secret Manager. Committen Sie es nicht in die Versionsverwaltung, schreiben Sie es nicht in Logs und legen Sie es nicht im Browsercode offen. Kennzeichnen Sie Zugangsdaten nach Möglichkeit nach Anwendung und Umgebung. Verwenden Sie getrennte Schlüssel für Entwicklung und Produktion, damit sich ein Schlüssel widerrufen lässt, ohne andere Integrationen zu unterbrechen.

  1. API-Schlüssel im angemeldeten Kunden-Workspace öffnen.
  2. Einen Schlüssel mit den engstmöglichen erforderlichen Scopes erstellen.
  3. Geheimnis sicher speichern und aus Quellcode sowie Logs heraushalten.

Nach dem dokumentierten Vertrag implementieren

Halten Sie sich im passenden API-Leitfaden an Angaben zu Authentifizierung, Endpunkt, Anfragefeldern, Antwortverarbeitung und Fehlern. Bewahren Sie Zugangsdaten auf einem vertrauenswürdigen Server statt in öffentlichem Clientcode auf. Validieren Sie Eingaben vor dem Senden, behandeln Sie nicht erfolgreiche Antworten ausdrücklich und protokollieren Sie weder Authorization-Header noch vertrauliche Prompt-Daten. Die OpenAPI-Referenz enthält den veröffentlichten maschinenlesbaren Vertrag. Nehmen Sie nicht an, dass Streaming, Medienfunktionen oder anbietereigene Operationen unterstützt werden, sofern sie nicht ausdrücklich in der aktuellen Dokumentation aufgeführt sind.

  1. Nur für die ausgewählte API dokumentierte Operationen und Felder implementieren.
  2. Zugangsdaten serverseitig halten und aus Diagnosedaten entfernen.
  3. Dokumentierte Fehler behandeln und bereitgestellte Anfragekennungen aufbewahren.

Nutzung überwachen und Zugangsdaten verwalten

Prüfen Sie nach der Integration die Nutzungsseite, vergleichen Sie die Ihrem Konto zugeordnete Aktivität mit den Anwendungsdaten und untersuchen Sie unerwartete Änderungen, bevor Sie das Anfragevolumen erhöhen oder weitere Zugangsdaten erstellen. Rotieren Sie einen möglicherweise offengelegten Schlüssel, aktualisieren Sie den Secret Store der Anwendung und prüfen Sie die Integration, bevor Sie alte Schlüssel entfernen. Widerrufen Sie nicht mehr benötigte Schlüssel. Nutzungsanzeigen helfen bei der Betriebsprüfung, garantieren aber weder künftige Kosten noch verfügbare Kapazität.

  1. Plattformnutzung mit den Anfragedatensätzen der Anwendung vergleichen.
  2. Offengelegte Zugangsdaten rotieren und den Ersatz prüfen.
  3. Unbenutzte Schlüssel widerrufen und Zugriffe regelmäßig prüfen.

Häufig gestellte Fragen

Sind Inferenz und Modelltraining dieselbe API?

Nein. Es sind getrennte Produkte mit unterschiedlichen dokumentierten Abläufen. Folgen Sie der Referenz für die benötigte Funktion.

Wo finde ich den unterstützten API-Vertrag?

Verwenden Sie die in diesem Leitfaden verlinkte Produktdokumentation und OpenAPI-Referenz. Dort ist die aktuell veröffentlichte Schnittstelle beschrieben.

Wo sollte ich ein API-Geheimnis speichern?

Verwenden Sie einen sicheren serverseitigen Secret Manager. Committen Sie das Geheimnis niemals in ein Repository, legen Sie es nicht im Browsercode offen und nehmen Sie es nicht in Logs auf.

Was mache ich, wenn ein Schlüssel offengelegt wurde?

Rotieren oder widerrufen Sie ihn unter API-Schlüssel, ersetzen Sie ihn im Secret Store der Anwendung und prüfen Sie die jüngste Nutzung auf unerwartete Aktivitäten.

Verwandte Seiten