Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Sv translation
languageja


Section


Column

BellaDati APIにアクセスするにクライアントアプリケーションはOAuthプロトコルを介してユーザを認証する必要があります。OAuthの使い方の詳細については、OAuthガイドを参照してください。

定期的にOAuthプロトコルの一部として、ユーザが自分のWebブラウザでBellaDatiにログインする必要があります。このように、クライアントアプリケーションはユーザーの資格情報を管理する必要はなく、攻撃者がログインデータを傍受するリスクを軽減します。そのユーザの資格情報の責任を取る必要ない。Webブラウザを使用してクライアントワークフローのオプションではない場合は、代わりにこの文書の最後に記載されているxAuthを使用することができます。


Column
width300px


Panel

このページの上で:

Table of Contents
maxLevel2
minLevel1



POST /oauth/requestToken - リクエストトークンの取得

説明

認証プロセスの最初のステップでは、クライアントアプリケーションは残りのステップで使用する要求トークンを取得します。この方法は、OAuthのコア1.0仕様で許可されていないリクエストトークンの取得に対応しています。

リクエスト構造

URL

https://service.belladati.com/oauth/requestToken

方法

POST

パラメーター

  • oauth_consumer_key:アカウントのコンシューマキー。それを構成するには、ドメイン設定ページをご覧ください。
  • oauth_nonce: リプレイ攻撃を防ぐために、リクエストごとに一意に生成されるランダムな文字列。
  • oauth_timestamp: 現在のタイムスタンプ
  • oauth_callback: (任意)承認が完了した後にリダイレクトするコールバック

返却

リクエストトークンとURLエンコードで対応する要求トークンシークレット。このトークン/秘密のペアは、後で認証プロセスを完了し、アクセストークンを取得するために使用されます。これは、他のAPI呼び出しに使用できません。

サンプルリクエスト/レスポンス

Code Block
curl -d "oauth_consumer_key=myKey&oauth_nonce=7S0blJDv0G2g2iDoNM0QEMhcPPDahnHc&oauth_timestamp=1376571988" https://service.belladati.com/oauth/requestToken

ポストマン サンプルリクエスト/レスポンス

Image Added


Code Block
oauth_token=mh7an9dkrg59&oauth_token_secret=b9q1n5il4lcc

リクエストトークンを承認

説明

クライアントアプリケーションが要求トークンを受信した後、ユーザがAPIにアクセスするアプリケーションのためのトークンを承認する必要があります。これは、ユーザのWebブラウザで実行されます。

Info

あなたのクライアントはWebアプリケーションがある場合には、アプリケーションを指すようにドメイン設定ページでコールバックURLを設定できます。成功したリクエストトークンを承認した後、BellaDatiがアプリケーションに戻らせるユーザをリダイレクト用URLを使用します。

リクエスト構造

URL

https://service.belladati.com/authorizeRequestToken?oauth_token=requestToken&oauth_consumer_key=consumerKey&callbackUrl=http://your-server.com (ユーザのウェブブラウザで開く)

パラメーター

  • oauth_consumer_key: アカウントのコンシューマキー。それを構成するには、ドメイン設定ページをご覧ください。
  • oauth_token: 前の手順で取得したリクエストトークン。
  • callbackUrl: (任意)承認が完了した後にリダイレクトするコールバック

返却

ログインに成功した後、リクエストトークンが承認されます。ドメイン設定ページでコールバックURLが設定または定義されている場合、ユーザーはそのページにリダイレクトされます。

Image RemovedImage Added

POST /oauth/accessToken -アクセストークンの取得

説明

このステップでは、アクセストークンに対して許可された要求トークンを交換します。その後その後、アクセストークンを使用してBellaDati APIにアクセスできます。このメソッドは、OAuthコア1.0仕様からアクセストークンを取得することに対応します。

Note

以下のことを確認してください。

  • リクエストトークンは、同じコンシューマキーを使用して取得されています。
  • 要求トークンは以前にアクセストークンと交換されていません。

リクエスト構造

URL

https://service.belladati.com/oauth/accessToken

方法

POST

パラメーター

  • oauth_consumer_key: コンシューマキー
  • oauth_nonce:リプレイ攻撃を防ぐために、リクエストごとに一意に生成されるランダムな文字列。
  • oauth_timestamp:現在のタイムスタンプ
  • oauth_token:ステップ1で受信し、ステップ2で承認された認可要求トークン

リターンする

アクセストークンとURLエンコーディングの対応するアクセストークンシークレット。このトークンは、このトークンを使用してAPI呼び出しを行うことができます。

サンプルリクエスト/レスポンス

Code Block
curl -d "oauth_token=mh7an9dkrg59&oauth_consumer_key=myKey&oauth_nonce=7S0blJDv0G2g2iDoNM0QEMhcPPDahnHc&oauth_timestamp=1376571988" https://service.belladati.com/oauth/accessToken


Code Block
oauth_token_secret=08evn5ieuz84&oauth_token=nd7an9eba41c

Webブラウザなしの認証

説明

認証ワークフローでWebブラウザを使用してBellaDatiにログインできない場合は、xAuthプロトコルバリアントを使用して、アクセストークンを1つのステップで取得することができます。欠点は、クライアントアプリケーションがユーザーの資格情報を直接処理する必要があり、それらが安全な方法で取り扱われることを保証しなければならないことです。 

xAuthアクセスは、この機能が明示的に有効になっているドメインに制限されている。アプリケーションで通常のOAuthワークフローを使用できない場合は、ドメイン設定でxAuthを有効にすることができます。

Info

BellaDati On-PremisexAuthを使用するには、SSLを有効にする必要があります。

リクエスト構造

URL

https://service.belladati.com/oauth/accessToken

方法

POST

パラメーター

  • oauth_consumer_key: コンシューマキー。
  • oauth_nonce:リプレイ攻撃を防ぐために、リクエストごとに一意に生成されるランダムな文字列
  • oauth_timestamp: 現在のタイムスタンプ
  • x_auth_username : 認証しようとしているユーザー (warning) あなたのアプリに安全に格納する必要があります。

  • x_auth_password : ユーザのパスワード    (warning) あなたのアプリに安全に格納する必要があります。

返却

アクセストークンとURLエンコードの対応するアクセストークンシークレット。このトークンを使用してAPI呼び出しを行うことができます。

サンプルリクエスト/レスポンス

Code Block
titlecurlコマンドを使用し、`date +%s`コマンドを使用してタイムスタンプを生成する
curl -d "x_auth_username=user@belladati.com&x_auth_password=password&oauth_consumer_key=myKey&oauth_nonce=7S0blJDv0G2g2iDoNM0QEMhcPPDahnHc&oauth_timestamp=
`date +%s`" https://service.belladati.com/oauth/accessToken


Code Block
themeRDark
titlexAuth オプションがoauth_token とoauth_token_secretを返す。
oauth_token=42f5733a2f4e064fd75f3f4c9ba8c2ee&oauth_token_secret=23a1312c61c777d2a6e302fcae8fb43c

·         oauth_consumer_key:アカウントのコンシューマキー。それを構成するには、ドメイン設定ページをご覧ください。

oauth_nonce: リプレイ攻撃を防ぐために、リクエストごとに一意に生成されるランダムな文字列。

·         oauth_timestamp: 現在のタイムスタンプ


ポストマン サンプルリクエスト/レスポンス

Image Added

Image Addedoauth_callback: (任意)承認が完了した後にリダイレクトするコールバック