API

Über die Programmierschnittstelle (API) greifen andere Programme auf die DocSecBox zu. Auf dieser Seite sehen Sie die Adresse der Schnittstelle, legen fest, von wo Zugriffe erlaubt sind, und registrieren die Anwendungen, die sie nutzen dürfen.

Zusatzmodul

API-Zugang ist ein kostenpflichtiges Zusatzmodul. Ohne das Modul gibt es den Eintrag API unter Einstellungen › Anwendung nicht. Ob es freigeschaltet ist, zeigt die Seite Lizenz.

Nur für Administratoren

Die Seite sehen nur Administratoren. Ist unter Rollen Nur Superadmins dürfen Programmeinstellungen anpassen eingeschaltet, sehen sie nur Superadmins.

Adresse der Schnittstelle

Die Karte Schnittstelle nennt unter Base-URL der HTTP REST Schnittstelle die Adresse, unter der andere Programme die API erreichen. Der Link API Dokumentation öffnet eine Beschreibung der Schnittstelle. Die vollständige Spezifikation erhalten Sie auf Anfrage beim Betreiber Ihrer DocSecBox bzw. beim Hersteller.

Zugriff freigeben

Die API nimmt nur Anfragen an, deren Herkunft Sie freigegeben haben. Beide Optionen sind ab Werk ausgeschaltet. Solange beide aus sind, weist die API jede Anfrage ab, und die Seite weist darauf hin.

1. Öffnen Sie Einstellungen › Anwendung › API.
2. Aktivieren Sie in der Karte API Zugriffseinstellungen eine oder beide Optionen: Zugriff auf API von internen IP-Adressen zulassen und Zugriff auf API von externen IP-Adressen zulassen.
3. Klicken Sie auf Einstellungen speichern.

Entscheidend ist die Adresse, von der eine Anfrage eintrifft. Ein Aufruf vom Server selbst gilt weder als intern noch als extern. Ihn weist keine der beiden Optionen ab.

Anwendung registrieren

Jedes Programm, das die API nutzt, registrieren Sie als Anwendung. Dabei bestimmen Sie, welche Benutzer einen Schlüssel dafür bekommen.

1. Klicken Sie in der Karte API-Anwendungen auf Anwendung anlegen.
2. Geben Sie im Dialog API-Anwendung anlegen unter Name der Anwendung einen Namen ein.
3. Aktivieren Sie in der Benutzerliste die Konten, die einen Schlüssel bekommen sollen. Das Feld Nach Benutzer suchen... hilft bei langen Listen.
4. Klicken Sie auf Speichern.

Beim Speichern erhält jedes angehakte Konto einen Schlüssel. Entfernen Sie später einen Haken, wird der Schlüssel dieses Kontos zurückgezogen. Den Schlüssel sieht nur der Benutzer selbst, im Profil unter Drittanbieter-Schlüssel. Auf dieser Seite wird er nie angezeigt.

Die Liste der Anwendungen zeigt je Zeile Name, die Zahl der Benutzer mit Schlüssel und den Status: Aktiv, Aktiv bis mit Datum oder Deaktiviert. Mit Bearbeiten ändern Sie eine Anwendung im Dialog API-Anwendung bearbeiten.

Anwendung außer Betrieb nehmen

Eine Anwendung lässt sich nicht löschen. Sie nehmen sie über ein Datum außer Betrieb:

1. Klicken Sie in der Zeile der Anwendung auf Bearbeiten.
2. Aktivieren Sie Ab einem Datum deaktivieren und wählen Sie das Datum unter Deaktiviert ab.
3. Klicken Sie auf Speichern.

Bis zu diesem Datum bleiben die Schlüssel der Benutzer gültig.