Einführung

Die API-Schnittstelle ist ab Version 7.1.0 verfügbar.

Die API-Schnittstelle des Printshops ermöglicht einen automatisierten, maschinengeeigneten Zugriff auf Daten aus des Printshops. Dies ermöglicht eine Integration in interne Prozesse und Tools. Die API ist ein zusätzliches Modul und kann für jeden Mandanten aktiviert werden. Für die Nutzung sind keine speziellen Pakete oder Optionen erforderlich. Die verfügbaren Daten entsprechen den Daten aus dem Printshop. Auf dieser Seite werden generelle API-Informationen bereitgestellt. Der Abruf von Printshop-Daten geschieht über ihre Shop URL.

API-Authentifizierung

Die Authentifizierung erfolgt durch eine Basic-Authentication. Hierfür werden API-Benutzer und API-Key übermittelt.

Der API-Benutzer/API-Key kann in der Administration unter Module → API Einstellungen gesetzt werden.

Der API-Benutzer/API-Key muss bei allen Abfragen übermittelt werden. Geschieht dieses nicht oder werden ungültige API-Daten verwendet, meldet die API den Fehlercode „401 Unauthorized“. Um API-Daten zu erhalten, kontaktieren Sie bitte Ihren Shopbetreiber.

Wird bei der Authentifizierung mehrfach ein falsches Passwort verwendet, wird der Zugriff für 15 Minuten gesperrt. Nach der Sperrzeit ist keine manuelle Freischaltung notwendig, dies passiert automatisch und kann anschließend wieder verwendet werden.


Cart / Bestellposten

Verfügbare Daten

HTTP-MethodeDomainDatenParameterBeispiel Rückgabe
GET{{domain}}/api/component/Cart/{{jobnummer}}Cart / Bestellposten-

{
    "shippingAddress": {
        "company""Musterfirma",
        "firstname""Max",
        "lastname""Mustermann",
        "street""Musterweg 1",
        "zip""12345",
        "city""Musterhausen",
        "country""DE",
        "mail""max@musterman.de",
        "phone""1234567890"
    },
    "deliveryDate""2022-06-14"
}


Ausgabe Format

Alle Anfragen und Rückgabewerte sind UTF-8 kodiert. Standardmäßig erfolgt die Rückgabe der API-Schnittstelle im Json-Format.

Tracking Daten

Verfügbare Daten

HTTP-MethodeDomainDatenRequest BodyBeispiel Rückgabe
GET{{domain}}/api/component/Cart/{{jobnummer}}/TrackingTracking

{
     "id""123",

     "url""http://example.org/123",
     "shippingServiceProvider""example"
}

POST{{domain}}/api/component/Cart/{{jobnummer}}/TrackingTracking

{
    "id""123",
    "url""http://example.org/123",
    "shippingServiceProvider""example"
}



Ausgabe Format

Alle Anfragen und Rückgabewerte sind UTF-8 kodiert. Standardmäßig erfolgt die Rückgabe der API-Schnittstelle im Json-Format.

Eingabe Format

Der Request Body wird vom System UTF-8 kodiert sowie in einem Json-Format erwartet.