User Tools
module:rest-getting-started
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
module:rest-getting-started [2023/11/28 15:13] lars |
module:rest-getting-started [2023/12/04 11:35] (current) alexandra [C) Application Keys] |
||
|---|---|---|---|
| Line 14: | Line 14: | ||
| ===== Authentifizierung ===== | ===== Authentifizierung ===== | ||
| - | Für eine Benutzung der Schnittstelle müssen Sie sich Authentifizieren, siehe | + | Für eine Benutzung der Schnittstelle müssen Sie sich Authentifizieren, siehe: |
| <file> | <file> | ||
| Line 41: | Line 41: | ||
| ==== A) Entwicklungsserver ohne Rechteprüfung ==== | ==== A) Entwicklungsserver ohne Rechteprüfung ==== | ||
| - | Sie deaktivieren die Rechteprüfung komplett - dies ist zum Beispiel für | + | Sie deaktivieren die Rechteprüfung komplett. Dies ist zum Beispiel für |
| - | ein Entwicklungssystem akzeptabel. Dazu müssen sie in der Datei config/bsm.properties | + | ein Entwicklungssystem akzeptabel. Dazu müssen Sie in der Datei config/bsm.properties |
| den Eintrag | den Eintrag | ||
| Line 53: | Line 53: | ||
| ==== B) Spezieller REST-User ==== | ==== B) Spezieller REST-User ==== | ||
| - | Sie geben ihrem angemeldeten Nutzer die Rechte - dies wird in der Regel für REST-Zugriff | + | Sie geben ihrem angemeldeten Nutzer die Rechte. Dies wird in der Regel für REST-Zugriff |
| benutzt, der eine Schnittstelle zu einem anderen System bildet. Der Nutzer, der hierfür | benutzt, der eine Schnittstelle zu einem anderen System bildet. Der Nutzer, der hierfür | ||
| verwendet wird, ist in der Regel kein normaler Projectile-Nutzer, der auch eine konkrete | verwendet wird, ist in der Regel kein normaler Projectile-Nutzer, der auch eine konkrete | ||
| Person repräsentiert, sondern ein reiner REST-Nutzer. | Person repräsentiert, sondern ein reiner REST-Nutzer. | ||
| - | Wenn sie so einen Nutzer haben, können Sie diesem in der Projectile-Oberfläche | + | Wenn Sie so einen Nutzer haben, können Sie diesen in der Projectile-Oberfläche |
| den ACL-Eintrag unter: | den ACL-Eintrag unter: | ||
| Line 66: | Line 66: | ||
| zuweisen. Der Nutzer sollte dort als Owner eingetragen werden oder Mitglied einer | zuweisen. Der Nutzer sollte dort als Owner eingetragen werden oder Mitglied einer | ||
| - | REST-Benutzergruppe sein, die sie unter Relatives oder Friends dem ACL-Eintrag zuweisen. | + | REST-Benutzergruppe sein, die Sie unter Relatives oder Friends dem ACL-Eintrag zuweisen. |
| Sollte es diesen ACL-Eintrag noch nicht geben, dann können Sie diesen im Script-Interpreter | Sollte es diesen ACL-Eintrag noch nicht geben, dann können Sie diesen im Script-Interpreter | ||
| Line 74: | Line 74: | ||
| ==== C) Application Keys ==== | ==== C) Application Keys ==== | ||
| - | Sie verwenden Application-Keys - dies wird in der Regel benutzt, wenn sich alle | + | Sie verwenden Application-Keys. Dies wird in der Regel benutzt, wenn sich alle |
| Mitarbeiter via REST in Projectile anmelden können sollen, dies aber über eine App oder ähnliches | Mitarbeiter via REST in Projectile anmelden können sollen, dies aber über eine App oder ähnliches | ||
| geschieht. Dann muss ein Application-Key generiert und in der App hinterlegt werden. | geschieht. Dann muss ein Application-Key generiert und in der App hinterlegt werden. | ||
| Sie können einen neuen Application-Key unter Administration > System > REST > Create REST application | Sie können einen neuen Application-Key unter Administration > System > REST > Create REST application | ||
| - | anlegen. Geben Sie ihrer App eine frei gewählte ID und speichern Sie diese. Dann können Sie | + | anlegen. Geben Sie Ihrer App eine frei gewählte ID und speichern Sie diese. Dann können Sie |
| unter Aktionen mit "GenerateApplicationKey" einen neuen Key erzeugen. | unter Aktionen mit "GenerateApplicationKey" einen neuen Key erzeugen. | ||
| - | Diesen kopieren Sie bitte und übermitteln diesen als Parameter XXXXXXXXXXXX wie folgt bei jedem Request: | + | Diesen kopieren Sie bitte und übermitteln diesen als Parameter XXXXXXXXXXXX - wie folgt - bei jedem Request: |
| <file> | <file> | ||
| Line 89: | Line 89: | ||
| {{:module:application-keys.png?800|}} | {{:module:application-keys.png?800|}} | ||
| + | |||
| + | ===== Zugriff auf die Daten ===== | ||
| + | |||
| + | Jetzt können Sie auf die Daten Ihrer Projectile-Instanz zugreifen. | ||
| + | |||
| + | Laden Sie zum Beispiel eine Liste der Projekte mit einem GET-Request auf | ||
| + | diese URL. | ||
| + | |||
| + | <file> | ||
| + | https://YOUR_SERVER/projectile/rest/api/json/0/projects | ||
| + | </file> | ||
| + | |||
| + | Beachten Sie, dass der Request die oben beschriebenen Header für Autorization | ||
| + | und application-key enthält. | ||
| + | |||
| + | Alle zugreifbaren Daten finden Sie auch in der Referenzdokumentation unter "Modules & Entities". | ||
| + | |||
| + | <file> | ||
| + | https://YOUR_SERVER/projectile/wiki/rest/index | ||
| + | </file> | ||
| + | |||
| + | |||
| + | |||
module/rest-getting-started.1701180809.txt.gz · Last modified: 2023/11/28 15:13 by lars
