API-Zugriff und -Integration für Entwickler
Die API-Integration erfordert eine Authentifizierung und einen klaren Vertrag.
Was Sie lernen werden
- Erklären Sie: Überprüfen Sie den Zugriff vor der Verwendung
- Wenden Sie die Idee in einem Beispiel an: API-Zugriff und -Integration für Entwickler
- Erkennen Sie Einschränkungen und überprüfen Sie das Übungsergebnis
Die API-Integration erfordert eine Authentifizierung und einen klaren Vertrag. Passen Sie Transportbeispiele an die Dokumentation für die installierte Version an.
Diese Schritte beziehen sich auf im Anwendungscode identifizierte Funktionen. Dieses Material wurde nicht in einer Live-Instanz validiert; Überprüfen Sie die Dokumentation und die Optionen in Ihrer Version.
Wie es funktioniert, Schritt für Schritt
Vertrags- und Beispieldaten
Dokumentanforderungsziel, Konversations-ID, Zeitüberschreitung und Stream-Verbrauch. Konsultieren API-Dokumentation für Endpunkte und Schemata. Verwenden Sie keinen generischen Körper für Playground, Chat und RAG wieder: Ihre Verträge können unterschiedlich sein. Das folgende Minimalbeispiel veranschaulicht die Absicht und nicht eine garantierte HTTP-Nutzlast.
Das erklärende Schaubild
Folgen Sie den durchgezogenen Pfeilen für den Hauptfluss. Gestrichelte blaue Pfeile liefern Daten oder Kontext; Gestrichelte rosa Pfeile zeigen Feedback oder zurückgegebene Ergebnisse an. Farben und Formen unterscheiden Modelle, Geschäfte, Entscheidungen und Ergebnisse. Scrollen Sie auf kleinen Bildschirmen horizontal, um das gesamte Schaubild zu verfolgen.
Ein vollständiges Beispiel
Ihr Backend ruft den Chat mit dem Ziel und dem Organisations-/Projektkontext auf, liest den Stream und behandelt Fehler. Geheimnisse bleiben im Backend, nicht im Browser.
{"intent":"ask_policy","target":"fictional-agent","question":"What is the return deadline?"}
Probieren Sie es selbst aus
- Öffnen Sie die API-Dokumentation und überprüfen Sie Header, Text und Antwortschema vor dem Aufruf.
- Notieren Sie die Eingabe, die Quelle und das erwartete Ergebnis, bevor Sie das Experiment durchführen. Verwenden Sie im Beispiel nur die fiktiven Daten.
- Folgen Sie den Diagrammschritten. Notieren Sie bei jedem Schritt, welche Informationen empfangen und produziert werden. Verwechseln Sie Zwischenergebnisse nicht mit Endergebnissen.
- Wiederholen Sie den Vorgang, nachdem Sie erforderliche Informationen entfernt oder die Eingabe mehrdeutig gemacht haben. Prüfen Sie, ob das System eine Antwort klärt, stoppt oder erfindet.
- Vergleichen Sie mit der erklärten Lösung. Bewahren Sie die Konfiguration, das Datum, das Ergebnis und eine Erklärung für Unterschiede auf. Ändern Sie eine Sache und testen Sie es erneut.
Eine erklärte Lösung
Der Client unterscheidet zwischen endgültiger Antwort, Zeitüberschreitung und Zugriffsverweigerung, ohne den Schlüssel preiszugeben. Mit einer erfolgreichen Übung können Sie den Zusammenhang zwischen Input, Phasen und Ergebnis aufzeigen. Bei fehlenden Informationen ist eine vorsichtige Antwort sinnvoller als erfundene Details. Vergleichen Sie mehr als nur Stil: Überprüfen Sie auch Bedingungen, Quellen und Vorgänge.
Wann dieser Ansatz hilft und wo seine Grenzen liegen
Ein Bereitstellungs-MCP-Schlüssel ist nicht automatisch ein Organisations-API-Schlüssel. Wählen Sie diesen Ansatz, wenn er einen gemessenen Bedarf verbessert. Behalten Sie eine einfache Ausgangsbasis bei und vergleichen Sie die Ergebnisse mit identischen Eingaben. Ein erfolgreiches Beispiel stellt nicht in jeder Situation Verlässlichkeit dar.
Überprüfen Sie Ihr Wissen
Warum wird eine private Quelle nach einer zu späten Antwort entfernt?
Die Daten sind bereits in den Modellkontext eingetreten und können offengelegt werden.
Wer führt einen vom Modell vorgeschlagenen Aufruf aus?
Die Anwendung oder der Hostdienst nach der Validierung. Das Modell erhält nicht automatisch uneingeschränkten Zugriff.
Zu welchem Ergebnis soll diese Übung führen?
Der Client unterscheidet zwischen endgültiger Antwort, Zeitüberschreitung und Zugriffsverweigerung, ohne den Schlüssel preiszugeben.
Wichtige Begriffe
- Autorisierung / Autorisierung: Überprüfung des Zugriffsrechts auf einen Vorgang oder eine Ressource.
- Werkzeugaufruf: Eine strukturierte Anfrage zur Nutzung einer externen Funktion.
- Idempotenz: Kontrollierte Wiederholung ohne Duplizierung eines Effekts.
Quellen und Ihr nächster Schritt
Zur Vorbereitung: U05 – Ein KI-Widget auf Ihrer Website