認証

この記事の内容
  1. 事前操作
  2. テンプレート
  3. postMan テンプレート
  4. Java テンプレート
  5. リクエスト
  6. リクエスト例
  7. レスポンス
  8. レスポンス本文
  9. レスポンス本文の例
  10. accessToken の使用

api.example.com、console.example.com、files.example.com は説明用のアドレスです。実際の環境で指定された API、管理画面、ファイル配布先の URL に置き換えてください。

事前操作

企業管理者アカウントで Dr.Robo コンソールにログインし、API 設定画面で accessKeyId と accessKeySecret を新規追加してください。取得後は適切に保管してください。管理者は、Dr.Robo と連携する必要のあるシステムごとに、セキュリティキーのペアを作成できます。

説明: accessToken の最大有効期間は 2 時間です。accessToken の有効期限が切れていない場合、リクエストに対して既存の accessToken が返されます。accessToken は一時トークンであり、有効期限が切れている場合、リクエストに対して新しいトークンが返されます。呼び出し側でキャッシュする必要はありません。キャッシュが必要な場合は、トークンのリクエスト時に返される expiresIn フィールドに基づいてキャッシュできます。このフィールドは、今回取得したトークンの有効期間を秒単位で示します(キャッシュ時間を独自に設定しないでください。当サービスのトークンと呼び出し側のキャッシュの有効期間が一致しなくなる可能性があります)。タスクの実行が完了すると無効になります。

テンプレート

postMan テンプレート

認証用 accessToken の作成.json(右ボタンをクリックし、「名前を付けて保存」を選択してください)

Java テンプレート

ありません

リクエスト

基本 パラメータ値 説明
HTTP URL https://api.example.com/oapi/token/v2/token/create 専有クラウドを利用する企業は、専有クラウドのアドレスを使用してください
HTTP Method GET

リクエスト例

http://xxx/oapi/token/v2/token/create?accessKeyId=MerC5cKPSa7BTG1A@platform&accessKeySecret=mqTxhk4aK1v7PpDtfQU6dCMgnrR50HFc

レスポンス

レスポンス本文

名称 タイプ 必須かどうか
code int はい
success boolean はい
msg string はい
data object はい
∟ accessToken string はい
∟ expiresIn int はい

レスポンス本文の例

{
    "data": {
        "accessToken": "520da9c9-694d-4b40-9332-0c179243c88e",
        "expiresIn": 7199
    },
    "code": 200,
    "success": true,
    "requestId": "601cf6274032e2cc335c97d2"
}

accessToken の使用

個々の API を呼び出すたびに、accessToken をパラメータとして header に含める必要があります。パラメータは次のように指定します。

Authorization: Bearer ${accessToken}。先頭に Bearer を付け、Bearer と accessToken の間をスペースで区切る必要があります。

エラーが発生した場合は、ステータスコードの説明を参照してください。

OpenAPIの記事一覧ページの先頭へ ↑