Erfahren Sie in diesem Artikel,
- welche Aufgaben über die Schnittstelle von der radixAPI abgedeckt werden,
- welche grundlegenden Angaben für den Zugriff auf die Schnittstelle erforderlich sind und
- wo Sie die detaillierte Dokumentation der Schnittstelle finden.
1. Einführung
Die radixAPI bietet eine Schnittstelle zur automatisierten Verarbeitung von Druckdaten, wie beispielsweise das Prüfen, Korrigieren und Konvertieren von PDF-Dateien oder das Erstellen von Vorschaubildern und Reports. Aufträge werden im Hintergrund verarbeitet. Der Status eines Auftrags kann abgefragt oder ber eine Callback-URL an ein verbundenes System bergeben werden.
Die API ist ein REST (Representational State Transfer) Service. Als Application Layer Protokoll wird HTTPS verwendet. REST vereinheitlicht die Schnittstelle zwischen den Systemen zu einem überschaubaren und standardisierten Satz von Aufrufen mit unterschiedlichen Funktionen.
Detaillierte Ausführung der technischen Beschreibung
Bitte beachten Sie, dass die detaillierten Ausführungen und Beschreibungen in englischer Sprache dokumentiert sind, da auch die Schnittstelle selbst sowie deren Antworten (Status, Fehlermeldungen und dergleichen) ausschließlich in englischer Sprache vorliegen. Eine detaillierte Beschreibung finden Sie daher im Kapitel REST-API-Documentation – radixAPI.
2. Übersicht
Nachfolgend finden Sie die grundlegenden Angaben zur Schnittstelle.
2.1. URI Schema
| Parameter | Wert |
|---|---|
| Host | radix.prepress-digital.com |
| BasePath | /api |
| Schema | HTTPS |
Für den Zugriff auf die Schnittstelle sind gültige Zugangsdaten erforderlich. Weitere Informationen dazu finden Sie im Artikel Benutzerkonto anlegen und verwalten.
2.2. Verfügbarkeit von Funktionen
Die radixAPI wird pro Benutzer lizenziert. Je nach Lizenz unterscheidet sich auch die Verfügbarkeit für API-Requests. Weitere Informationen dazu finden Sie im Artikel Lizenzierung.
2.3. Technische Dokumentation
Die verfügbaren Endpoints, Beschreibungen der Funktionen sowie Beispiele erhalten Sie in der englischen Fassung des Benutzerhandbuches im Manual REST API Documentation – radixAPI. Zusätzlich steht im Backend-UI über Open Swagger Document eine technische Beschreibung aller Endpoints zur Verfügung.
Artikel Update: radixAPI 2.4.0 – 10/2026