Leistungsbeschreibung crystalworks.api
Diese Leistungsbeschreibung gilt ab crystalworks.api Version 2.0 und konkretisiert den Leistungsumfang des Produkts crystalworks.api (Standard) in der jeweils in der API-Dokumentation ausgewiesenen Version. Sie gilt ergänzend zur Auftragsbestätigung und zu den vertraglichen Vereinbarungen zwischen AEB IT-SYSTEME GmbH und dem Kunden.
1. Produkt und Leistungsumfang
crystalworks.api ist die REST-Schnittstelle der Warenwirtschaft crystalworks. Sie stellt dem Kunden den Zugriff auf Daten und definierte Funktionen seiner eigenen crystalworks.-Installation bereit — für eigene Auswertungen, Anbindungen (z. B. Webshop, Marketing) und Anwendungen. Maßgeblich ist der in der API-Dokumentation (api.crystalworks.de) ausgewiesene Umfang der jeweiligen Version.
crystalworks.api wird in zwei Ausbaustufen angeboten:
- crystalworks.api basic — lesender Zugriff (unidirektional) auf die grundlegenden Datenbereiche gemäß Kennzeichnung in der API-Dokumentation.
- crystalworks.api full — Zugriff auf alle dokumentierten Standard-Endpunkte einschließlich des Schreibkanals (Änderungsaufträge).
Die gebuchte Ausbaustufe ergibt sich aus der Auftragsbestätigung. Diese Leistungsbeschreibung gilt für beide Ausbaustufen. Für den Betrieb eigener oder durch Dritte entwickelter Anwendungen mit erweiterten Zusagen besteht mit crystalworks.api enterprise ein eigenständiges Vertragsmodell (siehe Ziffern 3, 4 und Übersicht am Ende).
In beiden Ausbaustufen enthalten sind drei (3) API-Zugänge, die der Kunde selbst einrichtet und verwaltet — einschließlich der Vergabe von Berechtigungen je Endpunkt und Zugang.
Der schreibende Zugriff (nur crystalworks.api full) erfolgt über Änderungsaufträge (Requests-Kanal). Derzeit umfasst er das Anlegen von Artikel-Reservierungen. Mit Version 2.1 wird der Kanal auf benannte Auftragstypen ausgebaut (u. a. Aktualisierung von Kundenstammdaten); der Reservierungs-Auftrag bleibt dabei durchgehend nutzbar.
Weitere Auftragstypen — insbesondere solche mit Beleg-, Bestands- oder Kassenwirkung — sowie zusätzliche Zugänge und Datenbereiche sind nicht Bestandteil dieses Produkts; sie sind dem Vertragsmodell crystalworks.api enterprise vorbehalten (siehe Ziffern 3, 4 und Übersicht).
2. Dokumentation
Maßgebliche technische Referenz ist die jeweils aktuelle API-Dokumentation unter api.crystalworks.de einschließlich der dort ausgewiesenen Version. Die Dokumentation beschreibt den Standard-Funktionsumfang; einzelne dort nicht aufgeführte Funktionen können produktiv deaktiviert sein.
Funktionen und Endpunkte, die technisch erreichbar, aber nicht Bestandteil der gebuchten Ausbaustufe bzw. nicht in der Dokumentation ausgewiesen sind, stehen nicht zur Nutzung zur Verfügung; aus ihrer technischen Erreichbarkeit entstehen keine Nutzungs- oder Bestandsansprüche. AEB kann solche Funktionen jederzeit ohne Ankündigung ändern oder deaktivieren.
3. Weiterentwicklung und Änderungen
Die API wird laufend weiterentwickelt. Änderungen an Endpunkten, Feldern und Verhalten werden in der Dokumentation und über die Versionskennzeichnung ausgewiesen. Eine Kompatibilitäts- oder Bestandszusage für einzelne Endpunkte oder Feldstrukturen besteht im Rahmen dieses Produkts nicht; individuelle Anpassungen oder Erweiterungen der Endpunkte sind nicht Bestandteil. Für den produktiven Betrieb eigener Anwendungen mit Versionierungs- und Kompatibilitätszusagen sowie projektbezogener Individualisierung der Endpunkte bietet AEB eine gesonderte Vereinbarung an (crystalworks.api enterprise).
4. Nutzung durch beauftragte Dritte
Der Kunde darf die bereitgestellten Zugänge im Rahmen von Ziffer 1 auch durch von ihm beauftragte Dienstleister nutzen lassen. Diese Nutzung erfolgt in Verantwortung und auf Risiko des Kunden. Nicht Bestandteil dieses Produkts sind: Support und technische Abstimmung gegenüber Dritten, Kompatibilitäts- und Versionierungszusagen für Anwendungen Dritter, die Bereitstellung von Zugriffsprotokollen sowie Zugänge über das Kontingent von drei hinaus. Diese Leistungen sind Bestandteil von crystalworks.api enterprise.
5. Von AEB erbrachte Integrationen
Anbindungen an Drittsysteme, die AEB im Auftrag des Kunden konzipiert, umsetzt und betreut (z. B. CRM-, Webshop- oder Marketing-Anbindungen), sind nicht Bestandteil dieses Produkts. Sie werden als eigenständige Integrationsleistungen projektbezogen vereinbart und abgerechnet; Umfang, Betrieb und Pflege ergeben sich aus der jeweiligen Vereinbarung.
6. Nutzungsgrenzen (Fair Use)
Zum Schutz des Betriebs gelten Nutzungsgrenzen je Zugang (Rate Limits). Die derzeit gültigen Fair-Use-Grenzen betragen 60 Anfragen pro Minute und 10.000 Anfragen pro Tag je Zugang; die jeweils aktuellen Werte sind in der API-Dokumentation ausgewiesen. Die Grenzen sind so bemessen, dass die übliche Nutzung nicht eingeschränkt wird; bei Überschreitung antwortet die API mit dem Statuscode 429. Dauerhaft erhöhter Bedarf (z. B. Massenabrufe, Synchronisation großer Datenmengen, Lasttests) ist vorab mit AEB abzustimmen; erweiterte Grenzen sind Bestandteil von crystalworks.api enterprise.
7. Support
Der Support umfasst Fragen des Kunden zur Nutzung der dokumentierten Endpunkte im Rahmen des bestehenden Wartungsvertrags. Nicht umfasst sind die Entwicklung, Fehleranalyse oder Betreuung von Anwendungen des Kunden oder Dritter, die auf der API aufsetzen.
8. Verfügbarkeit und Betrieb
Die API wird auf der von AEB betriebenen Infrastruktur bereitgestellt. Wartungsfenster werden, soweit möglich, außerhalb der üblichen Geschäftszeiten gelegt. Eine bestimmte Verfügbarkeit wird im Rahmen dieses Produkts nicht zugesichert.
Bereitgestellt wird ausschließlich die Produktivumgebung. Der Betrieb einer zusätzlichen Test-/Staging-Umgebung (eigener API-Stand mit eigenem Datenbestand, z. B. für die Entwicklung eigener Anwendungen) ist nicht Bestandteil dieses Produkts und crystalworks.api enterprise vorbehalten.
Übersicht: crystalworks.api (basic / full) und crystalworks.api enterprise
| crystalworks.api basic / full | crystalworks.api enterprise | |
|---|---|---|
| Endpunkt-Umfang | basic: grundlegende Datenbereiche · full: alle dokumentierten Standard-Endpunkte | Standard-Endpunkte + zusätzliche Datenbereiche und Bausteine nach Leistungsanhang |
| Zugänge | 3, Selbstverwaltung inkl. Berechtigungen je Endpunkt | über 3 hinaus, je Anwendung |
| Umgebung | geteilte Standard-Infrastruktur | dedizierte Instanz möglich |
| Test-/Staging-Umgebung | nicht Bestandteil — nur Produktivumgebung | zusätzliche Staging-Umgebung mit eigenem Datenbestand, nach Vereinbarung |
| Schreibzugriff | basic: keiner (lesend) · full: Änderungsaufträge — derzeit Artikel-Reservierungen, ab Version 2.1 benannte Standard-Auftragstypen | zusätzliche Auftragstypen inkl. Beleg-/Bestandswirkung, projektbezogen |
| Weiterentwicklung durch AEB (Stabilität der Endpunkte) | Änderungen jederzeit ohne Vorankündigung möglich | Versionierungszusage, Ankündigung mit Vorlaufzeit, Migrationsbegleitung |
| Individualisierung der Endpunkte | nicht Bestandteil | projektbezogen mit AEB |
| Nutzung durch Dienstleister | zulässig, auf Risiko des Kunden | vertraglich getragen inkl. Support und Abstimmung |
| Support gegenüber Entwicklern Dritter | nicht Bestandteil | Bestandteil (nach Vereinbarung) |
| Zugriffsprotokolle | keine Bereitstellung — Herausgabe nur in begründeten Ausnahmefällen (z. B. Sicherheitsvorfall, gesetzliche Pflicht) | Auskunft auf Anfrage |
| Nutzungsgrenzen | 60/min, 10.000/Tag je Zugang | erweitert nach Vereinbarung |
| Verfügbarkeit / Service Level | keine Zusicherung | nach Vereinbarung |
| Dokumentation | Standard-Dokumentation auf api.crystalworks.de | zusätzlich individuelle Dokumentation der projektbezogenen Erweiterungen, nach Vereinbarung |
crystalworks.api enterprise wird als eigenständige Vereinbarung mit Leistungsanhang geschlossen — sprechen Sie uns an.
AEB IT-SYSTEME GmbH · Adam-Höfle-Weg 3 · 64673 Zwingenberg · info@aebit.de · crystalworks.de