Web API

[Start]  [Zurück]  [Vorwärts]  

Auf dieser Seite konfigurieren Sie die HAN Web API. Die HAN Web API erweitert HAN um einen Discovery-Service-Funktion:

 

sett_webapi_webapi01

 

Web API verwenden. Aktiviert die Verwendung der HAN Web API.

Konfigurierte Schnittstellen. Listet alle über die Web API konfigurierten Schnittstellen zu Anbietern von Suchsystemen.

 

Sie bearbeiten die Liste der konfigurierten Schnittstellen mit den Schaltflächen oberhalb der Liste:

Neu. Erstellt einen neuen Eintrag in der Liste.

Bearbeiten. Bearbeitet die markierte Schnittstelle.

Löschen. Löscht den markierten Eintrag in der Liste.

Alle löschen. Löscht alle Einträge in der Liste.

 

Web API erstellen

 

1. Klicken Sie oberhalb der Liste die Schaltfläche Neu.

 

2. Im Dialog Web API - anlegen wählen Sie die Art der API:

Weiterleitung auf HAN URL: Ermittelt bei einem LinkOut eine eventuell vorhandene HAN ID zu der gewählten URL und öffnet bei Erfolg die Ressource über HAN. Details zur Funktionsweise der API lesen Sie im Kapitel „HAN Web API/HAN ID ermitteln".

Informationen zu HAN E-Skript: Erfragt Zusatzinformationen zu E-Skripten, wie Sie z.B. in der A-bis-Z-Liste gezeigt werden. Details zur Funktionsweise der API lesen Sie im Kapitel „HAN Web API/Zusatzinformationen anfragen".

Anlegen und Weiterleiten: Ermittelt beim LinkOut, ob bereits ein HAN E-Skript zu der URL vorhanden ist. Ist kein E-Skript vorhanden, wird es erstellt. Details zur Funktionsweise der API lesen Sie im Kapitel „HAN Web API/Erstellen von E-Skripten".

 

3. Im Dialog Web API einrichten konfigurieren Sie die Web API:

 

explain Die Optionen des Dialogs orientieren sich an der gewählten API. Alle Optionen sehen Sie nur, wenn Sie Anlegen und Weiterleiten wählen:

 

sett_webapi_webapi02

 

ID. Ein eindeutiger Bezeichner der neuen Web API.

Beschreibung. Beschreibung der neuen Web API.

Rückgabewerte. Werte, die von der Web API über das E-Skript abgefragt und von HAN weiter verarbeitet werden.

Suchmodus. Kriterien, nach denen HAN ein potentielles E-Skript bestimmt.

 

Erweiterte Einstellungen. Die Schaltfläche öffnet den Dialog Erweiterte Einstellungen, in dem Sie den Suchmodus weiter verfeinern. Die Beschreibung der Einstellungen lesen Sie im Abschnitt „Suchmodus – Erweiterte Einstellungen".

 

Geheimer Salt (nur beim Anlegen). Beim Anlegen wird die Übertragung von Daten auf den HAN Server verschlüsselt, um unbefugten Zugriff auf den HAN Server zu verhindern. Hierzu wird der Salt verwendet, kodiert wird mit dem gewählten Hash-Algorithmus.

Hash-Algorithmus. Algorithmus, mit dem die Datenübertragung zum HAN Server beim Anlegen von E-Skripten verschlüsselt wird.

 

Suchmodus – Erweiterte Einstellungen

Im Dialog Erweiterte Einstellungen spezifizieren Sie manuell den HAN Suchmodus, der bei LinkOut-URLs nach passen E-Skripten in der HAN Datenbank sucht:

 

sett_webapi_webapi03

 

Zuordnung einer HAN ID zu einer Domäne. Ordnet Domänen bestimmten HAN IDs zu.

Reg. Ausdruck zur Bestimmung einer HAN ID. Erweitert den Suchmodus um ein Schema, nach dem URLs durchsucht werden.

 

Sie bearbeiten die Listen mit den Schaltflächen oberhalb:

Neu. Erstellt einen neuen Eintrag.

Bearbeiten. Bearbeitet den markierten Eintrag.

Löschen. Löscht den markierten Eintrag.

Alle löschen. Löscht alle Einträge der Liste.

 

Details zur Funktionsweise der einzelnen Web APIs lesen Sie im Kapitel „HAN Web API".