Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
57 lines (44 sloc) 1.97 KB

API Grundlagen


Die Bludi API (Application Programming Interface) ist ein Plugin das die Integration von Bludit ermöglicht. Mit diesem Plugin ist es möglich Daten aus der Datenbank mit einem HTTP Request abzufragen oder zu aktualisieren.

Content

  1. Installation
  2. URL
  3. Endpoints und Methoden
  4. Methoden Parameter
  5. HTTP Response

Installation

Das API-Plugin ist mit der Installation von Bludit automatisch dabei. Es muss nur über das Admin-Panel Admin panel->Plugins->API->Aktivieren aktiviert werden.

URL

Die URL der API lautet

{protocol}://{domain}/api/{endpoint}

Example:

https://example.com/api/pages

Endpoints und Methoden

Endpoint Method Beschreibung
/pages GET Gibt ein Array mit einer Liste aller Seiten zurück.
/pages/ GET Gibt eine Seite anhand des Schlüssels zurück
/pages POST Erstellt eine neue Seite

Methoden Parameter

Key Type Beschreibung
token string API token
limit integer Eine Zahl um die Anzahl der Seiten zu begrenzen
authentication string Authentifizierungs User Token

HTTP Response

Das zurückgegebene Format ist JSON mit folgenden Feldern:

Key Type Beschreibung
message string Gibt eine kleine Message über das Ergebnis des Requests zurück.
data array Der Inhalt der Antwort dieses Endpoints

Außerdem kann man über den HTTP-Code die verschiednen Antworten prüfen.