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

リクエストの署名

RESTful API のリクエストを署名するためには、下記の 3 つの方法があります。API によって署名方法は異なりますが、どの署名方法を適用するかは各 API のリファレンスページをご参照下さい。

  • 2-legged(Trusted モデル)
    この方法では、リクエストはアプリの Consumer Key と Consumer Secret だけを利用して署名します。Access Token がまだ取得されていない場合やユーザに依存しない操作(Game-to-User のリモート通知など)、ユーザではなくゲームとして API を呼び出す場合に利用されます。

  • 3-legged(Proxy モデル)
    フルな OAuth 3-legged 認証です。リクエストは Consumer Key、Consumer Secret および Access Token、Access Token Secret を利用して署名します。Access Token の取得やユーザとして API を呼び出す場合に利用されます。主に Social API で利用できます。

  • OAuth2
    署名は必要ありませんが HTTPS 通信が必須になります。リクエストの Authorization ヘッダーに、bearer {oauth2_token} という文字列を含めるだけで済みます。{oauth2_token} は、Access Token の取得時に発行される OAuth2 Token の値に置き換えて下さい。Bank API のみに利用可能です。

    備考

API によっては、2-legged と 3-legged 方式の両方を受け付ける場合があります。署名の方式によっては処理が異なる場合があります。詳細については各 API のリファレンスページをご参照下さい。 :::

次に、各署名方式の詳細をみていきます。

2-legged(Trusted モデル)​

まず、Base String という署名の対象を作成します。次に、HMAC-SHA1 というハッシュアルゴリズムを用いて、アプリの Consumer Secret をキーにして Base String のハッシュを作り、それをリクエストの署名にします。最後に、リクエストの認証に必要な Authorization ヘッダーを作成し、リクエストの HTTP ヘッダーに追加します。

備考

2-legged 方式と 3-legged 方式は基本的には同じ処理を行いますが、3-legged 方式では Access Token を OAuth パラメータのリストに加え、ハッシュ時のキーは Consumer Secret と Access Token Secret の両方を利用します。

ステップ 1)Base String の作成​
  1. OAuth Parameter String というものを下記のように作成します。

    1. 下記パラメータを名前順にソートします。

    2. パラメータの名前とそれらの値を URLEncode (RFC 3986準拠) します。

    3. パラメータ名と値を "=" でジョインします。

    4. 各パラメータ名と値のペアをさらに "&" でジョインします。

      パラメータ説明値
      oauth_callbackリダイレクト URI"oob"に指定して下さい。
      oauth_consumer_keyアプリの Consumer Keyアプリ固有の Consumer Key、Mobage Developers から取得可能。
      oauth_nonce"Number used only once"、一度しか使わない数値ゲームサーバーで自由に生成して下さい。ただし、リクエストごとにユニークでなけれなりません。
      oauth_signature_methodハッシュ方式"HMAC-SHA1" を指定して下さい。
      oauth_timestampUNIX タイムスタンプリクエストのタイムスタンプ。ゲームサーバーで生成して下さい。
      oauth_verifierMobage SDK から取得した Verifier 文字列/request_token の場合のみ必要。
      oauth_versionOAuth バージョン"1.0" に指定して下さい。
      その他のパラメータ上記以外のクエリパラメータ上記以外のクエリパラメータ。例: param1=value1&param2=value2 の場合、"param1=value1"、"param2=value2" に分解し、上記各項とまとめてソートして下さい。
  2. 下記パラメータを URLEncode (RFC 3986 準拠) します。

    パラメータ説明
    リクエストメソッドHTTP リクエストメソッド:GET, POST, PUT, DELETE。
    API URLクエリ文字列を除外した URL。
    OAuth Parameter String上記手順で生成された OAuth Parameter String です。
  3. 上記 3 つのパラメータを "&" でジョインします。ここで出来上がった文字列は Base String といいます。

ステップ 2)oauth_signature の作成​
  1. アプリの Consumer Secret の末尾に "&" をつけ、Secret String とします。
  2. HMAC-SHA1 ハッシュアルゴリズムに、Base String を Secret String でハッシュします。
  3. HMAC-SHA1 の出力はバイナリデータのため、Base64 エンコードして最終の署名を作成します。
