API-Schlüssel konfigurieren – Token-basierte Authentifizierung

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 2 Minuten Lesedauer

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

    Vorbereitungen

    Erforderliche Rolle: Administrator

    Erforderliches Plugin: API-Schlüssel 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 an Welche Art von Authentifizierungsprofil?
      3. Wählen Sie Aus Erstellen Sie API-Schlüssel-Authentifizierungsprofile .
        API-Schlüssel-Authentifizierungsprofil
      4. Füllen Sie im Formular die Felder aus.
        Tabelle : 1. API-Schlüssel-Authentifizierungsprofile
        Feld Beschreibung
        Name Name zur Identifizierung der Authentifizierungsrichtlinie.
        Anwendung Umfang 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: Authentifizierungsheader
        • X-sn-apikey: Header des Abfrageparameters
        Hinweis:
        Die ausgewählte Option muss im REST-Aufruf im Authentifizierungs-Header oder Abfrageparameter definiert werden.
        API-Parameter
        Hinweis:
        Wenn Sie ein Präfix für den API-Schlüssel hinzufügen möchten, öffnen Sie die von Ihnen ausgewählte Authentifizierungsparameterdatei, und geben Sie an Präfix Feld.
      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 generierte REST-API-Schlüssel ServiceNow AI Platform. Kopieren Sie den Schlüssel, der als Teil des REST-API-Aufrufs innerhalb des Header- oder Abfrageparameters verwendet werden soll.
        Ablauf Zeit, nach der 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 wird bereinigt.
      4. Bestätigen Sie das Formular.
      5. Öffnen Sie den Datensatz, der erstellt wurde, um das von generierte Token anzuzeigen ServiceNow AI Platform Für den Anwender.
        API-Token
    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 im Formular die Felder 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/Anhang .
        HTTP-Methode Für die Interaktion mit der API verwendete Methode. 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 einzelne Richtlinien 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 für die API anzuwenden.
        Hinweis:
        Token-basierte 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.
        Fügen Sie der Zugriffsrichtlinie ein Profil hinzu
      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 generiert wurde ServiceNow AI Platform Während der API-Schlüsselerstellung innerhalb des Headerparameters oder des Abfrageparameters basierend auf der Konfiguration für die Authentifizierung.
      Warnung:
      Verwenden VERÖFFENTLICHEN Anforderung, wenn vertrauliche Informationen an den Server übermittelt werden.