API-DokumentationTechnische Dokumentation

API-Dokumentation aus Ihren Endpunktbeschreibungen

Meist in 15 Minuten fertigÜberarbeitungen inklusiveQualitätsprüfung
Pakete
ZahlungsschutzMehr dazu
  • Überarbeitungen im Rahmen des Pakets sind kostenlos.
  • Reagieren Sie nicht innerhalb von 3 Tagen nach der Lieferung, gilt die Arbeit automatisch als abgenommen.

Das Geld wird bei der Zahlung reserviert und erst freigegeben, wenn Sie die Arbeit abnehmen.

API-Dokumentation aus Ihren Endpunktbeschreibungen

Beispielergebnis

Beispiel für das Standard-Paket

API-Dokumentation: eine Sendungsverfolgungs-API für Onlineshops

Schnellstart

  1. Holen Sie Ihren API-Schlüssel unter Dashboard → Settings → API keys.
  2. Senden Sie jede Anfrage mit dem Header Authorization: Bearer <your_key>.
  3. Basis-URL: https://api.trackpoint.example/v1

Sendung abrufen

GET /shipments/{tracking_number}

Liefert den aktuellen Status und den Ereignisverlauf eines Pakets.

ParameterOrtPflichtBeschreibung
tracking_numberpathjaSendungsnummer des Paketdienstes, 8–30 Zeichen
langqueryneinSprache der Statustexte: en, de, fr. Standard: en

Beispielanfrage

curl https://api.trackpoint.example/v1/shipments/JD014600006281 \
  -H "Authorization: Bearer sk_test_51x..."

Beispielantwort (200)

{
  "tracking_number": "JD014600006281",
  "status": "in_transit",
  "estimated_delivery": "2026-11-19",
  "events": [
    {"time": "2026-11-16T08:42:00Z", "location": "Leipzig hub", "status": "in_transit"}
  ]
}

Fehler

CodeBedeutungWas tun
401API-Schlüssel fehlt oder ist falschAuthorization-Header prüfen
404Sendungsnummer nicht gefundenPaketdienste brauchen bis zu 2 Stunden, um ein neues Paket zu erfassen
429Mehr als 100 Anfragen pro MinuteDie im Header Retry-After angegebene Zeit warten

Geliefert

Die Dokumentation aller 14 Endpunkte in Markdown, fertig für die Doku-Seite des Kunden, und eine Liste von 3 Stellen, an denen sich die API anders verhielt als beschrieben, für die Entwickler.

Kunde: Trackpoint, ein Start-up, dessen REST-API Onlineshops den Paketstatus anzeigen lässt; die Entwickler schickten Kurzbeschreibungen von 14 Endpunkten und eine Sammlung von Beispielanfragen Aufgabe: ein Schnellstart und eine Endpunkt-Referenz, mit denen ein Entwickler in 15 Minuten zurechtkommt; unten ein Auszug

Kunde und alle Angaben sind erfunden.

Über diese Leistung

Entwicklerinnen und Entwickler beurteilen eine API innerhalb von Minuten anhand ihrer Dokumentation: Wenn die Authentifizierung oder die erste Anfrage nicht funktioniert, sind sie weg. Wir schreiben API-Referenz und Anleitungen aus Ihren Endpunktbeschreibungen, Ihrer OpenAPI-Datei oder Codebeispielen: Authentifizierung, Basis-URLs, jeder Endpunkt mit Parametern, Beispiele für Anfragen und Antworten, Fehlercodes, Ratenbegrenzungen und Paginierung. Ein Schnellstart zeigt den ersten erfolgreichen Aufruf in wenigen Schritten.

Was enthalten ist

  • Das bekommen SieAPI-Dokumentation als Markdown mit Codeblöcken, bereit für ReadMe, GitBook, Docusaurus oder Ihr Repository. Wir schreiben aus dem, was Sie senden, und rufen Ihre API nicht selbst auf.
  • SchnellstartVom API-Schlüssel zum ersten Aufruf
  • EndpunktreferenzParameter, Typen, Beispiele
  • Fehler und LimitsCodes, Bedeutungen, Hinweise zu Wiederholungen
  • CodebeispielecURL plus eine Sprache Ihrer Wahl
  • Einheitliche BegriffeDieselben Namen wie in Ihrem Schema

