Erzeugen des API-Autorisierungsschlüssels

 

Im Bereich Administration | Anwender | steht Ihnen als Administrator die Möglichkeit zur Verfügung, für einen separaten Anwender (API-User) einen API-Autorisierungsschlüssel zu erzeugen.

 

Hinweis: Wir empfehlen für die Nutzung der Anwendungsprogrammier-Schnittstelle (API) unbedingt einen neuen bzw. separaten Anwender anzulegen. Dieser "API-User" benötigt normalerweise keine weiteren Anwenderrollen (in der Regel wird es so sein, dass der Anwender ein Programmierer bzw. Entwickler ist).

Nur so lässt sich beispielsweise beim Preisimport-Service im Journal Preisanforderungen nachvollziehen, über welche Stelle Wettbewerber-Preise zu HUTH WebApps übertragen wurden.

Verfügt der API-User etwa über die Rolle "Preismanager" besteht die Gefahr, dass alle durch den Import erzeugten Preisanforderungen sofort bestätigt werden.

 

Sofern noch kein Anwender vorhanden ist, muss zunächst ein Anwender und ein entsprechendes Anwenderkonto angelegt werden. Dem Anwender müssen keine Anwenderrollen zugewiesen werden.

 

Im Fenster des Anwenders finden Sie im rechten Bereich das Feld für die Erzeugung des API-Autorisierungsschlüssels.

Beispiel:

 

 

Klicken Sie auf diese Schaltfläche in de Menüleiste des Anwender-Fensters, um die Bearbeitung zu beginnen (die Optionen des Fensters werden aktiv).

  Klicken Sie auf diese Schaltfläche im Feld Autorisierungsschlüssel. Es öffnet sich das Fenster Autorisierungsschlüssel verwalten:

 

 

Klicken Sie auf diese Schaltfläche, um einen neuen Autorisierungsschlüssel zu erzeugen bzw. einen bestehenden Autorisierungsschlüssel zu bearbeiten. Ist noch kein Autorisierungsschlüssel angelegt, wird automatisch ein neuer Autorisierungsschlüssel angezeigt:

 

 

Sie wählen jetzt im Feld Service aus, für welchen API-Service Sie den Autorisierungsschlüssel erzeugen möchten:

 

Beispiel Preisimport-Service:

 

 

 

Über die zusätzliche Eingabe der IP-Adresse oder des Domain-Namens des Rechners, von dem aus der API-Anwender diesen Schlüssel nutzt, können Sie die Sicherheit für die Nutzung des Services erhöhen bzw. den Zugriff einschränken. Wenn der API-Anwender den Service mit diesem API-Key von einem anderen Rechner aus ausführt, wird der Zugriff blockiert.

 

Sie können noch einen Kommentar hinzufügen. Klicken Sie auf Übernehmen. Der Autorisierungsschlüssel wurde übernommen und wird Ihnen angezeigt:

 

 

 

Klicken Sie auf diese Schaltfläche, um die Daten des ausgewählten Autorisierungsschlüssels in die Zwischenanlage zu kopieren.

Wenn Sie dies zum ersten Mal durchführen, erhalten Sie eine Silverlight-Meldung, die Sie bestätigen müssen:

 

Klicken Sie auf diese Schaltfläche (oder doppelklicken Sie auf der Zeile), um den ausgewählten Autorisierungsschlüssel zu bearbeiten. Service-Typ und Schlüssel-Code können nicht mehr bearbeitet werden, Sie können aber noch einen Kommentar hinzufügen.

Klicken Sie auf diese Schaltfläche, um einen weiteren Autorisierungsschlüssel zu erzeugen.

Klicken Sie auf diese Schaltfläche, um einen vorhandenen Autorisierungsschlüssel zu löschen.

 

Schließen Sie das Fenster "Autorisierungsschlüssel verwalten" und Speichern Sie die geänderten Optionen im Anwender-Fenster.

 

Es können mehrere Autorisierungsschlüssel für einen API-Service erzeugt werden.

 

 

 

 

HUTH Elektronik Systeme GmbH  -  Stand: 04.03.2016  -  Autor: Frank-Olaf Nagel