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

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 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 die REST-API-Quotengrenzen fest.

    Vorbereitungen

    Ordnen Sie dem Kanal in Ihrer benutzerdefinierten Chat-Integration Rich Controls zu.

    Erforderliche Rolle: admin

    Prozedur

    1. Erstellen Sie die REST-API.
      1. Navigieren zu Alle > System-Webservices > Scripted Web Services > Scripted REST APIs.
      2. Klicken Sie auf Neu.
      3. Füllen Sie die Felder des Formulars aus.
        Feld Beschreibung
        Name Name der 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: Benutzer 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, navigieren Sie zu Zugehörige Links, klicken Sie auf Versionsverwaltung aktivierenund 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 zur Registerkarte Ressourcen unter Zugehörige Links.
      2. Klicken Sie auf Neu.
        Rufen Sie die Nutzlast aus der Anforderung ab und schreiben Sie sie in eine Hybrid-Warteschlange.
      3. Füllen Sie die Felder des Formulars 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: Benutzer 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 Sicherheits- und Inhaltsverhandlungen für Ihre geskriptete REST-Ressource fest.
      Legen Sie Authentifizierungs- und Anforderungsformate fest. Wenn Ihre benutzerdefinierte Integration nicht auf die Authentifizierung angewiesen ist, sollten Sie sie wie folgt entfernen.
      1. Navigieren Sie im neuen Datensatz für die geskriptete REST-Ressource zur Registerkarte Sicherheit.
      2. Deaktivieren Sie Erfordert Authentifizierung.
      3. Klicken Sie auf die Registerkarte Inhaltsverhandlung und wählen Sie dann Unterstützte Anforderungsformate überschreiben aus.
      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 > Quotengrenzregeln.
      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 aufgelisteten 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 Felds aktualisieren, setzt die Now Platform die Anzahl der Anforderungen auf 0 zurück und löscht alle Verstöße für die aktuelle Stunde.
        Anwenden auf Benutzer, die durch diese Regel eingeschränkt sind. Wählen Sie Alle Benutzer aus.
      4. Klicken Sie auf Absenden.

    Nächste Maßnahme

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