Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
Beide Seiten der vorigen Revision Vorhergehende Überarbeitung Nächste Überarbeitung | Vorhergehende Überarbeitung | ||
developer:client [2019/01/28 18:59] oesi |
developer:client [2019/08/13 13:48] (aktuell) |
||
---|---|---|---|
Zeile 6: | Zeile 6: | ||
* Getrennte Codebasis, Kommunikation mit dem Core erfolgt ausschließlich über die API / REST Services | * Getrennte Codebasis, Kommunikation mit dem Core erfolgt ausschließlich über die API / REST Services | ||
* Sind zusätzliche Erweiterungen des Core erforderlich muss zusätzlich eine [[developer:extensions|Extension]] erstellt werden. | * Sind zusätzliche Erweiterungen des Core erforderlich muss zusätzlich eine [[developer:extensions|Extension]] erstellt werden. | ||
+ | * FHC-Clients folgen der Namenskonvention FHC-Client-XXX | ||
{{:developer:clientaufbau.png?600|}} | {{:developer:clientaufbau.png?600|}} | ||
Zeile 27: | Zeile 28: | ||
* CoreClient.css.ex -> Beispiel CSS | * CoreClient.css.ex -> Beispiel CSS | ||
- | ==== Core Anbindung ==== | + | ===== Core Anbindung ===== |
Um einen Client mit dem Core zu verbinden sind folgende Schritte nötig: | Um einen Client mit dem Core zu verbinden sind folgende Schritte nötig: | ||
* User im FH-Complete erstellen | * User im FH-Complete erstellen | ||
Zeile 35: | Zeile 36: | ||
- | === User === | + | ==== User ==== |
Für die Anbindung muss ein User im FH-Complete erstellt werden. Dieser kann als Mitarbeiter oder als Student angelegt werden. | Für die Anbindung muss ein User im FH-Complete erstellt werden. Dieser kann als Mitarbeiter oder als Student angelegt werden. | ||
- | === API Key === | + | ==== API Key ==== |
Der Zugriff erfolgt über einen API Key. Dazu muss in der Datenbank in der Tabelle public.ci_apikey ein neuer Eintrag hinzugefügt werden. Wichtig ist hier der Wert "Key". Dieser muss beim Zugriff angegeben werden. | Der Zugriff erfolgt über einen API Key. Dazu muss in der Datenbank in der Tabelle public.ci_apikey ein neuer Eintrag hinzugefügt werden. Wichtig ist hier der Wert "Key". Dieser muss beim Zugriff angegeben werden. | ||
- | === Berechtigung zuteilen === | + | ==== Berechtigung zuteilen ==== |
Damit der Zugriff auf die REST Schnittstelle möglich ist, muss der neue User die entsprechenden Berechtigungen für den Zugriff auf die Funktionen erhalten. Dies kann im Vilesci über Stammdaten->Berechtigungen zugeordnet werden. | Damit der Zugriff auf die REST Schnittstelle möglich ist, muss der neue User die entsprechenden Berechtigungen für den Zugriff auf die Funktionen erhalten. Dies kann im Vilesci über Stammdaten->Berechtigungen zugeordnet werden. | ||
+ | Siehe auch [[admin:berechtigung|Berechtigung]] | ||
- | === Whitelist === | + | ==== Whitelist ==== |
Per Default ist der Zugriff auf die REST Schnittstelle per Whitelist gesperrt. Damit der Zugriff auf die Schnittstelle möglich ist, muss die Client IP in die Whitelist mitaufgenommen werden. | Per Default ist der Zugriff auf die REST Schnittstelle per Whitelist gesperrt. Damit der Zugriff auf die Schnittstelle möglich ist, muss die Client IP in die Whitelist mitaufgenommen werden. | ||
Die entsprechende Konfiguration dazu findet sicht unter /application/config/rest.php | Die entsprechende Konfiguration dazu findet sicht unter /application/config/rest.php |