Entwickler-API
Rufe die Werkzeuge direkt aus deiner Software ohne Browser auf: Sende eine Anfrage, starte einen Job und lade das Ergebnis herunter. Alle Endpunkte liegen unter einer einzigen versionierten Adresse; jede Anfrage wird mit einem persönlichen Schlüssel autorisiert.
Job-Ablauf
Ein Aufruf startet einen Konvertierungsjob und liefert eine Job-ID. Mit dieser ID fragst du den Job-Status ab und lädst das Ergebnis herunter, sobald es fertig ist. Da Jobs etwas dauern können, ermöglicht diese Trennung Clients zu warten, ohne ihren Ablauf zu blockieren.
Schlüssel und Zugriff
Anfragen werden über den Header Authorization: Bearer signiert. Erstelle deinen Schlüssel in deinem Konto und widerrufe ihn jederzeit; der Klartext-Schlüssel wird nur im Moment der Erstellung angezeigt. Eine Browser-Sitzung gilt hier nicht als Autorisierung.
Werkzeuge mit offener API
| Werkzeug | API-Oberfläche | Dokument |
|---|---|---|
| KargoLabel | Konverter — POST /run | Dokument |
| Gelir-Gider Defteri | 10 Endpunkte (zustandsbehaftete App) | Dokument |
| GörselKüçült | Konverter — POST /run | Dokument |
| PdfSplit | Konverter — POST /run | Dokument |
Versionierung und Vertrag
Endpunkte sind unter https://api.pixepi.com mit /api/v1 versioniert; eine abwärtsinkompatible Änderung erfordert eine neue Version. Der maschinenlesbare Vertrag ist als OpenAPI 3.1 veröffentlicht und kann direkt in Client-Generatoren eingespeist werden.
Antworten und Fehler
Antworten befinden sich in einem JSON-Envelope; jeder Job wird über seine eigene ID abgefragt und die Berechtigung wird auf dem Server geprüft. Wenn etwas schiefgeht, liefert die Antwort einen Code, der den Zustand beschreibt; der Client übersetzt diesen Code in die eigene Sprache.
Im Detail
- Der API-Link auf der Seite des gewählten Werkzeugs öffnet dessen Endpunkte, Anfragefelder, Optionen und Fehlerverhalten.
- Maschinenlesbarer Vertrag: OpenAPI-Dokument.
- Zentrale Entwicklerseite: die gemeinsame Liste aller Endpunkte.