Informationen zur API

Du möchtest ready2order mit einer externen App, einem Webshop oder einem eigenen System verbinden? Dafür bieten wir eine offene API (Schnittstelle) an. In diesem Artikel erfährst Du, was die ready2order API ist, wie Du einen Zugang beantragst und wie Du bestehende API-Zugriffe in der Verwaltungsoberfläche verwaltest.

Was ist die API?

API steht für „Application Programming Interface". Über diese Schnittstelle können externe Programme – z.B. Webshops, Warenwirtschaftssysteme oder eigene Anwendungen – mit Deinem ready2order Konto kommunizieren und Daten austauschen. Die Kommunikation erfolgt im JSON-Format.

Für PHP und NodeJS stellen wir offizielle Bibliotheken auf GitHub zur Verfügung, die die API-Kommunikation erleichtern.

Developer-Token und Account-Token

Für die Arbeit mit der API brauchst Du zwei Arten von Token:

Developer-Token: Der Developer-Token identifiziert Dich als API-Entwickler. Du erhältst ihn nach der Beantragung per E-Mail. Mit diesem Token kannst Du Account-Token für verschiedene ready2order Konten erstellen – vorausgesetzt, der jeweilige Kontoinhaber erteilt Dir die Erlaubnis. Das ist z.B. nützlich, wenn Du als Dienstleister für mehrere Unternehmen Integrationen betreust.

Account-Token: Der Account-Token ist an ein bestimmtes ready2order Konto gebunden. Er wird für alle Datenabfragen und -änderungen über die API benötigt.

API-Zugang beantragen

Hinweis: Du brauchst ein bestehendes ready2order Konto, um einen Developer-Token beantragen zu können.

  1. Besuche die API-Seite auf der ready2order Website.
  2. Fülle das Antragsformular mit allen notwendigen Informationen aus.

Du erhältst Deinen Developer-Token per E-Mail.

Account-Token erstellen (Authentifizierung)

Nachdem Du Deinen Developer-Token erhalten hast, kannst Du Account-Token für die Anbindung an ready2order Konten erstellen. Der Prozess funktioniert so:

Schritt 1: Grant-Access-Token anfordern

Sende eine Anfrage mit Deinem Developer-Token an den folgenden Endpunkt:

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

Authorization: {DEVELOPER_TOKEN}
Accept: application/json

{
  "authorizationCallbackUri": null | "https://deine-domain.com/callback"
}

Der Parameter authorizationCallbackUri ist optional. Wenn Du eine gültige, öffentlich zugängliche URL angibst, wird der ready2order Kunde nach der Genehmigung oder Ablehnung dorthin weitergeleitet – zusammen mit folgenden Parametern:

GET https://deine-domain.com/callback?status=approved|rejected&accountToken={ACCOUNT_TOKEN}&grantAccessToken={GRANT_ACCESS_TOKEN}

Tipp: Vergleiche den an die authorizationCallbackUri übergebenen grantAccessToken mit dem Grant-Access-Token auf Deiner Seite, um unerwartete Ergebnisse zu vermeiden.

Schritt 2: ready2order Kunden weiterleiten

Leite den ready2order Kunden auf die grantAccessUri weiter, die Du in der Antwort von Schritt 1 erhalten hast. Der Kunde meldet sich dort an und kann den Zugriff für Deine App genehmigen oder ablehnen.

  • Mit Callback-URL: Der Kunde wird nach der Entscheidung an Deine URL weitergeleitet. Den Account-Token findest Du im Query-Parameter accountToken.
  • Ohne Callback-URL: Dem Kunden wird der Account-Token direkt auf der Seite angezeigt.

Hinweis: Falls der Account-Token aus irgendeinem Grund ungültig wird, musst Du den Prozess erneut durchführen, um einen neuen aktiven Account-Token zu erhalten. Falls Du Deinen Developer-Token verloren hast, wende Dich an den ready2order-Support.

API-Zugriffe in der Verwaltungsoberfläche verwalten

Alle bestehenden API-Zugriffsberechtigungen kannst Du in der Verwaltungsoberfläche einsehen und verwalten:

  1. Melde Dich in der Verwaltungsoberfläche an.
  2. Klicke oben rechts auf Einstellungen (Zahnräder-Symbol).
  3. Klicke in der linken Seitenleiste auf Integrationen.
  4. Klicke auf API.

Hier siehst Du alle vorhandenen API-Zugriffsberechtigungen.

Weiterführende Informationen

Ausführliche technische Details, Endpunkte und Beispiele findest Du in der API-Dokumentation.

Hinweis: Wir bieten keine fertigen Webshops an. Du kannst aber mithilfe unserer API und einem Entwickler Deiner Wahl einen eigenen Webshop erstellen.

Hat Dir der Hilfe-Artikel geholfen?