メインコンテンツまでスキップ

インターフェース定義：アプリ配信依頼

処理概要​

リクエストで指定した配信先に対して、指定したアプリの配信を依頼します。

  • 配信するアプリのバージョンは、最新のバージョンです。
  • レスポンスを返すまでに、配信先へのアプリのインストールが完了する必要はありません、配信先へのアプリのインストール指示の受付が完了すれば良いです。

リクエスト​

リクエストボディに以下を必ず指定してください。

項目名型説明バリデーション
distributionIdstring端末のIDなど、配信先を一意に特定する情報最大50桁
applicationIdstringアプリのパッケージ名など、配信するアプリを一意に特定する情報最大50桁
requestIdstring配信依頼番号。Web APIでの配信依頼を一意に特定する情報、tance mallとMDM間の障害解析時に使うプレフィックス(ADT) + 半角英数字、半角ハイフン、半角アンダースコア、25桁
businessIdstringtance mallにおける配信依頼者が所属する店舗事業者のBusinessID英数8桁
tanceAccountstringtance mallにおける配信依頼者のメールアドレス最大255桁

レスポンス​

ステータスコード​

処理結果に応じて以下ステータスコードを返します。

コード意味どのような場合にコードを返すか
200成功配信処理の依頼が成功
400不正リクエストリクエストボディがバリデーションNG
リクエストで指定したdistributionIdまたはapplicationIdの資産が見つからない
etc...
401認証失敗リクエストヘッダーのAPI認証キーが間違っている
500サーバーエラーシステムダウン
DB接続失敗
他API連携失敗
etc...

レスポンスボディ​

ステータスコードに応じて異なります。

ステータスコードが200の場合​

項目名型説明形式桁数
requestIdstringリクエストボディで送信した配信依頼番号プレフィックス(ADT) + 半角英数字、半角ハイフン、半角アンダースコア25桁
receiptIdstring受付番号。tance mallとMDM間の障害解析時に使う半角英数字最大50桁

ステータスコードが400の場合​

項目名型説明形式桁数
requestIdstringリクエストボディで送信した配信依頼番号プレフィックス(ADT) + 半角英数字、半角ハイフン、半角アンダースコア25桁
messagestringtance mallの画面に表示するエラーメッセージ全角、半角の英数字記号最大200桁
errorInfostring障害解析に使うエラーメッセージ、tance mallとMDM間の障害解析時に使う全角、半角の英数字記号最大200桁

ステータスコードが上記以外の場合​

レスポンスボディは不要です。

例​

//************************
// 配信依頼成功の場合
//************************

// リクエストボディ
{
    "distributionId": "TM1325495211",
    "applicationId": "jp.co.tance.sample",
    "requestId": "ADTDjsp-oACT-CNvI29RFo7pg",
    "businessId": "T5498821",
    "tanceAccount": "sample@gmail.com"
}

// レスポンスボディ
{
    "requestId": "ADTDjsp-oACT-CNvI29RFo7pg",
    "receiptId": "id9lTKDlTuOxZ7nKGErXGz"
}


//************************
// 不正リクエストの場合
//************************

// リクエストボディ
{
    "distributionId": "TM1325495211",
    "applicationId": "jp.co.tance.sample",
    "requestId": "ADTDjsp-oACT-CNvI29RFo7pg",
    "businessId": "T5498821",
    "tanceAccount": "sample@gmail.com"
}

// レスポンスボディ
{
    "requestId": "ADTDjsp-oACT-CNvI29RFo7pg",
    "message": "指定した配信先端末(TM1325495211)が見つかりません",
    "errorInfo": "[ERROR CODE:YX120001] terminal(terminalId:TM1325495211) was not found"
}

に最終更新