コンテンツにスキップ

DAuth APIを使ってみる

はじめに

Rakuten Rapid APIマーケットプレイスのテスト機能を使って、簡単に次のことを確認することができます。

  • DAuth APIの動作確認(クライアントアプリケーション不要)
  • 自分で作成したアプリケーションからDAuth APIを呼び出す方法(コードスニペット)

画面

準備するもの

  • YubiKey
  • インターネットに接続したPC (Webブラウザ)

環境

DAuthのトライアル版(Rakuten Rapid APIマーケットプレイスモデル)で構築します。

料金は発生しませんが、下記の制限があります。

  • APIのリクエスト数に上限(ハードリミット)がある
  • 利用期限は1ヶ月間

この制限は、通常プランに変更することで解除できます。 通常プランへの切り替え方法は、こちらを参照してください。

チュートリアル開始

1. Rakuten Rapid APIマーケットプレイスにアクセスし登録する

既にRakuten Rapid APIのアカウントをお持ちの方は、本作業は行わず"手順2"に進んでください。

1. WebブラウザからURL https://api.rakuten.net/marketplaceにアクセスする。

2. 右上の[新規登録]をクリックする。

3. 必要事項を入力し新規登録します。
(トライアル版はクレジットカードの登録は不要です)

2. DAuthのアカウント作成フォームから新規登録

2-1. WebブラウザからURL https://console.d-auth.com/rapid/signupにアクセスする。

画面

2-2. 必要事項を入力し、[トライアル(評価版)]にチェックを付け、アカウントを作成します。

画面

2-3. [ログイン画面のURL]をクリックします。
(URL記載したメールが、登録したメールアドレスに送信されています)

3. APIキーを作成する

3-1. DAuthのWebコンソールにログインする。

画面

3-2. APIキーの管理画面に移動する。

画面

3-3. [新規作成]をクリックする。

画面

3-4. 必要事項を入力して[保存]をクリックする。

画面

[YubiKey API(認可)]と[DKVS API(認可)]は、今回全APIの動作を確認する為、全てにチェックをします。 自分のクライアントアプリケーションで使用する場合は、必要最低限の項目のみチェックをしてください。 各項目の詳細は、こちらを参照してください。

3-5. APKキーが発行されます。

画面

作成したAPIキーは、"手順6-3"で使用します。

4. YubiKeyを登録する

4-1. YubiKeyの管理画面に移動する。

画面

4-2. [新規作成]をクリックする。

4-3. 必要事項を入力して[保存]をクリックする。

画面

[ネームスペース]は、"手順3-5"で作成したAPIキーのネームスペースと同じにします。

画面はYubiKey購入後にAESを変更していないときの入力例です。
AESを変更したYubiKeyを登録する場合は、独自AESにチェックを付け、AESを入力する必要があります。 各項目の詳細は、こちらを参照してください。

5. Device KVSにデータを登録する

5-1. YubiKeyの管理画面で、YubiKeyを選択する。

画面

5-2. [DKVS追加]をクリックする。

5-3. 必要事項を入力して[保存]をクリックする。

画面

[デバイスID]と[ネームスペース]は、選択したYubiKeyの値が自動で入力されます。

[Key]に、Key Value StoreのKey(検索キー)を入力します。
入力した値は"手順6-3"で使用します。今回は"Key1"と入力します。

[Value]に、任意のデータを入力します。JSON形式に対応しています。
各項目の詳細は、こちらを参照してください。

5-4. DKVSの管理画面で、登録したデータが存在するのを確認します。

画面

6. DAuth APIの動作を使ってみる

6-1. トライアル(評価版)のDAuthエンドポイントにアクセスします。
トライアル(評価版) DAuth API エンドポイントにアクセスしてください。

画面

"手順1"で作成したRakuten Rapid API用アカウントでログインします。

6-2. 動作確認したいAPIをクリックします。

画面

ここでは、[Get value from Device KVS]を選択します。

6-3. APIの各種パラメータを入力します。

  • [X-DAUTH-API-KEY] : "手順3-5"のAPIキーを貼り付けます。
  • [otp] : "手順4-3"で登録したYubiKeyのワンタイムパスワードを入力します。
  • [key] : "手順5-3"で登録したkey(例 key1)を入力します。

6-4. [テスト]をクリックします。

画面

6-5. [結果]にAPIの結果が表示されます。

他のAPIも同様に、Webプラウザ上で動作を確認することができます。
エラーや、List APIが0件になる場合は、よくある質問をご参照ください。

6-6. 各プログラム言語・ライブラリのコードスニペットを取得します。

画面

[コードスニペット]をクリックします。

プログラム言語とライブラリを選択すると、コードスニペットが生成されます。
これを開発しているクライアントアプリケーションに貼り付けることで、 DAuth APIを簡単に使うことができます。

以上で、Step 1のチュートリアルは終了です。