Für KI

Alles, was ein KI-Coding-Assistent für eine CrispHive-Integration braucht — ein fertiger Prompt, maschinenlesbare Ressourcen und die wichtigsten Fakten zur API an einem Ort.

Mit KI installieren

Fügen Sie diesen Prompt in Ihren KI-Coding-Assistenten ein, um eine Integration aufzusetzen:

Read the CrispHive backend integration skill at
https://api.crisphive.com/developers/SKILL.md and the OpenAPI spec at
https://api.crisphive.com/developers/openapi.json.

Then implement a client for my backend that:
1. Authenticates with an API key as a Bearer token (chsk_test_… for sandbox)
2. Creates a customer and a job request
3. Keeps job requests in sync by polling GET /v1/job-requests/changes
   with the next_since cursor

Jede Antwort verwendet dieselbe Envelope-Struktur — { error_code, message, errors, data } — sodass generierte Clients einen gemeinsamen Response-Parser nutzen können.

Maschinenlesbare Ressourcen

Beide Dateien werden von der API selbst ausgeliefert und entsprechen daher immer der deployten Version — verweisen Sie Ihren Assistenten direkt auf diese URLs, statt Doku-Seiten in den Kontext zu kopieren.

Ressource	Inhalt
`SKILL.md`	Ein kompakter Integrationsleitfaden für Agenten: Authentifizierung, Response-Envelope, zentrale Buchungsabläufe und typische Stolperfallen.
`openapi.json`	Die vollständige OpenAPI-Spezifikation — alle Endpunkte, Request-/Response-Schemata und Fehlercodes. Ideal zum Generieren typisierter Clients.

Wichtige Fakten für Ihren Assistenten

Die Basis-URL ist https://api.crisphive.com/v1 — Sandbox und Live nutzen dieselben Pfade; die Umgebung wird über das Schlüssel-Präfix gewählt (chsk_test_… vs. chsk_live_…).
Authentifizieren Sie jede Anfrage mit Authorization: Bearer <api key>. Schlüssel laufen nicht ab und haben vollen Zugriff — bewahren Sie sie serverseitig auf.
Ein error_code von 0 bedeutet Erfolg; alles andere ist ein Fehler, und Validierungsfehler listen Details pro Feld in errors auf.
Spiegeln Sie Daten, indem Sie GET /v1/job-requests/changes mit dem zurückgegebenen next_since-Cursor abfragen, statt Ressourcen erneut aufzulisten.
Webhooks sind noch in der Preview — setzen Sie für zuverlässige Synchronisierung vorerst auf den Change-Feed.

Tipps für bessere Ergebnisse

Lassen Sie den Assistenten zuerst SKILL.md lesen — die Datei ist klein genug für den Kontext und beantwortet die meisten Integrationsfragen ohne die vollständige Spezifikation.
Generieren Sie Request-/Response-Typen aus openapi.json, statt das Modell Feldnamen raten zu lassen.
Entwickeln Sie gegen einen Sandbox-Schlüssel (chsk_test_…) und wechseln Sie erst zu Live, wenn alle Abläufe durchgehend funktionieren.
Prüfen Sie beim Debuggen den error_code — nicht nur den HTTP-Status.