Request API

1.概要

Request API は、ゲーム上でユーザー間のメッセージ送信及び、メッセージ情報にアクセスします。
ユーザーAがユーザーBにヘルプ要請を送るなどの利用が想定されます。
Requestオブジェクトの「title」「body」は、利用サービス側で指定して下さい。
ユーザーに任意文字は入力させないでください。

2.オブジェクトフィールド

2.1 Request

パラメータ 内容 型
id リクエストid integer
senderid 利用者のユーザーID string
receiverid 送信先のユーザーID string
title タイトル string
body メッセージ string

3.リクエスト

3.1 エンドポイント

http://gpf-api.[対象ドメイン]/social/request/{requestid}

3.2 HTTPメソッド

HTTPメソッド 機能
GET リクエスト情報の取得
PUT –
POST リクエスト情報の作成
DELETE リクエスト情報の削除

3.3 認証

HTTPヘッダーに以下の値を設定してください。全て必須項目です。

キー 値
Authorization 呼び出しユーザーのsapkeyを指定
GAME_CODE 利用ゲームのGAME_CODE
Hash SHA1(Authorizaion + GAME_CODE + API_KEY)

3.4 テンプレートパラメータ

requestid

パラメータ 内容 備考
@all 全てのリクエストを対象とする GET DELETE時 必須
{requestid} 個別のリクエストを対象とする GET DELETE時 必須

4.レスポンス

HTTPメソッド レスポンスコード 内容
GET 200 データ取得正常終了
POST 201 データ作成正常終了
DELETE 202 データ削除正常終了
GET/POST/DELETE 400 リクエスト不正
GET/POST/DELETE 401 認証失敗
PUT 403 許可されていないメソッド
DELETE 404 存在しないデータ
GET 500 プラットフォームエラー

X.サンプル

ユーザーAを指定するには、AuthorizationがユーザーAのsapkeyである必要があります。
X.1 ユーザーAからユーザーBにリクエスト送信を行う

リクエスト http://gpf-api.ymdunisys.jp/social/request/
JSON {“body”:”リクエスト内容”,”title”:”リクエストタイトル”,
“receiverid”:”ユーザーBのsapkey”}

X.2 ユーザーAのリクエスト情報を全て削除する

リクエスト http://gpf-api.ymdunisys.jp/social/request/@all
備考 GAME_CODEと同じゲーム内のリクエストのみを削除します。

X.3 ユーザーAの特定のリクエスト情報を削除する

リクエスト http://gpf-api.ymdunisys.jp/social/request/{requestid}
備考 GAME_CODEと同じゲーム内のリクエストのみを削除します。
{requestid}にはGET時に取得したJSONデーターのidと同じ値を指定します。

X.4 ユーザーAの全てのリクエスト情報を取得する

【リクエスト】
/social/request/@all
【レスポンス】
{
    "entry":[
        {
            "body":"本分です",
            "id":"1",
            "receiverid":"115125257456e5fe06c5e59e759e2030ffedfe2e1dc7742b5801a661f844971f",
            "senderid":"1151252574130c50684384386c99268003465a46d9c732c0b5baecdaed631dfa",
            "title":"タイトルです"
        },
        {
            "body":"リクエスト本文２です",
            "id":"5",
            "receiverid":"115125257456e5fe06c5e59e759e2030ffedfe2e1dc7742b5801a661f844971f",
            "senderid":"1151252574130c50684384386c99268003465a46d9c732c0b5baecdaed631dfa",
            "title":"タイトル２です"
        }
    ],
    "itemsPerPage":0,
    "startIndex":0,
    "totalResults":2
}

X.5 ユーザーAの特定のリクエスト情報を取得する

【リクエスト】
/social/request/1
【レスポンス】
{
    "entry":[
        {
            "body":"発言内容本文です。",
            "id":"1",
            "receiverid":"115125257456e5fe06c5e59e759e2030ffedfe2e1dc7742b5801a661f844971f",
            "senderid":"1151252574130c50684384386c99268003465a46d9c732c0b5baecdaed631dfa",
            "title":"タイトルです"
        }
    ],
    "itemsPerPage":0,
    "startIndex":0,
    "totalResults":1
}