API Url

Die MeinEinkauf.ch Partner API ist unter folgender URL erreichbar:

https://api.meineinkauf.ch/v1/

Authentifizierung

Jeder Request an die MeinEinkauf.ch Partner API muss authentifiziert werden. Hierfür nutzen wir die HTTP Basic authentication. Der Benutzername lautet immer api und das Passwort ist der von uns für Sie bereitgestellte API-Schlüssel.

Testen

Test API Key

Um die Requests bei der Implementierung der API in Ihren Online-Shop zu testen, können Sie als API-Schlüssel den Wert MEINEINKAUF_TEST_API_KEY nutzen. Ihre übermittelten Daten werden dann unter realen Bedingungen validiert. Die Antworten (inklusive eventueller Fehlermeldungen) der API sind ebenfalls identisch zu realen Aufrufen. Die übermittelten Test-Daten werden von uns allerdings nicht gespeichert.

Test System

Zusätzlich zum Testen mittels Test API Key stellen wir ein Test-System bereit. Nachdem wir Ihnen einen Zugang auf dem Test-System eingerichtet haben, werden die übermittelten Daten gespeichert. Dieses ist unter folgender URL erreichbar:

https://api-test.meineinkauf.ch/v1/

Dieses System ist ein Klon des Produktiv-Systems, welches als Sandbox dient. Die Verarbeitung der Bestellungen wird auf dem Test System simuliert. Die Routinen laufen alle 15 Minuten und sorgen dafür, dass jede Bestellung die verschiedenen Status durchläuft und Sie so den kompletten Prozess durchtesten können.

Der erste Request

Für einen einfachen Einstieg haben wir einen simplen Echo-Endpunkt implementiert. Dieser Endpunkt liefert einen übermittelten Parameter wieder zurück, hierüber kann z.B. die Authentifizierung getestet werden.

Aufruf:

curl https://api.meineinkauf.ch/v1/echo/HelloWorld \
  -X GET \
  -u 'api:MEINEINKAUF_TEST_API_KEY'

Antwort:

{
    "echo": "HelloWorld",
    "errors": [],
    "success": true,
    "testMode": true
}

HTTP Status Codes

  • 200 OK - Der Request war erfolgreich.
  • 201 Created - Die übermittelten Daten wurden erfolgreich verarbeitet und es wurde zum Beispiel eine Bestellung erstellt.
  • 400 Bad Request - Der Endpunkt existiert nicht oder wurde mit einer falschen HTTP-Methode aufgerufen.
  • 401 Unauthorized - Der Request konnte nicht authentifiziert werden.
  • 422 Unprocessable Entity - Die übermittelten Daten waren nicht valide.
  • 500 Internal Server Error - Es gab ein Problem auf unserer Seite und wir arbeiten schnellstmöglich an einer Lösung. Die übermittelten Daten wurden in der Regel nicht verarbeitet und ihr System muss den Request zu einem späteren Zeitpunkt erneut senden.
  • 503 Service Unavailable - Während planmäßiger Wartungsarbeiten wird dieser Status zurückgegeben. Die übermittelten Daten wurden nicht verarbeitet und ihr System muss den Request zu einem späteren Zeitpunkt erneut senden.

API Error Codes

  • E0000 ApiKey is missing - Sie haben keinen ApiKey angegeben.
  • E0001 Unknown ApiKey - Der angegebene ApiKey ist unbekannt.
  • E1000 Invalid JSON - Die übermittelten Daten sind nicht valide. Eine detaillierte Fehlermeldung wird ebenfalls zurückgegeben.
  • E1001 No order found for given ordernumber - Die angegebene Bestellung existiert nicht.
  • E1002 No return consignment found for given reference - Die angegebene Retoure existiert nicht.