SDK-Status
Wählen Sie die stabile REST API oder testen Sie Preview-Clients, die nur als Quellcode vorliegen, ohne von einer Verfügbarkeit in einer Registry auszugehen.
Wählen Sie die stabile REST API oder testen Sie Preview-Clients, die nur als Quellcode vorliegen, ohne von einer Verfügbarkeit in einer Registry auszugehen.
Die versionierte REST API ist derzeit die unterstützte öffentliche Integrationsschnittstelle. Der Quellcode für JavaScript-, Python- und Framework-Clients liegt im Produkt-Repository vor, die Pakete sind aber aktuell weder auf npm noch auf PyPI veröffentlicht.
Verfügbarkeit#
| Client | Status | Verwendung |
|---|---|---|
| REST über HTTPS | Verfügbar | Rufen Sie https://makeagent.fast/api/v1 von einem beliebigen serverseitigen HTTP-Client aus auf |
| OpenAPI-Dokument | Verfügbar | Laden Sie /api/openapi.json herunter und prüfen Sie es, bevor Sie einen Client generieren |
@make-agent-fast/sdk | Quellcode-Preview – nicht auf npm | Fügen Sie diesen Import erst dann zu einem Produktivprojekt hinzu, wenn hier ein Registry-Release verlinkt ist |
Python-Paket makeagentfast | Quellcode-Preview – nicht auf PyPI | Verwenden Sie requests, httpx oder die Python-Standardbibliothek, bis hier ein PyPI-Release verlinkt ist |
| React-, Vue- und Svelte-Adapter | Quellcode-Preview – nicht auf npm | Verwenden Sie bevorzugt das dokumentierte Script-Loader-Muster für das jeweilige Framework |
| Web Component | Quellcode-Preview – nicht auf npm | Verwenden Sie bevorzugt den Standard-Loader embed.js |
JavaScript ohne SDK#
const response = await fetch("https://makeagent.fast/api/v1/sites?limit=100", {
headers: {
Authorization: `Bearer ${process.env.MAF_API_KEY}`,
Accept: "application/json",
},
});
const body = await response.json();
if (!response.ok) {
console.error(body.error.code, body.error.request_id);
throw new Error(`Make Agent Fast request failed (${response.status})`);
}
for (const site of body.data) console.log(site.id, site.title);Bewahren Sie den API-Schlüssel ausschließlich auf dem Server auf. Ein Browser-Bundle mit React, Vue oder Svelte sollte Ihr eigenes Backend aufrufen oder den öffentlichen Embed-Loader einbinden; es sollte die Management-API nicht mit einem Secret aufrufen.
Python ohne SDK#
import json
import os
import urllib.request
request = urllib.request.Request(
"https://makeagent.fast/api/v1/sites?limit=100",
headers={
"Authorization": f"Bearer {os.environ['MAF_API_KEY']}",
"Accept": "application/json",
},
)
with urllib.request.urlopen(request, timeout=20) as response:
payload = json.load(response)
for site in payload["data"]:
print(site["id"], site["title"])Fangen Sie in der Produktion urllib.error.HTTPError ab und werten Sie den JSON-Body mit dem stabilen Fehler-Envelope aus.
Generierte Clients#
Die Generierung aus OpenAPI ist nur dann sinnvoll, wenn das Dokument die Operationen und Schemas enthält, auf die Ihre Anwendung angewiesen ist. Fixieren Sie die heruntergeladene Spezifikation, generieren Sie in ein überprüfbares Verzeichnis und prüfen Sie vor jedem Upgrade jeden Diff.
curl --fail-with-body https://makeagent.fast/api/openapi.json \
--output make-agent-fast.openapi.jsonGenerieren und deployen Sie einen Client nicht automatisch von der Live-URL aus neu. Ein neues, additives Feld sollte einen Client nicht beschädigen, aber das Verhalten des Generators und die generierten Methodennamen können sich dennoch ändern.
Was ein öffentlicher SDK-Release enthalten muss#
Bevor ein Preview-Client als verfügbar gekennzeichnet wird, muss er Folgendes bieten:
- Eine öffentliche Registry-Seite und eine unveränderliche semantische Version.
- Anleitungen zu Installation, Upgrade und unterstützten Laufzeitumgebungen.
- Typisierte Request- und Response-Modelle, die aus dem vollständigen API-Vertrag generiert wurden.
- Strukturierte Fehler, die den HTTP-Status und die Request-ID beibehalten.
- Paginierungs-Helfer, die Cursor als opak behandeln.
- Explizite Unterstützung von Idempotency-Keys für Mutationen.
- CI-Tests gegen den aktuellen
/api/v1-Vertrag und ein veröffentlichtes Changelog.
Solange diese Bedingungen nicht erfüllt sind, verwenden Sie die REST-Beispiele im API-Schnellstart und in den API-Rezepten.