Informationen zur API

von

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.