Gehe Sie in Ihre Gover-Anwendung in das Untermenü Api-Schlüssel und legen Sie einen neuen Schlüssel an. Diesem können Sie individuelle Berechtigungen für die einzelnen Datenobjekte von Gover geben.
Nachdem Sie den neuen Schlüssel gespeichert haben, wird der Schlüssel automatisch generiert und am Anfang der Seite angezeigt. Kopieren Sie diesen Schlüssel und verwenden Sie ihn bei Anfragen an die Gover API.
Der API-Schlüssel muss bei jeder HTTP-Anfrage an die Gover API im Header mitgegeben werden. Das Header-Feld lautet Authorization. Der Wert entspricht dem Muster Token <API_SCHLÜSSEL> wobei Sie den Teil in den spitzen Klammern durch Ihren neuen API-Schlüssel ersetzen müssen.
Authorization: Token <API_SCHLÜSSEL>
Zum Beispiel:
Authorization: Token f361d102-2487-45d9-8638-7874fbdc5fb9
Folgende Datenobjekte können Sie über die API lesen/modifizieren:
| Methode |
Pfad |
Beschreibung |
Optionale Query-Parameter |
| GET |
/api/applications |
Die Liste aller Formulare |
department=<FB_ID> |
| POST |
/api/applications |
Ein neues Formular anlegen |
|
| GET |
/api/applications/<id> |
Ein einzelnes Formular abrufen |
|
| PUT |
/api/applications/<id> |
Ein einzelnes Formular aktualisieren |
|
| DELETE |
/api/applications/<id> |
Ein einzelnes Formular löschen |
|
| Methode |
Pfad |
Beschreibung |
Optionale Query-Parameter |
| GET |
/api/submissions/<form_id> |
Die Liste aller Anträge für das Formular mit der ID form_id |
includeArchived=<true/false>&includeTest=<true/false>&assignee=<USER_ID> |
| GET |
/api/submissions/<form_id>/<id> |
Einen einzelnen Antrag abrufen |
|
| GET |
/api/submissions/<form_id>/<id>/attachments |
Die Liste aller Anlagen für den gegebenen Antrag abrufen |
|
| PUT |
/api/submissions/<form_id>/<id> |
Einen einzelnen Antrag aktualisieren |
|
| Methode |
Pfad |
Beschreibung |
Optionale Query-Parameter |
| GET |
/api/system-assets |
Die Liste aller Dokumente & Medieninhalte |
|
| POST |
/api/system-assets |
Eine neue Datei hochladen (MultiPart-Request) |
|
| DELETE |
/api/system-assets /<filename> |
Eine einzelne Datei löschen |
|
| Methode |
Pfad |
Beschreibung |
Optionale Query-Parameter |
| GET |
/api/departments |
Die Liste aller Fachbereiche |
member=<true/false>&roleId=<0|1|2> |
| POST |
/api/departments |
Einen neuen Fachbereich anlegen |
|
| GET |
/api/departments/<id> |
Einen einzelnen Fachbereich abrufen |
|
| PUT |
/api/departments/<id> |
Einen einzelnen Fachbereich aktualisieren |
|
| DELETE |
/api/departments/<id> |
Einen einzelnen Fachbereich löschen |
|
| Methode |
Pfad |
Beschreibung |
Optionale Query-Parameter |
| GET |
/api/department-memberships |
Die Liste aller Mitgliedschaften |
department=<FB_ID>&user=<USER_ID> |
| POST |
/api/department-memberships |
Eine neue Mitgliedschaften anlegen |
|
| PUT |
/api/department-memberships/<id> |
Eine einzelne Mitgliedschaft aktualisieren |
|
| DELETE |
/api/department-memberships/<id> |
Eine einzelne Mitgliedschaft löschen |
|
| Methode |
Pfad |
Beschreibung |
Optionale Query-Parameter |
| GET |
/api/destinations |
Die Liste aller Schnittstellen |
|
| POST |
/api/destinations |
Eine neue Schnittstelle anlegen |
|
| GET |
/api/destinations/<id> |
Eine einzelne Schnittstelle abrufen |
|
| PUT |
/api/destinations/<id> |
Eine einzelne Schnittstelle aktualisieren |
|
| DELETE |
/api/destinations/<id> |
Eine einzelne Schnittstelle löschen |
|
| Methode |
Pfad |
Beschreibung |
Optionale Query-Parameter |
| GET |
/api/presets |
Die Liste aller Vorlagen |
|
| POST |
/api/presets |
Eine neue Vorlage anlegen |
|
| GET |
/api/presets/<id> |
Eine einzelne Vorlage abrufen |
|
| PUT |
/api/presets/<id> |
Eine einzelne Vorlage aktualisieren |
|
| DELETE |
/api/presets/<id> |
Eine einzelne Vorlage löschen |
|
| Methode |
Pfad |
Beschreibung |
Optionale Query-Parameter |
| GET |
/api/presets/<id>/versions |
Die Liste aller Vorlagen-Versionen der Vorlage mit der gegebenen ID |
|
| POST |
/api/presets/<id>/versions |
Eine neue Vorlagen-Version für die Vorlage mit der gegebenen ID anlegen |
|
| GET |
/api/presets/<id>/versions/<version> |
Eine einzelne Vorlagen-Version für die Vorlage mit der gegebenen ID abrufen |
|
| PUT |
/api/presets/<id>/versions/<version> |
Eine einzelne Vorlagen-Version für die Vorlage mit der gegebenen ID aktualisieren |
|
| DELETE |
/api/presets/<id>/versions/<version> |
Eine einzelne Vorlagen-Version für die Vorlage mit der gegebenen ID löschen |
|
| Methode |
Pfad |
Beschreibung |
Optionale Query-Parameter |
| GET |
/api/provider-links |
Die Liste aller Links |
|
| POST |
/api/provider-links |
Einen neuen Link anlegen |
|
| GET |
/api/provider-links/<id> |
Einen einzelnen Link abrufen |
|
| PUT |
/api/provider-links/<id> |
Einen einzelnen Link aktualisieren |
|
| DELETE |
/api/provider-links/<id> |
Einen einzelnen Link löschen |
|
| Methode |
Pfad |
Beschreibung |
Optionale Query-Parameter |
| GET |
/api/themes |
Die Liste aller Farbschemata |
|
| POST |
/api/themes |
Ein neues Farbschema anlegen |
|
| GET |
/api/themes/<id> |
Ein einzelnes Farbschema abrufen |
|
| PUT |
/api/themes/<id> |
Ein einzelnes Farbschema aktualisieren |
|
| DELETE |
/api/themes/<id> |
Ein einzelnes Farbschema löschen |
|
| Methode |
Pfad |
Beschreibung |
Optionale Query-Parameter |
| GET |
/api/users |
Die Liste aller Mitarbeiter:innen |
|
| POST |
/api/users |
Eine neue Mitarbeiter:in anlegen |
|
| GET |
/api/users/<id> |
Eine einzelne Mitarbeiter:in abrufen |
|
| PUT |
/api/users/<id> |
Eine einzelne Mitarbeiter:in aktualisieren |
|
| DELETE |
/api/users/<id> |
Eine einzelne Mitarbeiter:in löschen |
|