Erste Schritte

Authentifizierung

Nicht jeder darf auf die JSON/REST API zugreifen. Über POST müssen Sie sich zunächst authentifizieren. Dazu benötigen Sie eine Benutzer ID und einen API Token.

/rest/startSession?user_id=USER_ID&token=TOKEN

In der Benutzerverwaltung können Sie für einen Benutzer einen API Token generieren lassen (Reiter Optionen).

Nur wenn der Benutzer einen API Token besitzt und dieser auch mit dem übergebenen Token übereinstimmt, darf die API genutzt werden.
warning
Sie erhalten bei erfolgreicher Authentifzierung eine Session ID zurück. Diese muss fortan für jeden weiteren Aufruf
als EGOTEC Cookie weitergereicht werden.Alle weiteren Aufrufe verwenden die EGOCMS Rechteverwaltung. Wenn Sie zum Beispiel eine Seite aktualisieren wollen, dann funktioniert das nur, wenn der authentifizierte Benutzer auch die entsprechenden Rechte für diese Seite besitzt.

Wenn Sie Ihre API Sitzung beenden möchten, machen Sie folgenden Aufruf:

/rest/closeSession

GET

Mit <Mandant>/<Sprache> können Sie einen Mandanten in einer Sprache ermitteln. Beispiel:

/rest/demo/de

Hier können Sie auch public Methoden des Site Objekts aufrufen. Beispiele:

/rest/demo/de/getRoot
/rest/demo/de/getLanguages

Wenn Sie den Methoden Parameter übergeben möchten, können Sie das über den Query String. Die Reihenfolge der Parameter bestimmt dabei die Reihenfolge mit der die Parameter der Methode übergeben werden.

/rest/demo/de/getPage?id=10

Um auf ein Page Objekt zuzugreifen können Sie stattdessen aber auch diesen Aufruf verwenden:

/rest/demo/de/10

Auch hier können Sie nun public Methoden des Page Objekts aufrufen: Beispiele:

/rest/demo/de/10/getChildren
/rest/demo/de/10/getDescendants

PUT

Ein Beispiel für eine schreibende Methode wäre eine Seite zu ändern:

/rest/demo/de/10/update?param[field][title]=New+title

POST

Ein Beispiel für eine erstellende Methode wäre eine Seite anzulegen:

/rest/demo/de/10/newChild?param[field][name]=Created

DELETE

Ein Beispiel für eine löschende Methode wäre eine Seite zu löschen:

/rest/demo/de/10

Hier sieht man auch, dass der selbe Aufruf wie beim GET Beispiel wegen des anderen Headers auch eine andere Aktion ausführt.

wb_incandescent
Neben Site und Page Methoden können Sie auch auf Benutzer, Gruppen und Rollen Objekte zugreifen. Welche Methoden zur Verfügung stehen, entnehmen Sie bitte der rest.ini Datei oder hier.

Um einen Benutzer anzusteuern, müssen Sie dessen ID angeben:

/rest/~user/USER_ID

Das selbe gilt auch für eine Gruppe oder Rolle:

/rest/~group/GROUP_ID
/rest/~role/ROLE_ID