Informationen zur API

Infos zur API

Hier findest du Informationen über die API/Schnittstelle und wie du diese ganz leicht auf unserer Website beantragen kannst.

Wozu dient API?

API ist die Kurzform von “Application-Programming-Interface”. Sie ist eine Schnittstelle über die mehrere Apps/Webseiten miteinander kommunizieren und Informationen austauschen können.

Wie wird eine Schnittstelle erschaffen?

Eine API ist eine offene Schnittstelle, die dazu dient, verschiedene Apps, Programme und Programm-Sprachen miteinander zu verbinden. Dies dient der Kommunikation und handelt von Informationen zwischen diesen verschiedenen Programmen. Die Informationen werden in einem sogenannten JSON-Format ausgetauscht (das eine Programm stellt die Frage und der andere antwortet mit dem Wert)

Was ist ein Developer-Token ?

Developer- und Account-Token sind ready2order spezifisch und werden für die Authentifizierung des Klienten benötigt. Sie dienen als “Geheimwort” zwischen dem Kunden und ready2order, um die Echtheit der Anfragen über die API gewähren zu können.

Der Developer-Token wird für den “API Integrator” benötigt. Mit Hilfe dieses Token können Account-Token erstellt werden. Ein API Integrator ist nicht an einen Account gebunden und kann Account-Token in unterschiedlichen Accounts von unterschiedlichen Kunden erstellen, vorausgesetzt, er bekommt die Erlaubnis dazu. Man kann sich einen Dienstleister vorstellen, der für unterschiedliche Unternehmen die Webshops betreut.

Was ist der Account-Token ?

Der Account-Token dient der Identifikation. Er wird für die Abfragen von Daten eines bestimmten Accounts benötigt.

Mit welcher Software ist die r2o API kompatibel/lässt sich verbinden?

Für PHP und NodeJS stellen wir offizielle Bibliotheken zur API-Kommunikation zur Verfügung.

Wie ist der Weg von der Beantragung bis zur Herstellung eines Zugangs?

API Beantragung auf der Website

  1. Besuche unsere ready2order Website
  2. Scrolle ganz nach unten. Unter "Ressourcen" findest du den Link zur API
  3. Hier kannst du den API Zugang beantragen 
  4. Fülle alle notwendigen Informationen aus
  5. Der Developer-Token wird via E-Mail an den Antragsteller, also dich, gesendet
  6. Danach folgt die Anmeldung beim Account. Mit Hilfe eines Links in der E-Mail wird ein Account-Token erzeugt.
  7. API Abfragen können mit Account-Token erstellt werden.
Es ist wichtig, dass du einen Account bei ready2order hast, damit du deinen Developer-Token unter ready2order.com/api anfordern kannst.

API Zugriffe in der Verwaltungsoberfläche verwalten

  1. Öffne die Verwaltungsoberfläche
  2. Gehe auf Einstellungen - API-Zugriff
  3. Klicke auf Rechnungen
  4. Alle vorhandenen API-Zugriffberechtigungen sind hier ersichtlich

FAQs zur API

Kann ich über die API einen Einkaufspreis hinterlegen?

Nein

Kann ich über die API die Zahlungsart einer existierten Rechnung ändern?

Nein

Kann ich über die API einen Zahlungsbeleg erstellen?

Nein

Welche IP-Adresse müssen wir bei uns freischalten, damit von r2o die API Zugriffe möglich sind?

Für die Webhooks haben wir keine fixen IP-Adressen.

Auch wenn Ihre Anfrage berechtigt ist, können wir ihr leider momentan nicht nachkommen, da wir ein Cloud-basierter Service sind und wir viel in unsere aktuellen Konfiguration ändern müssten.

Wir bieten keine fertigen Webshops an. Dafür kannst Du aber mithilfe unserer API und einen von dir bevorzugten Programmierer/Partner Deiner Wahl einen einen erstellen.
Der nachfolgende Abschnitt ist nur relevant, wenn Du die API vor dem Januar 2022 genutzt hast.

Prozessänderung für API-Integrationen - Januar 2022

Es gibt seit Januar 2022 eine Änderung an dem Prozess für die initiale Verknüpfung von Drittanbieter-Apps mit ready2order Konten.

