Push-Installations-API

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 3 Minuten Lesedauer

    • Die Push-Installations -API bietet Endpunkte zum Registrieren und Aufheben der Registrierung der Token, mit denen Mobilgeräte Push-Benachrichtigungen von einer Anwendung empfangen können.

    Eine Pushbenachrichtigung ist eine Textnachricht, die auf dem mobilen Gerät eines Benutzers angezeigt wird, um ihn auf etwas Wichtiges hinzuweisen oder ihn zu einer Aktion aufzufordern.

    Wenn Sie benutzerdefinierte mobile Anwendungen erstellen, müssen Sie das Gerät beim Service des Herstellers registrieren, um Push-Benachrichtigungen einzurichten. Der Service muss die Adresse des Geräts eines Benutzers kennen, damit Benachrichtigungen mithilfe von Push-Token ordnungsgemäß an dieses Gerät gesendet werden können. Das Gerät muss auch in der Lage sein, die Benachrichtigungen zu empfangen und darauf zu reagieren. Anweisungen zum Registrieren eines Geräts und zum Abrufen eines Push-Tokens finden Sie in der Entwicklerdokumentation des Betriebssystems des Geräts. Informationen zu Apple-Geräten finden Sie beispielsweise unter https://developer.apple.com/documentation/usernotifications/registering_your_app_with_apns.

    Push-Installation – POST /now/push/{pushApplicationName}/installation

    Fügt Token hinzu oder aktualisiert sie, mit denen Geräte Push-Benachrichtigungen von der angegebenen Anwendung empfangen können.

    URL-Format

    Versionierte URL: /api/now/{api_version}/push/{pushApplicationName}/installation

    Standard-URL: /api/now/push/{pushApplicationName}/installation

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfad-Parameter
    Parameter Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    pushApplicationName Name der Anwendung, für die die Push-Benachrichtigungen registriert werden sollen. Dieser Parameter muss mit dem Wert in der Spalte Name für die zugeordnete Anwendung in der Tabelle „Anwendung übertragen“ [sys_push_application] identisch sein.

    Datentyp: Zeichenfolge
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 3. Anforderungstextparameter (XML oder JSON)
    Element Beschreibung
    platform Plattform, auf der die Push-Benachrichtigung registriert werden soll. Dieser Parameter muss der Wert Name aus der Tabelle „Push-Plattform“ [sys_push_platform] sein.

    Datentyp: Zeichenfolge
    Token Token, das vom Gerätehersteller, z. B. Apple, bereitgestellt wird, wenn die mobile Anwendung für den Empfang von Push-Benachrichtigungen registriert wird. Der Endpunkt schreibt den Tokenwert in die Tabelle „Installation von Push-Benachrichtigungen“ [sys_push_notif_app_install].

    Datentyp: Zeichenfolge

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.

    Tabelle : 4. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 5. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Im serverseitigen Code ein logischer Fehler aufgetreten.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    Keine

    Beispiel für eine cURL-Anforderung

    curl -X POST \
  https://instance.servicenow.com/api/now/push/ServiceNowPushApp/installation \
--header "Content-Type: application/json" \
--user "username":"password" \
--data '{"platform":"Apple","token":"544836d77ac2e551bbf78204630509a7d494fc87f52e85da52e5b5d42910e2cf"}' \
    None

    Push-Installation – POST /now/push/{pushApplicationName}/removeInstallation

    Deaktiviert die Token, mit denen Mobilgeräte Push-Benachrichtigungen von der angegebenen Anwendung empfangen können.

    URL-Format

    Versionierte URL: /api/now/{api_version}/push/{pushApplicationName}/removeInstallation

    Standard-URL: /api/now/push/{pushApplicationName}/removeInstallation

    Unterstützte Anforderungsparameter

    Tabelle : 7. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    pushApplicationName Name der Anwendung, für die die Registrierung der Push-Benachrichtigungen aufgehoben werden soll. Dieser Parameter muss mit dem Wert in der Spalte Name für die zugeordnete Anwendung in der Tabelle „Anwendung übertragen“ [sys_push_application] identisch sein.

    Datentyp: Zeichenfolge
    Tabelle : 8. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 9. Anforderungstextparameter (XML oder JSON)
    Element Beschreibung
    platform Plattform, auf der die Push-Benachrichtigung registriert werden soll. Dieser Parameter muss der Wert Name aus der Tabelle „Push-Plattform“ [sys_push_platform] sein.

    Datentyp: Zeichenfolge

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.

    Tabelle : 10. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 11. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.

    Tabelle : 12. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Im serverseitigen Code ein logischer Fehler aufgetreten.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    Keine

    Beispiel für eine cURL-Anforderung

    curl -X POST \
  https://instance.servicenow.com/api/now/push/ServiceNowPushApp/removeInstallation \
--header "Content-Type: application/json" \
--user "username":"password" \
--data '{"platform":"Apple"}' \
    None