Token Method
Token APIを使って、Access Tokenを取得します。
POST |
https://{Request Host}/v1/token |
---|
Input Variables
Token Methodを使用する場合は、HTTP HeaderにContent-Type: application/x-www-form-urlencodedを指定してください。詳細はHTTP Headerを参照してください。
また、Request Bodyに以下のパラメータをURL Encodeの形式で指定してください。
必須 | Parameter | Definition |
---|---|---|
● | app_id | App IDを指定します。 |
● | secret | Secretを指定します。 |
● | grant_type | Access Tokenの処理種別を指定します。次の値を指定することができます。 oauth_code:Access Tokenを取得します。 refresh_token:Access TokenをRefreshします。 |
● | code | oauth APIの呼び出しで取得したcodeを指定します。 Access TokenをRefreshする場合は、Access Token取得時に同時に取得したRefresh Tokenの値を指定します。 |
Result Values
処理が成功した場合は、Response HeaderにHTTP Statusとして200が返り、Output Valuesで解説している値が取得できます。
エラーが発生した場合は、200以外の値が返ります。詳細はAuthentication and Authorization Errorを参照してください。
Output Values
出力値はXML形式で取得できます。
Tag | Description |
---|---|
Authentication | 認証情報を含むルート要素です。 |
AccessToken | Access Tokenです。 |
AccessTokenExpiresIn | Access Tokenの有効期限で、単位はミリ秒です。Access Tokenの有効期限は通常30分です。 |
RefreshToken | Refresh Tokenです。 Access Tokenを更新したい場合に利用します。 |
RefreshTokenExpiresIn | Refresh Tokenの有効期限で、単位はミリ秒です。Refresh Tokenの有効期限は通常2時間です。 |
Error | 処理結果を表すcodeです。詳細は、Authentication and Authorization Errorを参照してください。 |
Message | 処理結果のメッセージです。 |
Token Sample
※本サンプルでは、Encodeを行わずに記載しています。実際のRequest時には内容によってEncode/Decodeが必要です。
Input Parameter URL Encodeの形式でRequest Bodyに指定します。 ■Access Token取得時 grant_type=oauth_code&app_id=ABC&secret=XYZ&code=aaa ■Access TokenのRefresh時 grant_type=refresh_token&app_id=ABC&secret=XYZ&code=aaa |
Output XML <Authentication> |