API Dokumentation und Zugriff

Shore Kasse stellt dir eine API zur Verfügung, über die du jederzeit Produkt- und Rechnungsdaten abrufen und schreiben kannst. Systeme anderer Anbieter können somit einfacher angebunden werden. Die Möglichkeiten sind somit vielseitig.

Wo finde ich die Dokumentation?

Du findest die Dokumentation unter diesem Link.

Wie erhalte ich Zugriff?

Melde dich mit deinem Shore Kassenaccount im Kassenmanager an.

• Klicke links im Menü auf den Punkt Einstellungen > Allgemein und anschließend auf Api & Apps.
• Vergebe zunächst einen Namen für deinen Zugang und Klicke anschließend auf das +.

• Du erhältst nun Client_ID und Client_Secret.
• Tippe nun auf Token Generieren / Generate New Token.
• Gebe nun an welche Rechte derjenige haben soll, der den Token verwenden wird. 

• Klicke nun auf Speichern.
• Du erhältst nun den Access_Token, den du künftig zur Autorisierung bei Abfragen benötigst.

Alles Weitere zur Authentifizierung erfährst du in der Dokumentation.

Wichtig bei der API-Integration

Bitte verwende immer die aktuelle API-Version. Bei der Verwendung einer älteren Version kann es zu fehlenden oder fehlerhaften Datenübertragungen kommen.

Achte außerdem darauf, dass der Access Token regelmäßig erneuert wird. Verwende dafür den Refresh Token, um einen neuen Access Token zu erhalten. Ein abgelaufener Access Token kann ebenfalls dazu führen, dass Daten nicht oder nicht vollständig übertragen werden.

FAQ: payment_method und external_payment_method

Was ist der Unterschied zwischen payment_method und external_payment_method?

Für die Integration ist nur payment_method relevant.

• payment_method gibt die tatsächliche Zahlungsart an.
• external_payment_method wird ausschließlich intern verwendet und kann von der Integration ignoriert werden.

Welche Werte kann payment_method enthalten?

payment_method kann nicht als beliebiger Text/String übergeben werden. Es muss einer der vorgegebenen Werte verwendet werden:

Hinweis: Bei Webshop-Bestellungen sollte für eine Banküberweisung BANK_TRANSFER (6) zusammen mit dem entsprechenden Order Channel Webshop verwendet werden.

Kann external_payment_method für Zahlungsdienstleister wie Stripe verwendet werden?

Nein. external_payment_method ist nicht dafür vorgesehen, den verwendeten Zahlungsdienstleister (z. B. Stripe) zu kennzeichnen. Das Feld ist ausschließlich für interne Zwecke gedacht und sollte bei einer Integration ignoriert werden.

Können Stripe-Zahlungen über die API synchronisiert werden?

Das Feld external_payment_method kann dafür nicht verwendet werden. Insbesondere kann nicht folgende Kombination verwendet werden:

payment_method = Card external_payment_method = Stripe

payment_method muss stattdessen einen der oben genannten vordefinierten Werte enthalten.

Was ist mit Apple Pay, Google Pay oder PayPal über Stripe?

Auch in diesem Fall soll external_payment_method nicht verwendet werden, um Stripe oder die darüber abgewickelte Zahlungsart zu übermitteln. Das Feld kann bei der Integration vollständig ignoriert werden.

Warum gibt es dann external_payment_method?

Das Feld wird intern von Shore verwendet. Es ist nicht als Integrationsfeld zur Übermittlung eines externen Payment Service Providers vorgesehen.

Für die Integration gilt daher:

• payment_method = tatsächliche Zahlungsart
• external_payment_method = ignorieren

Dadurch wird sichergestellt, dass die Zahlungsart in Shore korrekt erfasst und ausgewertet werden kann.

Gibt es eine Testumgebung?

Eine Testumgebung bieten wir aktuell nicht an.

Für Testzwecke könnt ihr auf Entwicklerseite jedoch einen eigenen Mock-Server bzw. eine API-Simulation aufsetzen – also eine Mock-API, die dieselben Endpunkte und Antwortstrukturen wie die echte API liefert.

Beispiel-Tools dafür u. a.:

• Postman Mock Server
• Mockoon
• WireMock