プッシュインストール API

  • リリースバージョン: Washingtondc
  • 更新日 2024年02月01日
  • 読む6読むのに数分

    • プッシュインストール API は、モバイルデバイスがアプリケーションからプッシュ通知を受信できるようにするトークンの登録および登録解除を行うためのエンドポイントを提供します。

    プッシュ通知は、重要なことを知らせる、またはアクションの実行を要求する、ユーザーのモバイル端末に表示されるテキスト メッセージです。

    カスタムモバイルアプリケーションを作成する場合、プッシュ通知を設定するには、デバイスをメーカーのサービスに登録する必要があります。サービスは、プッシュトークンを使用してそのデバイスに適切に通知を送信できるように、ユーザーのデバイスのアドレスを認識する必要があります。また、デバイスは通知を受信して対処できる必要があります。デバイスを登録してプッシュトークンを取得する方法については、デバイスのオペレーティングシステムの開発者向けドキュメントを参照してください。たとえば、Apple デバイスについては、次を参照してください：https://developer.apple.com/documentation/usernotifications/registering_your_app_with_apns

    プッシュインストール - POST /now/push/{pushApplicationName}/installation

    デバイスが指定されたアプリケーションからプッシュ通知を受信できるようにするトークンを追加または更新します。

    URL 形式

    バージョニングされた URL：/api/now/{api_version}/push/{pushApplicationName}/installation

    デフォルトの URL：/api/now/push/{pushApplicationName}/installation

    サポートされている要求パラメーター

    表 : 1. パスパラメーター
    パラメーター 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    pushApplicationName プッシュ通知を登録するアプリケーションの名前。このパラメーターは、プッシュアプリケーション [sys_push_application] テーブルの関連するアプリケーションの [名前] 列の値と同じである必要があります。

    データタイプ：文字列
    表 : 2. クエリパラメーター
    名前 説明
    なし
    表 : 3. 要求本文パラメーター (XML または JSON)
    要素 説明
    platform プッシュ通知を登録するプラットフォーム。このパラメーターは、プッシュプラットフォーム [sys_push_platform] テーブルの [名前] 値である必要があります。

    データタイプ：文字列
    token プッシュ通知を受信できるようにモバイルアプリケーションを登録するときに、Apple などのデバイスメーカーによって提供されるトークン。エンドポイントは、トークン値をプッシュ通知インストール [sys_push_notif_app_install] テーブルに書き込みます。

    データタイプ：文字列

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 4. 要求ヘッダー
    ヘッダー 説明
    Content-Type 要求本文のデータ形式。application/json のみをサポートします。
    表 : 5. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 6. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    500 内部サーバーエラー。サーバー側のコードで論理エラーが発生しました。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    なし

    サンプル cURL 要求

    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

    プッシュインストール - POST /now/push/{pushApplicationName}/removeInstallation

    モバイルデバイスが指定されたアプリケーションからプッシュ通知を受信できるようにするトークンを無効にします。

    URL 形式

    バージョニングされた URL：/api/now/{api_version}/push/{pushApplicationName}/removeInstallation

    デフォルトの URL：/api/now/push/{pushApplicationName}/removeInstallation

    サポートされている要求パラメーター

    表 : 7. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    pushApplicationName プッシュ通知の登録を解除するアプリケーションの名前。このパラメーターは、プッシュアプリケーション [sys_push_application] テーブルの関連するアプリケーションの [名前] 列の値と同じである必要があります。

    データタイプ：文字列
    表 : 8. クエリパラメーター
    名前 説明
    なし
    表 : 9. 要求本文パラメーター (XML または JSON)
    要素 説明
    platform プッシュ通知を登録するプラットフォーム。このパラメーターは、プッシュプラットフォーム [sys_push_platform] テーブルの [名前] 値である必要があります。

    データタイプ：文字列

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 10. 要求ヘッダー
    ヘッダー 説明
    Content-Type 要求本文のデータ形式。application/json のみをサポートします。
    表 : 11. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 12. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    500 内部サーバーエラー。サーバー側のコードで論理エラーが発生しました。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    なし

    サンプル cURL 要求

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