Wer ist von den Änderungen betroffen?

  1. Falls Du vor dieser Zeit mit einer Entwicklung der Integration einer Drittanbieter-App begonnen hast, hat sich der Authentifizierungsprozess geändert.
  2. Falls Du eine bestehende Integration hast, die regelmäßig den Zugriff widerruft, muss die Integration auf den neuen Prozess aktualisiert werden.

Was ist dieses Dokument?

Dieses Dokument führt Dich durch die notwendigen Änderungen, die in Drittanbieter-Apps vorgenommen werden müssen, um sicherzustellen, dass der anfängliche Authentifizierungsprozess für ready2order Konten weiterhin funktioniert.

Um mit ready2order's API zu arbeiten, ist es notwendig, einen API-Token für ein bestimmtes ready2order Konto anzufordern. Um diesen API-Token zu erhalten, muss der ready2order-Kunde auf eine bestimmte Seite umgeleitet werden, auf der sich der ready2order-Kunde einloggen muss. Nach erfolgreichem Login muss der ready2order-Kunde zustimmen, dass die Drittanbieter-App auf die Kontodaten zugreifen kann.

Welcher Teil ist von dieser Änderung betroffen?

Der Prozess, mit dem Du den anfänglichen API-Developer-Token erhältst, hat sich geändert.

Wenn Du einen Grund hast, den API-Developer-Token zu widerrufen, wird der Prozess, mit dem Du einen neues erhältst, wie unten beschrieben geändert.

Was hat sich geändert?

Alter Prozess

Ein Drittentwickler hat den ready2order-Kunden auf diese Seite umgeleitet.

Dieser Prozess ist veraltet und wurde zum 28. Februar 2022 außer Betrieb genommen.

Neuer Prozess

  1. Verwende Deinen Developer-Token (der Dir bei der Registrierung als API-Entwickler per E-Mail zugesandt wurde), um einen temporäres Grant-Access-Token anzufordern 
Wenn Du die Original-E-Mail verloren hast und den Token nicht in der Konfiguration Deiner Drittanbieter-App gespeichert hast, wende Dich bitte an den ready2order-Support.

POST https://api.ready2order.com/v1/developerToken/grantAccessToken

Authorization: {DEVELOPER_TOKEN}

Accept: application/json

{

  "authorizationCallbackUri" : null|string

}

 

Optional kann der Parameter authorizationCallbackUri im Request-Body angegeben werden, der eine gültige, öffentlich zugängliche URL enthalten muss, an die wir den ready2order-Kunden nach der Genehmigung oder Ablehnung weiterleiten werden. Falls sie angegeben wird, leiten wir den ready2order-Kunden zu dieser Seite mit den folgenden Parametern um.

GET https://example.com/redirect-endpoint?status=approved|abgelehnt&accountToken=${ACCOUNT_TOKEN}&grantAccessToken=${GRANT_ACCESS_TOKEN}

 

Bitte beachte, den an die authorizationCallbackUri übergebenen grantAccessToken mit dem Grant-Access-Token auf Deiner Seite zu vergleichen, um unerwartete Ergebnisse zu vermeiden.

 

  1. Verwendung des grantAccessUri und Weiterleitung des ready2order-Kunden auf diese Seite.

Als Nächstes wird der ready2order-Kunde aufgefordert, sich einzuloggen und kann entweder den Zugang für Deine App gewähren oder ablehnen.

Wenn der ready2order-Kunde zugestimmt hat und keine authorizationCallbackUri angegeben wurde, wird dem ready2order-Kunden nur der Account-Token für die Nutzung der API angezeigt.

Wenn der ready2order-Kunde zugestimmt hat und eine authorizationCallbackUri angegeben wurde, wird der ready2order-Kunde an die angegebene Adresse weitergeleitet und der Account-Token für die Nutzung der API kann aus dem Query-Parameter accountToken gelesen werden.

Weitere Informationen findest Du in der API-Dokumentation.
Wenn der Account-Token aus irgendeinem Grund ungültig wird, muss der Prozess erneut durchgeführt werden, um einen aktiven Account-Token zu erhalten.
Wir beantworten Deine Support-Anfragen auch per Chat. Klicke hier, um zum Chat zu gelangen.

Hat Dir der Hilfe-Artikel geholfen?