Einleitung

Die MeinEinkauf.ch Partner API richtet sich an Online Händler und Entwickler, welche vertraut damit sind, eine RESTful API in Eigenentwicklung an den eigenen Online Shop anzubinden. Für gängige Shop-System werden wir in Zukunft Plugins zur vereinfachten Integration bereitstellen.

SSL

Da unter anderem sensible Kundendaten über die API gesendet werden, ist es erforderlich, dass sämtliche Requests per SSL verschlüsselt sind. Meineinkauf.ch bietet ein gültiges und signiertes SSL-Zertifikat. Jegliche API-Requests, die nicht per SSL an uns übermittelt werden, werden von unserer API nicht entgegengenommen.

REST

Die MeinEinkauf.ch Partner API ist nach dem REST-Paradigma aufgebaut. Auch wenn es keinen definierten REST-Standard gibt, gibt es Ansätze und Best-Practises welche genutzt werden um den Umgang mit RESTful APIs zu vereinheitlichen und zu vereinfachen. Um mit den einzelnen API-Endpunkten zu interagieren, werden die Standard HTTP Methoden POST, GET, PUT und DELETE genutzt. Für diese Operationen wird auch das Akronym CRUD (Create, Read, Update, Delete) verwendet. Mehr Informationen zum Thema REST finden sie hier.

JSON

Die MeinEinkauf.ch Partner API unterstützt einzig JSON als Format zum Austausch von Daten. Übermittelte Daten müssen validem JSON entsprechen. Die Antworten der API erfolgen ebenfalls im JSON-Format.

Verfügbarkeit

MeinEinkauf.ch legt sehr großen Wert auf eine höchstmögliche Verfügbarkeit der API. Unsere IT-Systeme sind mit modernsten Techniken aufgesetzt, welche eine hohe Verfügbarkeit garantieren. Allerdings müssen auch planmäßige Wartungsarbeiten am System durchgeführt werden. Wir sind stets bemüht die Wartungsarbeiten möglichst kurz zu halten. Wärend der Wartungsarbeiten ist die API nicht erreichbar. In dem Fall wird der HTTP-Status-Code 503 Service Unavailable zurückgegeben. Ihr System muss den Request dann zu einem späteren Zeitpunkt nochmal ausführen. Mehr Informationen zu den möglichen HTTP Status Codes finden Sie hier.