基本情報取得API

概要

ご利用のpopinfoアカウント基本情報の取得を行います。

URL

https://${POPINFO_HOST}/mapi/3.0/account/

メソッド

GET

結果タイプ

単数を返却する

リクエストパラメータ

なし

レスポンスパラメータ

リクエストボディーに以下パラメータが含まれます。

キー名	タイプ	説明
name	文字列	アカウント名
name_en	文字列	アカウント名(アルファベット)
platforms	object	ご利用可能なプラットフォームの設定
icon_url	文字列	基本アイコンのURL
show_account_warning	真偽値	本番用注意喚起

platforms のobject には、契約いただいているプラットフォームごとに 下表の設定情報が返却されます。

ご契約頂いていないプラットフォームは、キー自体が返却されません。

iPhone

キー名	説明
application_id	アプリケーションID
apns_server_type	PUSH通知証明書のモード(developer or production)
expiration_date	証明書の有効期限
use_badge	端末に未読バッジを表示するかどうか
is_preminum	プレミアム会員識別
sendrate	デフォルトの送信レート

Android

キー名	説明
application_id	アプリケーションID
gcm_auth_key	GCMアカウントの認証キー (伏字)
use_badge	端末に未読バッジを表示するかどうか
is_preminum	プレミアム会員識別
sendrate	デフォルトの送信レート
project_id	firebaseのプロジェクトID
use_apiv1	firebaseのHTTP V1 APIの使用有無(false: Legacy or true: HTTP V1)

レスポンスのサンプル

{
  "status": "OK",
  "result": {
    "shop_id": 2,
    "name": "demo_shop",
    "name_en": "testshop2",
    "platforms": {
      "android": "内容は省略します。",
      "iphone": "内容は省略します。"
    },
    "icon_url": "http://path_to_icon.png",
    "show_account_warning": false,
    "password_valid_days": 90
  }
}