1. Home
  2. REST API edoobox
  3. REST API Basic – Die edoobox-API

REST API Basic – Die edoobox-API

Einleitung

Mit der edoobox REST API haben Kunden von edoobox einen direkten Zugriff auf viele Daten. Dies erleichtert die Anbindung an 3rd Party Applikationen und einer individuelle Ausgabe auf deren Website.
Wir haben diese Beschreibung mit vielen Beispielen ergänzt die direkt in Ihre Applikation übernommen werden können – ersetzen Sie Filter und Parameter nach Ihren Wünschen.

Basic Einstellungen

Um Zugriff auf die REST API zu bekommen, müssen Sie in Ihrem edoobox Konto API Keys erstellen. Gehen Sie dazu in die globalen edoobox Einstellungen und wählen Sie in der Box „API Zugangsverwaltung“ den Button „Neuer API Zugang“. Möchten Sie etwas in Ihrem Frontend erstellen, dann wählen Sie diesen Button unter „Public Key“, möchten Sie etwas Serverseitiges mit mehr Rechten erstellen, dann wählen Sie diesen Button unter „Private Key“. Ein Key kann jederzeit deaktiviert oder die Berechtigung von PRIVATE auf PUBLIC umgestellt werden. Ist ein Key auf PUBLIC, kann auch über JavaScript auf die API zugegriffen werden.

Liste der API-Ressourcen

Die API verfügt über mehrere Ressourcen. Diese können gefiltert ausgegeben oder aktualisiert werden.

Name URL GET POST PUT DELETE Status
Template v1/templates Ja  –  –  –
Angebote v1/offers Ja  –  –  –
Teilnehmer v1/users Ja i. A. i. A.
Buchungen v1/bookings Ja i. A. i. A.
Preiskategorien v1/pricecategories Ja i. A. i. A.
Termine / Module v1/modules Ja i. A. Ja Alpha
Rechnungen v1/invoice Ja i. A.
Transaktionen v1/transactions Ja Alpha

Die REST API in Ihrer eigenen Anwendung

Um die Verbindung zur REST API herstellen zu können, benötigen Sie eine Client-Anwendung. Wir stellen Ihnen Beispiel Codes in JavaScript und PHP zu Verfügung. Die folgende PHP Klasse veranschaulicht eine voll funktionsfähige Implementierung eines REST-Clients. Kopieren Sie diesen Code und laden Sie die „edooboxAPI.php“ Datei danach auch in den Ordner „events“ (gemäss Beispiele JavaScript und PHP) hoch.
Beispiel Code ist in der Klasse nicht enthalten, kann jedoch in den einzelnen Ressourcen gefunden werden.

Für die Verwendung mit JavaScript, empfehlen wir Ihnen diese direkt über unser Content Delivery Network CDN einzubinden:
https://cdn1.edoobox.com/edooboxAPI.v1.0.js

Initialisieren eines API Clients

Um den Client verwenden zu können, müssen Sie diesen initialisieren. Es wird die URL, der API-Key und der API-Secret-Key übergeben:

Erster API Aufruf

Mit dem initialisierten Client kann nun auf alle Ressourcen zugegriffen werden. Der erste Parameter ist die Ressource, die abgefragt werden soll. Die URL muss nicht erneut angegeben werden, da diese bereits initialisiert wurde.
Mit diesem Beispiel erhalten Sie eine Auflistung Ihrer Angebote:

Spezielle Informationen

Sämtliche Datumsformatierungen sind im ISO_8601 Format und werden auch in diesem erwartet.
In allen Abfragen können für GET, POST, PUT und DELETE alle Filter, Sort und Limit Parameter verwendet werden. Diese sind in den einzelnen Ressourcen beschrieben.

Sortierung der Ausgabe

Pro Resource sind verschiedene Parameter zur Sortierung verfügbar. Diese können auch kombiniert werden, wobei die Array Reihenfolge beachtet wird. Bei allen „Order“ Parametern ist ein „value“ erforderlich, welches „ASC“ oder „DESC“ für auf- oder absteigend enthalten muss.

API Request Limit

Für GET Abfragen liegt die Limite beim Limited2 und Limited3 sowie beim Business bei 100’000 Request pro 24 Stunden.
POST, PUT und DELETE Abfragen sind auf 1’000 Requests pro 24h limitiert. Sollten Sie eine höhere Limite benötigen, bitten wir Sie mit uns Kontakt aufzunehmen.

Updated on 3. September 2018

Was this article helpful?

Related Articles

Need Support?
Can’t find the answer you’re looking for? Don’t worry we’re here to help!
Contact Support