Erstellen und konfigurieren Sie eine geskriptete REST-API für Ihre anwenderdefinierte Chat-Integration

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

    • Erstellen Sie eine geskriptete REST-API, fügen Sie eine geskriptete REST-Ressource hinzu, legen Sie Sicherheits- und Inhaltsverhandlungen fest, und legen Sie Grenzwerte für REST-API-Quoten fest.

    Vorbereitungen

    Ordnen Sie dem Kanal in Ihrer anwenderdefinierten Chat-Integration Rich-Steuerungen zu.

    Erforderliche Rolle: Administrator

    Prozedur

    1. Erstellen Sie die REST-API.
      1. Navigieren zu Alle > System-Webservices > Scripted Web Services > Scripted REST APIsan.
      2. Klicken Sie auf Neu.
      3. Füllen Sie die Felder des Formulars aus.
        Feld Beschreibung
        Name Name Ihrer API. Beispiel: ACME Mobile-App-Chat-Adapter .
        API-ID API-Bezeichner. Beispiel: acme_Chat .
        Schutzrichtlinie Die Schutzrichtlinie für das Skript.
        • Schreibgeschützt : Skript kann nur angezeigt werden.
        • Geschützt : Anwender mit Passwortberechtigungen können das Skript bearbeiten.
        Anwendung Die Anwendung, die den Skriptdatensatz enthält. Global Ist standardmäßig ausgewählt.
        API-Namespace Der Namespace, zu dem die API gehört. Der Wert hängt vom aktuellen Anwendungsbereich ab.
      4. Klicken Sie auf Absenden.
      5. Wahlweise: Öffnen Sie den neuen Datensatz, und navigieren Sie zu Zugehörige Links Und klicken Sie auf Aktivieren Sie Die Versionsverwaltung , Und klicken Sie dann auf OK .
        Klicken Sie auf Aktualisieren, um die Änderungen zu speichern.
    2. Fügen Sie Ihrer neuen REST-API eine geskriptete REST-Ressource hinzu.
      Die geskriptete REST-Ressource definiert die von Ihnen erstellte geskriptete REST-API-Definition.
      1. Öffnen Sie den von Ihnen erstellten REST API-Datensatz, und navigieren Sie dann zu Ressourcen Registerkarte unter Zugehörige Links .
      2. Klicken Sie auf Neu.
        Rufen Sie die Nutzlast aus der Anforderung ab, und schreiben Sie sie dann in eine Hybrid-Warteschlange.
      3. Füllen Sie im Formular die Felder aus.
        Feld Beschreibung
        API-Definition Name der übergeordneten API.
        Anwendung Die Anwendung, die den Skriptdatensatz enthält.
        Name Name Ihrer API-REST-Ressource. Beispiel: ACME-Chat .
        API-Version API-Version. Beispiel: v1 .

        Dieses Feld wird nur angezeigt, wenn Sie die Versionsverwaltung für die REST-API aktiviert haben.
        Aktiv Option zum Aktivieren der REST-Ressource.
        HTTP-Methode HTTP-Methode, z. B. POST, GET usw.
        Relativer Pfad Relativer Pfad zur Ressource.
        Skript Skript für die REST-Ressource.
        Schutzrichtlinie Die Schutzrichtlinie für das Skript.
        • Schreibgeschützt : Skript kann nur angezeigt werden.
        • Geschützt : Anwender mit Passwortberechtigungen können das Skript bearbeiten.
        Beispiel für eine geskriptete REST-Ressource:
        (function process(/*RESTAPIRequest*/ request, /*RESTAPIResponse*/ response) {
    var body = request.body;
    var queryParams = request.queryParams; // incoming content is application/x-www-form-urlencoded in this example    
    // get the provider application sys id. this can be done via a glide query using incoming data such as where the original message is being sent to. or it can be hard-coded such as this example.
    var providerAppId = "a5f8b75b7377001042281188caf6a73a";    
    // the time of receipt is recorded for analytics purposes
    var d = new Date();
    var logTime = d.getTime();    
    // add this message to the VA Server queue for processing
    var queued = sn_cs.VASystemObject.enqueueCustomAdapterMessage(providerAppId, JSON.stringify(queryParams), JSON.stringify(request.headers), logTime);
    if (queued == false) {
	response.setError(new sn_ws_err.BadRequestError('Failed to process the request.'));
    }
})(request, response);
​
    3. Legen Sie die Sicherheits- und Inhaltsverhandlung für Ihre geskriptete REST-Ressource fest.
      Wählen Sie diese Option, um Authentifizierungs- und Anforderungsformate festzulegen. Wenn Ihre anwenderdefinierte Integration nicht auf der Authentifizierung basiert, können Sie sie wie folgt entfernen.
      1. Navigieren Sie im neuen Datensatz für die geskriptete REST-Ressource zu Sicherheit Registerkarte.
      2. Löschen Erfordert Authentifizierung .
      3. Klicken Sie auf Inhaltsverhandlung Registerkarte und wählen Sie dann aus Überschreiben Sie unterstützte Anforderungsformate .
      4. Klicken Sie auf Absenden.
    4. Legen Sie REST-API-Quotengrenzen fest, um die Rate eingehender Anforderungen zu definieren.
      1. Navigieren zu Alle > System-Webservices > REST > Quotengrenzregelnan.
      2. Klicken Sie auf Neu.
      3. Füllen Sie die Felder des Formulars aus.
        Feld Beschreibung
        Name Eindeutiger Name für die Quotengrenzregel.
        REST-API REST-API, die Sie in einem früheren Schritt erstellt haben.
        Version Version der REST-API. Die aufgeführten Werte hängen von der ausgewählten REST API ab.
        Ressource Ressource für die angegebene Version. Die aufgeführten Werte hängen von der ausgewählten Version ab.
        Aktiv Aktivieren Sie die Checkbox, um anzugeben, dass die Quotengrenzregel aktiv ist.

        Quotengrenzregeln werden standardmäßig aktiviert, sobald Sie sie erstellen. Sie können Quotengrenzregeln deaktivieren, um die Durchsetzung einer Quotengrenze zu beenden, oder Quotengrenzregeln aktivieren, um die Quotengrenze wieder zu erzwingen.
        Anforderungsbegrenzung pro Stunde Die maximal zulässige Anzahl von Anforderungen pro Stunde.
        Hinweis:
        Immer wenn Sie den Wert dieses Feldes aktualisieren, setzt die ServiceNow AI Platform die Anzahl der Anforderungen auf 0 zurück und löscht alle Verstöße für die aktuelle Stunde.
        Anwenden auf Anwender, die durch diese Regel eingeschränkt sind. Wählen Sie Aus Alle Anwender .
      4. Klicken Sie auf Absenden.

    Nächste Maßnahme

    Erstellen Sie die Aktionsskripts für Ihre anwenderdefinierte Chat-Integration