Erstellen von E-Skripten

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

Ist zu der Onlineressource in HAN noch kein E-Skript vorhanden, wird es mit den verfügbaren Informationen erstellt. Dabei wird zuerst geprüft, ob das E-Skript bereits vorhanden ist. Wie dieser Prüfvorgang läuft, lesen Sie im Kapitel „HAN ID ermitteln". Ist es nicht vorhanden, wird ein E-Skript erstellt.

 

explain Aus dem Schreiben von Daten auf den HAN Server von extern ergibt sich ein gewisses Risiko. Um die Kommunikation mit dem HAN Server von außen gegen unbefugtes Eindringen abzusichern, wird ein Ticketing-Mechanismus verwendet. Der Ticketing-Mechanismus wird in den HAN Einstellungen konfiguriert.

 

API-Funktionsweise

Die API wird über ein virtuelles Verzeichnis angesprochen: http://<HAN Server>/hanapi/action.

Der Parameter method entscheidet über die angefragt Methode. Die Schnittstelle zur Bestimmung der HAN ID, bzw. zum Erstellen eines E-Skripts, falls es noch nicht vorhanden ist, wird über den Wert findCreateHANID angesprochen.

Folgende zusätzliche Parameter stehen zur Verfügung:

url. Ziel-URL

eissn. E-ISSN (ist bei SFX als Parameter ISSN hinterlegt, bei der EZB jedoch als E-ISSN)

title. Titel des Journals

doi. DOI des Volltextes

id. HAN ID, falls noch kein E-Skript existiert

property. 1. Objekteigenschaft

group. Zuordnung von Voreinstellungen, ähnlich Anchor

timestamp. Zeitstempel, wann der Request erstellt wurde (in Sekunden); verhindert, dass ein gespeicherter Link zu einem späteren Zeitpunkt aufgerufen werden kann. Für eine Gültigkeit von 5 Minuten z.B. hängen Sie einen Timestamp-Parameter von 300 Sekunden an.

hash. <Prüfsumme>; wird über alle vorhergehenden Parameter berechnet: Hash (inkl. Salt) = (url=<>&eiisn=<>…). Um größte Flexibilität zu gewährleisten wird der Hash zur Kontrolle immer über den gesamten Parameterstring berechnet.

 

Die Parameter eissn, property, group, timestamp und doi sind optional. Die Parameter url, id und title dagegen sind erforderlich – fehlen sie, wird ein Fehler zurückgemeldet.

 

warning Alle Parameter müssen URL-kodiert übergeben werden.

 

Beispiele

Ein Beispiel für eine URL-Abfrage mit Parametern:

http://handemo.hh-software.com/hanapi/action?method=findCreateHANID&title=Nature&url=http%3A%2F%2Fwww.nature.com&hanid=nature&id=create&return=0&hash=eaa25975f5e2d78ad5daebbc8acd541a

 

Der Aufbau eines JSON-Objekts ist ähnlich dem Aufbau der URL-Parameter, es werden die gleichen Parameternamen verwendet:

 

{

method : getHANID,

url : <URL>,

eissn : <E-ISSN>,

doi : <DOI>,

title : <Titel>,

id: <ID der konfigurierten API>

hanid : <HAN ID, falls Skript angelegt werden muss>,

property : <1. Objekteigenschaft>,

timestamp : <Zeitstempel>,

hash : <Hash über alle Parameter, berechnet wie beim Senden als URL Parameter>,

return : <Rückgabemethode>,

group: <Gruppen-ID zur Zuordnung von Voreinstellungen>

}

 

Auch bei der Verwendung eines JSON-Objekts gilt, dass die Standardrückgabe der Redirect ist und immer verwendet wird, wenn die Rückgabemethode nicht spezifiziert wurde.

Rückgabe des Ergebnisses

Die Art der Rückgabe wird über den Parameter return bestimmt. Mögliche Werte für diesen Parameter sind:

0 (Redirect)

1 (JSON)

2 (Template)

 

Standardrückgabe ist der Redirect der HAN URL, ohne Parameter liefert die Schnittstelle immer einen Redirect. Die Rückgabe der Ergebnisse erfolgt genauso, als sei das E-Skript schon vorhanden gewesen. Wie die Ergebnisse zurückgegeben werden, lesen Sie im Kapitel „HAN ID ermitteln".