ご利用マニュアル
ユーザ認証
API機能を利用する際のユーザー認証です。
出力方法はJsonです。
概要/ Request
POST | https://api.rcmd.jp/admin/oauth/token |
処理概要
- ユーザ認証を取得します。
- 認証の取得に成功した場合、アクセストークンを返します。
- アクセストークンの生存期間は3時間(10800秒)となります。
- クライアントID、クライアントシークレット、パスワードは別途こちらからご案内いたします。
注意事項
※本工程はアイテム情報等データ更新する際にAPIを活用頂く場合のみ必要となります。レコメンド情報を取得する場合のみは不要です。
Request
パラメタ | 要否 | 説明 |
client_id | 必須 | OAuth2.0クライアントID |
client_secret | 必須 | OAuth2.0クライアントシークレット |
grant_type | 必須 | グラント種別。”password”固定 |
username | 必須 | アカウント名 |
password | 必須 | パスワード |
Headers
Content-Type: application/json
Body
{
"client_id": [クライアントID],
"client_secret": [クライアントシークレット],
"grant_type": "password",
"username": [アカウント名],
"password": [パスワード]
}
Response 200
パラメタ | 説明 |
access_token | アクセストークン |
token_type | トークンタイプ。”bearer” 固定 |
expires_in | トークンの生存期間(秒)。3時間(10800秒)固定 |
created_at | トークンの生成日時(UNIXタイム) |
Headers
Content-Type: application/json
Body
{
"access_token": [アクセストークン],
"token_type": "bearer",
"expires_in": "10800",
"created_at": [トークンの生成日時]
}
利用例
- [client_id] と [client_secret]、[password] をお伝えいたします。
- 以下のURLへPOSTでリクエストを送信してください。
https://api.rcmd.jp/admin/oauth/token
リクエストヘッダには以下をご設定ください。Content-Type: application/json
1でお伝えした [client_id] と [client_secret] , [password] をBODYパラメタにご設定ください。
なお、grant_type には “password”をご設定ください。{
"client_id": "774a0afec0a86264630e9c4363ab6c52d59d448d3db7960d7d6098d4ed4dee89",
"client_secret": "ea855afaf1c44ab8527a426bb7e1fcff99c76ba592f4fb93dd9436e3b084a0f0",
"grant_type": "password",
"username" : "test_account",
"password": "N3@|dII(9NJL"
} - レスポンスとして以下のパラメタが取得できます。access_token が認証キーとなります。
{
"access_token": "187113305cfd78f0afe3dfeb94a3f6b0a1e7ae1410a96abaaa1965477dd4dc16",
"token_type": "bearer",
"expires_in": "10800",
"created_at": "1538126278"
}