API-Schlüssel konfigurieren – Tokenbasierte Authentifizierung

Konfigurieren Sie einen API-Schlüssel, um die Authentifizierung für REST API-Endpunkte zu unterstützen.

Vorbereitungen

Erforderliche Rolle: admin

Erforderliches Plugin: API Key und HMAC-Authentifizierung (com.glide.tokenbased_auth)

Prozedur

1. Erstellen Sie ein eingehendes Authentifizierungsprofil.
   1. Navigieren zu Alle > System-Webservices > API-Zugriffsrichtlinien > Eingehende Authentifizierungsprofilean.
   2. Wählen Sie Neu.
      Das System zeigt die Meldung Welche Art von Authentifizierungsprofil?
   3. Wählen Sie Authentifizierungsprofile für API-Schlüssel erstellen aus.
      
   4. Füllen Sie die Felder des Formulars aus.

      Tabelle : 1. API-Schlüsselauthentifizierungsprofile

      Feld	Beschreibung
      Name	Name zur Identifizierung der Authentifizierungsrichtlinie.
      Anwendung	Geltungsbereich der Authentifizierungsrichtlinie.
      Auth-Parameter	Wählen Sie den Authentifizierungsparameter für die Authentifizierungsanforderung aus. Sie können die Standardoptionen auswählen oder einen neuen Authentifizierungsparameter erstellen: x-sn-apikey: Auth-Header x-sn-apikey: Abfrageparameter-Header

      Hinweis:

      Die ausgewählte Option muss im REST-Aufruf als Teil des Auth-Headers oder Abfrageparameters definiert werden.

      
   5. Bestätigen Sie das Formular.
2. Erstellen Sie einen REST-API-Schlüssel.
   1. Navigieren zu Alle > System-Webservices > API-Zugriffsrichtlinien > REST-API-Schlüsselan.
   2. Wählen Sie Neu.
   3. Füllen Sie im Formular die folgenden Felder aus:

      Tabelle : 2. API-Schlüssel

      Feld	Beschreibung
      Name	Name zur Identifizierung des REST API-Schlüssels
      Beschreibung	Beschreibung für den REST API-Schlüssel.
      Aktiv	Status des REST API-Schlüssels.
      Anwender	Anwender, der dem REST API-Schlüssel zugeordnet ist. Verwenden Sie das Suchsymbol, um den Anwender auszuwählen.
      Authentifizierungsbereich	Option zum Hinzufügen des Authentifizierungsbereichs, um die Berechtigung des REST-API-Schlüssels zu verwalten.
      Token	Der von Now Platformgenerierte REST-API-Schlüssel. Kopieren Sie den Schlüssel, der als Teil des REST-API-Aufrufs innerhalb des Header- oder Abfrageparameters verwendet werden soll.
      Ablauf	Zeitpunkt, nach dem die Anmeldeinformationen nicht mehr gültig sind. Ein leerer Wert bedeutet keinen Ablauf. Hinweis: Weitere Informationen zum Ablauf des Tokens finden Sie unter Token-Ablauf bereinigen.

   4. Bestätigen Sie das Formular.
   5. Öffnen Sie den erstellten Datensatz, um das von Now Platform für den Benutzer generierte Token anzuzeigen.
      
3. Erstellen Sie eine REST-API-Zugriffsrichtlinie.
   1. Navigieren zu Alle > System-Webservices > REST API-Zugriffsrichtlinienan.
   2. Wählen Sie Neu.
   3. Füllen Sie die Felder des Formulars aus.

      Tabelle : 3. API-Zugriffsrichtlinien

      Feld	Beschreibung
      Name	Eindeutiger Name der API-Zugriffsrichtlinie.
      Aktiv	Option zum Aktivieren der API-Zugriffsrichtlinie.
      REST-API	Die REST API, auf die die Zugriffsrichtlinie angewendet wird. Beispiel: Anhang-API.
      REST-API-PFAD	API-Pfad der REST API. Dieses Feld wird basierend auf der ausgewählten REST API automatisch ausgefüllt. Beispiel: now/attachment.
      HTTP-Methode	Methode für die Interaktion mit der API. Dieses Feld wird basierend auf der ausgewählten REST API automatisch ausgefüllt.
      Version	Version der API. Beispiel: v1. Dieses Feld wird basierend auf der ausgewählten REST API automatisch ausgefüllt. Hinweis: Wenn Sie eine Authentifizierungsrichtlinie für alle Versionen einer REST API erstellen möchten, müssen Sie für jede Version eine eigene Richtlinie erstellen.
      Ressource	Untergeordnete Ressource der REST API. Dieses Feld wird basierend auf der ausgewählten REST API automatisch ausgefüllt. Beispiel: /now/attachment
      Anwendung	Umfang der Anwendung.
      Global	Aktivieren Sie dieses Feld, um die Authentifizierungsrichtlinie auf alle Methoden, Versionen und Ressourcen der API anzuwenden. Hinweis: Tokenbasierte Authentifizierung ist in der globalen REST-API-Richtlinie nicht zulässig.
      Auf alle Methoden anwenden	Aktivieren Sie dieses Feld, um die Authentifizierungsrichtlinie für die API auf alle Methoden, Versionen und Ressourcen für die API anzuwenden.
      Auf alle Ressourcen anwenden	Aktivieren Sie dieses Feld, um die Authentifizierungsrichtlinie für die API auf alle Versionen anzuwenden.
      Auf alle Versionen anwenden	Aktivieren Sie dieses Feld, um die Authentifizierungsrichtlinie für die API auf alle Ressourcen anzuwenden.

      
   4. Fügen Sie das erstellte API-Authentifizierungsprofil hinzu.
   5. Bestätigen Sie das Formular.
   Sie können den REST-API-Aufruf mit dem x-sn-apikey (Token) senden, der von Now Platform während der Erstellung des API-Schlüssels generiert wurde, je nach Konfiguration für die Authentifizierung im Header- oder Abfrageparameter.

   Warnung:

   Verwenden Sie die POST -Anforderung, wenn Sie vertrauliche Informationen an den Server übermitteln.