ステップ 3)Authorization ヘッダーの作成​
  1. 下記パラメータの名前とその値を URLEncode (RFC 3986 準拠)します。

  2. 値をダブル・クォーテーション・マークで囲み、パラメータ名と "=" でジョインします。

  3. パラメータ名とその値のペアを "," で区きり、ジョインします。

  4. オプショナルに realm パラメータを追加します。

  5. "OAuth "(末尾のスペース文字を含む)を上記で生成された文字列の先頭に追加します。

    パラメータ名値
    oauth_callback"oob" に指定して下さい。
    oauth_consumer_keyアプリ固有の Consumer Key、Mobage Developers から取得可能。
    oauth_nonceゲームサーバーで自由に生成して下さい。ただし、リクエストごとにユニークでなけれなりません。
    oauth_signature上記ステップ 2 の出力文字列。
    oauth_signature_method"HMAC-SHA1" を指定して下さい。
    oauth_timestampリクエストのタイムスタンプ。ゲームサーバーで生成して下さい。
    oauth_verifierMobage SDK から取得した Verifier 文字列。/request_token の場合のみ必要。
    oauth_version"1.0" に指定して下さい。

Authorization ヘッダーの実例​

Base String の各パラメータは下記の値を持ちます。

パラメータ値
Request MethodPOST
API URLhttps://ssl.sb.sp.mbga-platform.jp/social/api/oauth/v2.01/request\_temporary\_credential
oauth_callbackoob
oauth_consumer_keyc8bb6e04c60b9f6c0063
oauth_noncefa894d8b9be49cd5191ee126b02e4171
oauth_timestamp1380117217
oauth_signature_methodHMAC-SHA1
oauth_version1.0

上記パラメータで生成された Base String はこちらです。

注記

読みやすさのために改行を入れましたが、実際のところ一つのつながった文字列になります。

POST&
https%3A%2F%2Fssl.sb.sp.mbga-platform.jp%2Fsocial%2Fapi%2Foauth%2Fv2.01%2Frequest_temporary_credential&
oauth_callback%3Doob%26
oauth_consumer_key%3Dc8bb6e04c60b9f6c0063%26
oauth_nonce%3Dfa894d8b9be49cd5191ee126b02e4171%26
oauth_signature_method%3DHMAC-SHA1%26
oauth_timestamp%3D1380117217%26
oauth_version%3D1.0

Signature String はこちらです。

Ea2bmHas4x4Cd4CCR7ZrWn2gZMM=

最後に、Authorization ヘッダーはこちらになります。

Authorization: OAuth oauth_version="1.0",oauth_nonce="fa894d8b9be49cd5191ee126b02e4171",oauth_timestamp="1380117217",oauth_consumer_key="c8bb6e04c60b9f6c0063",oauth_callback="oob",oauth_signature_method="HMAC-SHA1",oauth_signature="Ea2bmHas4x4Cd4CCR7ZrWn2gZMM%3D"
備考

各 API のリファレンスページにも、Base String の例を掲載していますのでそちらでもご参照下さい。

3-legged(Proxy モデル)​

まず、Base String という署名の対象を作成します。次に、HMAC-SHA1 というハッシュアルゴリズムを用いて、アプリの Consumer Secret と Mobage プラットフォームから発行された Access Token Secret から厚生された文字列をキーにして Base String のハッシュを作り、それをリクエストの署名にします。最後に、リクエストの認証に必要な Authorization ヘッダーを作成し、リクエストの HTTP ヘッダーに追加します。

備考

2-legged 方式と 3-legged 方式は基本的には同じ処理を行いますが、3-legged 方式では Access Token を OAuth パラメータのリストに加え、ハッシュ時のキーは Consumer Secret と Access Token Secret の両方を利用します。

ステップ 1)Base String の作成​
  1. OAuth Parameter String というものを下記のように作成します。

    1. 下記パラメータを名前順にソートします。

    2. パラメータの名前とそれらの値を URLEncode (RFC 3986準拠) します。

    3. パラメータ名と値を "=" でジョインします。

    4. 各パラメータ名と値のペアをさらに "&" でジョインします。

      パラメータ説明値
      oauth_consumer_keyアプリの Consumer Keyアプリ固有の Consumer Key、Mobage Developers から取得可能。
      oauth_nonce"Number used only once"、一度しか使わない数値ゲームサーバーで自由に生成して下さい。ただし、リクエストごとにユニークでなけれなりません。
      oauth_signature_methodハッシュ方式"HMAC-SHA1" を指定して下さい。
      oauth_timestampUNIX タイムスタンプリクエストのタイムスタンプ。ゲームサーバーで生成して下さい。
      oauth_tokenOAuth Access TokenMobage プラットフォームから発行された Access Token。
      oauth_versionOAuth バージョン"1.0" に指定して下さい。
      その他のパラメータ上記以外のクエリパラメータ上記以外のクエリパラメータ。例: param1=value1&param2=value2 の場合、"param1=value1"、"param2=value2" に分解し、上記各項とまとめてソートして下さい。
  2. 下記パラメータを URLEncode (RFC 3986 準拠) します。

    パラメータ説明
    リクエストメソッドHTTP リクエストメソッド:GET, POST, PUT, DELETE。
    API URLクエリ文字列を除外した URL。
    OAuth Parameter String上記手順で生成された OAuth Parameter String です。
  3. 上記 3 つのパラメータを "&" でジョインします。ここで出来上がった文字列は Base String といいます。