So funktioniert es

  1. 1
    BriefingSie fügen Endpunkte und Beispiele ein oder hängen sie an
  2. 2
    Struktur und SchreibenWir schreiben Referenz und Anleitungen
  3. 3
    LieferungSie erhalten Markdown zum Veröffentlichen

Was wir von Ihnen brauchen

Endpunktbeschreibungen oder eine OpenAPI- oder Postman-Datei als eingefügten Text, Details zur Authentifizierung, Beispielanfragen und -antworten, Fehlercodes und wer Ihre API nutzt.

Wir fragen Sie:

  • Was macht die API, und wer nutzt sie?
  • Wie funktioniert die Authentifizierung?
  • Welche Sprache sollen die Codebeispiele neben cURL verwenden?
  • Wo wird die Dokumentation veröffentlicht?

Pakete vergleichen

PaketeBasis17 €Standard35 €Premium70 €
Was enthalten istSchnellstart und bis zu 5 EndpunkteBis zu 20 Endpunkte mit AnleitungenBis zu 50 Endpunkte, vollständige Dokumentation
Lieferzeit1 Tag3 Tage5 Tage
Überarbeitungen123
Längebis 2.000 Wörterbis 6.000 Wörterbis 14.000 Wörter
Endpunktebis 5bis 20bis 50
Sprachen der CodebeispielecURLcURL + 1cURL + 2
Bestellen BasisBestellen StandardBestellen Premium

Zahlungsschutz

Sie bezahlen bei der Bestellung, aber das Geld wird nur für abgenommene Arbeit freigegeben.

  • FestpreisDer Paketpreis ändert sich nach der Zahlung nicht mehr.
  • Das Geld wird reserviertBei der Zahlung wird der Betrag nur reserviert. Freigegeben wird er erst, wenn Sie die Arbeit abnehmen.
  • Vor der Lieferung geprüftJedes Ergebnis durchläuft eine Qualitätsprüfung, bevor es Sie erreicht, und Sie sehen es auf der Bestellseite, bevor Sie es abnehmen.
  • Kostenlose ÜberarbeitungenFordern Sie Überarbeitungen im Rahmen Ihres Briefings so oft an, wie das Paket es erlaubt.
  • Abnahme nach 3 TagenWenn Sie die Arbeit innerhalb von 3 Tagen nach der Lieferung weder abnehmen noch eine Überarbeitung anfordern, gilt sie automatisch als abgenommen. Schreiben Sie nach der Lieferung im Bestell-Chat, wartet die Bestellung; sobald wir antworten, können wir die 3 Tage neu starten und teilen das im Chat mit.
  • Neuanfertigung oder volle RückerstattungWenn das Ergebnis nicht Ihrem Briefing entspricht und die Überarbeitungen das nicht behoben haben oder die Arbeit mehr als doppelt so lange dauert wie die Frist, schreiben Sie im Bestell-Chat: Wir erstellen die Arbeit neu oder erstatten die Zahlung vollständig.
So funktioniert es →

Fragen und Antworten

Können Sie mit unserer OpenAPI-Spezifikation arbeiten?

Ja, fügen Sie das YAML oder JSON in das Briefing ein. Wir machen aus den Beschreibungen gut lesbare Referenzseiten und füllen Lücken, auf die Sie hinweisen.

Testen Sie die Beispiele?

Wir rufen Ihre API nicht auf. Die Beispiele entstehen aus Ihren Anfrage- und Antwortbeispielen, führen Sie sie daher vor der Veröffentlichung einmal aus.

Schreiben Sie SDK-Dokumentation?

Ja, wenn Sie die Methodensignaturen und Anwendungsbeispiele senden. Jedes SDK zählt zum Umfang des Pakets.

Keine Antwort gefunden?

Pakete