メインコンテンツへスキップ

Management APIのリクエストサンプルはありますか？

  • 更新

FANSHIP Management APIのAPIリクエストサンプルをいくつかまとめました。
APIリクエストの参考としてご活用ください。

※本ガイドに記載のリクエストはあくまでサンプルとなります。
実際にご利用の際は、あらかじめ開発環境などでご確認の上、ご利用ください。

※本サンプルは、「curl」コマンドを利用したものとなっています。

※サンプルに含まれている変数は以下を意味しています。

  • ${POPINFO_HOST} = Management APIのホスト名　
  • ${POPINFO_AUTH} = 認証トークン
  • ${LOGIN_ID} = ログインID
  • ${PASSWORD} = パスワード
  • ${POPINFO_ID} = popinfo ID
  • ${ANDROID_POPINFO_ID} = Android端末のpopinfo ID
  • ${IPHONE_POPINFO_ID} = iPhone端末のpopinfo ID
  • ${MESSAGE_ID} = 配信ID
  • ${DEVICE_TYPE} = "android" or "iphone"

 

ログインAPI

仕様書：https://docs.fanship.jp/mapi/login.html
説明：認証tokenを作成し、取得するAPIリクエストです。

curl -X POST \
https://${POPINFO_HOST}/mapi/3.1/login/ \
-d '{
   "user_id": "${LOGIN_ID}",
   "password": "${PASSWORD}",
   "count_limit": 0,
   "time_limit": 0
}'

 

配信登録API（即時配信、全体配信）

仕様書：https://docs.fanship.jp/mapi/info.html
説明：プッシュ通知を全ユーザーに即時で配信するAPIリクエストです。

curl -X POST \
https://${POPINFO_HOST}/mapi/3.1/info/add/ \
-H 'Content-Type: application/json' \
-H "Authorization: PopinfoLogin auth=${POPINFO_AUTH}" \
-d '{
    "type": "instant",
    "content_type": "text/plain",
    "platform": [
        "iphone",
        "android"
    ],
    "popup": "ポップアップ",
    "title": "件名",
    "content": "本文"
}'

 

配信登録API （即時配信、ID指定配信）

仕様書：https://docs.fanship.jp/mapi/info.html
説明：プッシュ通知を特定ユーザーに即時で配信するAPIリクエストです。

curl -X POST \
https://${POPINFO_HOST}/mapi/3.1/info/add/ \
-H 'Content-Type: application/json' \
-H "Authorization: PopinfoLogin auth=${POPINFO_AUTH}" \
-d '{
    "type": "instant",
    "content_type": "text/plain",
    "platform": [
        "iphone",
        "android"
     ],
    "popup": " ポップアップ",
    "title": "件名",
    "content": "本文",
    "target_id": {
        "android": [
           "${ANDROID_POPINFO_ID}"
        ],
        "iphone": [
           "${IPHONE_POPINFO_ID}"
       ]
    }
}'

 

配信登録API（予約配信、全体配信）

仕様書：https://docs.fanship.jp/mapi/info.html
説明：プッシュ通知を全ユーザーに時間を指定して配信するAPIリクエストです。

curl -X POST \
https://${POPINFO_HOST}/mapi/3.1/info/add/ \
-H 'Content-Type: application/json' \
-H "Authorization: PopinfoLogin auth=${POPINFO_AUTH}" \
-d '{
   "type": "scheduled",
   "content_type": "text/plain",
   "platform": [
       "iphone",
       "android"
   ],
   "popup": "テスト配信",
   "title": "テスト件名",
   "content": "テスト本文",
   "send_time": "2023-03-01 16:00:00"
}'

 

テスト送信 API

仕様書：https://docs.fanship.jp/mapi/info.html
説明：プッシュ通知のテスト配信を特定ユーザー（テスト端末登録者）に送信するAPIリクエストです。

curl -X POST \
https://${POPINFO_HOST}/mapi/3.1/test/add/ \
-H 'Content-Type: application/json' \
-H "Authorization: PopinfoLogin auth=${POPINFO_AUTH}" \
-d '{
    "type": "instant",
    "content_type": "text/plain",
    "platform": [
        "iphone",
        "android"
    ],
    "popup": "ポップアップ",
    "title": "件名",
    "content": "本文",
    "target_id": {
        "android": [
            "${POPINFO_ID}"
        ],
        "iphone": [
            "${POPINFO_ID}"
        ]
    }
}'

 

配信一覧取得API

仕様書：https://docs.fanship.jp/mapi/list.html
説明：配信一覧を取得するAPIリクエストです。

curl -X GET \
https://${POPINFO_HOST}/mapi/3.1/info/ \
-H "Authorization: PopinfoLogin auth=${POPINFO_AUTH}"

 

配信情報取得API

仕様書：https://docs.fanship.jp/mapi/detail.html
説明：配信IDを指定し、配信内容の詳細情報を取得するAPIリクエストです。

curl -X GET \
https://${POPINFO_HOST}/mapi/3.1/info/${MESSAGE_ID} \
-H "Authorization: PopinfoLogin auth=${POPINFO_AUTH}"

 

登録者情報一覧取得 API

仕様書：https://docs.fanship.jp/mapi/user.html
説明：登録ユーザー（popinfo_id）の情報を取得するAPIリクエストです。
特定popinfo_idの「お知らせ受信の可否」「位置情報送信の有効」を取得しています。 

curl -X POST \
https://${POPINFO_HOST}/mapi/3.1/user/${DEVICE_TYPE}/ \
-H 'Content-Type: application/json' \
-H "Authorization: PopinfoLogin auth=${POPINFO_AUTH}" \
-d '{
    "fields": [
        "push_enabled",
        "location_enabled"
    ],
    "filter": [
        {
            "popinfo_id": {
                "$in": [
                    "${POPINFO_ID}"
                ]
            }
        }
    ]
}'

関連記事