ログイン

概要

認証トークンを作成、取得します。

注意事項

  • ManagementApi v3 にて取得したトークンは、v2 と共有されます。そのため、v3にてトークンを発行すると、以前v2で取得したトークンも、無効になります。

    ※認証トークンの発行を行うと、古いトークンが無効化されます。以下にご注意ください。

  • 運用者が管理画面にログインするIDと同一のIDを用いないでください。
  • 冗長化された2台以上のサーバー等で、同一のIDを用いて認証トークンの発行を行わないでください。
  • 追加のアカウント発行に関しては弊社サポートまでお問い合わせください。

URL

https://${hostname}/mapi/3.1/login/

メソッド

POST

結果タイプ

1つしか返さない

リクエストパラメータ

キー名 必須 タイプ 説明
user_id o 文字列 ログインユーザー名
password o 文字列 パスワード
count_limit x 整数 使用可能な回数 (0 - 100,000) 無制限にする場合は 0 を指定します。省略時は 10,000として扱います
time_limit x 整数 使用可能な秒数 (0 - 2,592,000) 無制限にする場合は 0 を指定します。省略時は 86,400として扱います

リクエストのサンプル

{
  "user_id": "MYUSERNAME",
  "password": "MYPASSWORD",
 "count_limit": 0,
 "time_limit": 0
}

レスポンス

name タイプ 説明
auth_token 文字列 認証トークン(32 文字)

レスポンスのサンプル

{
  "status": "OK", 
  "result": {
    "auth_token": "161d66dd6194452d9e47eb850d3bbb58"
  }
}