Erstellen von Personalisierungsanfragen
Die REST-API kann dazu verwendet werden, um Personalisierungsvorgänge direkt mit einem bestimmten Artikel und Personalisierungsdaten zu starten. Hierbei kann die Art des Dokuments (Softproof oder Produktionsdatei) und auch die Art der Rückgabe festgelegt werden.
Endpunkt zur Ausführung von Personalisierungsvorgängen
noneÜbersicht der verfügbaren Parameter
Parameter | Typ | Beschreibung |
|---|---|---|
| int | Eindeutige ID eines Artikels aus der PRINT LOUNGE |
| string | Artikelnummer eines Artikels aus der PRINT LOUNGE Diese Artikelnummer muss eindeutig sein und darf nur einem Artikel zu gewiesen werden. Es kann entweder eine articleNumber oder articleId genutzt werden. |
| int (optional) | Eindeutige ID eines Benutzers aus der PRINT LOUNGE Diese Angabe ist optional. Wird keine ID eines existierenden Shop-Benutzers übergeben, wird automatisch ein temporärer Benutzer ohne eigene Daten angelegt, für den Personalisierungsprozess genutzt und anschließend automatisch gelöscht. |
| array | Personalisierungsdaten als Array |
| string | Auswahl aus Softproof- (“softproof”) oder Produktionsdatei (“print”) |
| string | Auswahl der Art der Rückgabe (“file” gibt die PDF-Datei direkt als binary-file zurück, “download” erzeugt einen öffentlich zugänglichen Download-Link, “api-download” ermöglicht den Abruf der Datei über die API) Nach abgeschlossenem Download wird die temporär erzeugte Datei gelöscht. |
Rückgabe / API-Response
Die Rückgabe ist abhängig von der angeforderten Art der Rückgabe (siehe response-Parameter).
Im Erfolgsfall wird die Response immer mit dem Status “200 OK” zurückgegeben, im Fehlerfall wird immer ein JSON-Objekt mit dem Status “422 Unprocessable Content” zurückgegeben, welches die aufgetretenen Fehlermeldungen als Array enthält.
Rückgabe bei “file”
Im Erfolgsfall wird die erzeugte Datei als binary-file zurückgegeben und kann gespeichert werden.
Rückgabe bei “download”
Im Erfolgsfall wird der Download-Link zurückgegeben.
Beispiel-Response:
Rückgabe bei “api-download”
Im Erfolgsfall wird der Download-Key zurückgegeben, welcher zur Abholung der Datei über die REST-API genutzt werden kann.
Beispiel-Response:
Abruf von Personalisierungsdaten als Download
Wenn ein Download-Key über die Personalisierungsanfrage erzeugt wurde (siehe response-Parameter mit dem Wert “api-download”), kann die erzeugte Datei über die API abgerufen werden. Hierzu muss lediglich der Download-Key über den Endpunkt übergeben werden.
Endpunkt zum Download von erzeugten Personalisierungsdaten
none