ステップ 2)oauth_signature の作成​
  1. アプリの Consumer Secret と Mobage プラットフォームから発行された Access Token Secret を "&" でジョインし、Secret String とします。
  2. HMAC-SHA1 ハッシュアルゴリズムに、Base String を Secret String でハッシュします。
  3. HMAC-SHA1 の出力はバイナリデータのため、Base64 エンコードして最終の署名を作成します。
ステップ 3)Authorization ヘッダーの作成​
  1. 下記パラメータの名前とその値を URLEncode (RFC 3986 準拠)します。

  2. 値をダブル・クォーテーション・マークで囲み、パラメータ名と "=" でジョインします。

  3. パラメータ名とその値のペアを "," で区きり、ジョインします。

  4. オプショナルに realm パラメータを追加します。

  5. "OAuth "(末尾のスペース文字を含む)を上記で生成された文字列の先頭に追加します。

    パラメータ名値
    oauth_consumer_keyアプリ固有の Consumer Key、Mobage Developers から取得可能。
    oauth_nonceゲームサーバーで自由に生成して下さい。ただし、リクエストごとにユニークでなけれなりません。
    oauth_signature上記ステップ 2 の出力文字列。
    oauth_signature_method"HMAC-SHA1" を指定して下さい。
    oauth_timestampリクエストのタイムスタンプ。ゲームサーバーで生成して下さい。
    oauth_tokenOAuth Access Token
    oauth_version"1.0" に指定して下さい。

Authorization ヘッダーの実例​

Base String の各パラメータは下記の値を持ちます。

パラメータ名値
Request MethodGET
API URLhttp://sb.sp.mbga-platform.jp/social/api/restful/v2/social/api/restful/v2/people/@me/@self
oauth_consumer_keyc8bb6e04c60b9f6c0063
oauth_nonced224def28b2da93532f68f909e7c4680
oauth_signature_methodHMAC-SHA1
oauth_timestamp1380204695
oauth_tokensp_client_id:c2585ae2691471227feadcbc469dfbf8
oauth_version1.0
fieldsnickname

上記パラメータで生成された Base String はこちらです。

注記

読みやすさのために改行を入れましたが、実際のところ一つのつながった文字列になります。

GET&
http%3A%2F%2Fsb.sp.mbga-platform.jp%2Fsocial%2Fapi%2Frestful%2Fv2%2Fpeople%2F%40me%2F%40self&
fields%3Dnickname%26
oauth_consumer_key%3Dc8bb6e04c60b9f6c0063%26
oauth_nonce%3Dd224def28b2da93532f68f909e7c4680%26
oauth_signature_method%3DHMAC-SHA1%26
oauth_timestamp%3D1380204695%26
oauth_token%3Dsp_client_id%253Ac2585ae2691471227feadcbc469dfbf8%26
oauth_version%3D1.0

Signature String はこちらです。

CNLj8zRoeT/f/koOMa/5ucfPL2M=

最後に、Authorization ヘッダーはこちらになります。

Authorization: OAuth oauth_version="1.0",oauth_nonce="d224def28b2da93532f68f909e7c4680",oauth_timestamp="1380204695",oauth_consumer_key="c8bb6e04c60b9f6c0063",oauth_token="sp_client_id%3Ac2585ae2691471227feadcbc469dfbf8",oauth_signature_method="HMAC-SHA1",oauth_signature="CNLj8zRoeT%2Ff%2FkoOMa%2F5ucfPL2M%3D"
備考

各 API のリファレンスページにも、Base String の例を掲載していますのでそちらでもご参照下さい。

OAuth2​

Mobage プラットフォームから発行された oauth2_token 文字列を Authorization ヘッダーに追加するだけで完了します。なお、必ず HTTPS 通信を利用する必要があります。

下記は Authorization ヘッダーの例です。

Authorization: bearer 369dfdce13174503a609cce70767c188
備考

詳細については、Bank API の各ページを参照して下さい。

  • 2-legged(Trusted モデル)
  • 3-legged(Proxy モデル)
  • OAuth2