MobageCard Incentive API

This page is not available in English.
Please select another language.

概要

MobageCard Incentive API とは、MOBAGE CARD(クレジットカード会社提携カード)を利用しているユーザーに対して、MOBAGE CARD (http://dena.com/press/2013/10/mobage-card.php) の利用特典のひとつであるゲームインセンティブの利用状況の取得と変更を行う API となります。

MobageCard Incentive API の使い方
MobageCard Incentive API の詳細な使い方について、下記の各ページをご参照下さい。
[ngCore SDK] | [Native SDK] | [Unity SDK]


MobageCard Incentive オブジェクトフィールド

MOBAGE CARD によって受け取れるインセンティブの状態を表します。

説明読み取り専用
userIdintegerユーザーIDtrue
incentiveIdstringインセンティブIDtrue
levelintegerインセンティブのレベルtrue
availablebooleanインセンティブ利用状況false
usedAmountinteger確定したカード利用金額true
usedAmountStartDatestringusedAmount の集計開始日true
usedAmountEndDatestringusedAmount のカード締め日true
currentUsedAmountinteger未確定(=締め日前)のカード利用金額true
currentUsedAmountStartDatestringcurrentUsedAmount の集計開始日true
currentUsedAmountEndDatestringリクエストを受けた前日の日付true
isConsumedAppbooleanインセンティブを消費したアプリかどうかtrue

HTTP メソッド


3-leggedによる認証 ( Proxy モデル )

  • GET
    • ユーザーの最新の incentiveId を取得する
    • ユーザーの incentiveId を明示して取得する
  • PUT
    • ユーザーのインセンティブを使用する

mobageCardIncentiveState.get

API の定義

REST Base URI

http://sp.mbga-platform.jp/social/api/restful/v2 ( Service ) 
http://sb.sp.mbga-platform.jp/social/api/restful/v2 ( Sandbox ) 

REST HTTP Method

GET

REST URI Fragment

/people{/userId}/@self/mobagecard{?fields}
/people{/userId}/@self/mobagecard{/incentiveId}{?fields}

Return Object

なし

リクエストパラメータ

必須デフォルト値説明
userIdstringtrue 対象となるユーザIDを指定します。ユーザIDが判定可能な場合に @me を指定することができます。
fieldsarrayfalse
取得するフィールド。指定したもののみを取得したい場合に設定します
     

 

 

 

 

 

RESTful API レスポンスコード

codemessage説明
200OK正常にリソースが取得できた場合
400Bad RequestRequest Parameters に違反するパラメータが指定された時
401UnauthorizedAuthorization ヘッダ、または妥当なクライアントではない場合
403Forbiddenclient 情報と紐付かない appId が Request Parameters に指定された場合
404Not Found指定された userId がクレジットカード会員でない場合または指定されたインセンティブIDが存在しない場合
500Internal Server Errorサーバ側のエラーの場合
503Service Unavailableサーバ側の一時的なエラーの場合

RESTful API レスポンス内容

名前説明
userIdstringユーザーID
currentUsedAmountintegerカード締め日前の利用額
currentUsedAmountEndDatedateAPIリクエストを受けた時点の前日の日付
currentUsedAmountStartDatedate集計開始日(直近の締め日の翌日)
incentiveIdstringインセンティブID
levelintegerインセンティブのレベル
availablebooleanインセンティブの利用状況 
usedAmountinteger確定した(=締め日後の)カード利用額
usedAmountEndDatedateusedAmount の締め日
usedAmountStartDatedateusedAmount の集計開始日
isConsumedAppbooleanインセンティブを消費したアプリかどうか

 

サンプルデータ

ユーザーの最新の IncentiveId を取得する

GET /people/@me/@self/mobagecard
Authorization: OAuth oauth_parameters
  
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
Pragma: no-cache
 
{
  "entry" : [
    {
      "userId" : "1234",
      "incentiveId":"201309",
      "available":true,
      "level":50,
      "usedAmount" : 5000,
      "usedAmountEndDate" : "2013-09-15",
      "usedAmountStartDate" : "2013-08-16",
      "currentUsedAmount" : 3000,
      "currentUsedAmountEndDate" : "2013-09-20",
      "currentUsedAmountStartDate" : "2013-09-16",
      "isConsumedApp" : false
    } 
  ],
  "startIndex" : 1,
  "itemsPerPage" : 1,
  "totalResults"  : 1,
}

 

ユーザーの incentiveId を明示して取得する

GET /people/@me/@self/mobagecard/201309
Authorization: OAuth oauth_parameters
 
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
Pragma: no-cache
 
{
  "userId" : "1234",
  "incentiveId":"201309",
  "available":true,
  "level":50,
  "usedAmount" : 5000,
  "usedAmountEndDate" : "2013-09-15",
  "usedAmountStartDate" : "2013-08-16",
  "currentUsedAmount" : 3000,
  "currentUsedAmountEndDate" : "2013-09-20",
  "currentUsedAmountStartDate" : "2013-09-16",
  "isConsumedApp" : false
} 

 

mobageCardIncentiveState.update

API の定義

REST Base URI

http://sp.mbga-platform.jp/social/api/restful/v2 ( Service ) 
http://sb.sp.mbga-platform.jp/social/api/restful/v2 ( Sandbox ) 

REST HTTP Method

PUT

REST URI Fragment

/people{/userId}/@self/mobagecard{/incentiveId}{?fields}

Return Object

なし

 

リクエストパラメータ

必須デフォルト値説明
userIdstringtrue 対象となるユーザIDを指定します。ユーザIDが判定可能な場合に @me を指定することができます。
formatStringfalsejsonjson のみ指定可
fieldsarraytrue

 

Partial update の対象とする field を指定します。available, appId 両方の指定が必要です。

リクエスト内容

propertytypedescription
appIdstringアプリケーション ID
availablebooleanインセンティブ利用状況

サンプルデータ

ユーザーのインセンティブを使用する

PUT /people/@me/@self/mobagecard/201310?fields=appId,available
Authorization: OAuth oauth_parameters

{
  "appId" : "12000129",
  "available" : false
}
 
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
Pragma: no-cache
 
{
  "userId" : 123,
  "appId" : "12000129",
  "incentiveId" : "201310",
  "available" : false,
  "level":50,
  "isConsumedApp" : true
}

 

更新履歴

  • 2014/03/24
    • パラメータの記述を修正
  • 2013/11/13
    • 新規作成