Xuite Developer Site 合作廠商登入

合作廠商

關於OAuth

關於使用者授權與驗證的部份,Xuite API採用Oauth 2.0協定 (draft-11),請利用OAuth protocol流程及使用方式 (http://tools.ietf.org/html/draft-ietf-oauth-v2-11)。

authorize

URL: http://my.xuite.net/service/account/authorize.php

以下將說明取得使用者授權的步驟,並以GET方式帶入參數:

步驟一:應用程式端將使用者授權請求送出,並且帶入以下參數(請使用"application/x-www-form-urlencoded"的編碼方式送出參數)
response_type
必須,可以為 "token"、"code" 或 "code_and_token"
client_id
必須,請送出註冊應用程式時的api key
redirect_uri
必須,驗證完成後導回的網址
scope
選填,目前scrope取得權限範圍分為read write 預設為全部取得
state
選填
invoke_call
選填,當呼叫授權的裝置為行動裝置或是沒有redirect_uri可以承接回傳資訊時,將會以javascript物件呼叫的方式傳回資訊 例如invoke_call帶入之物件名稱為myObject,在授權完成後會先呼叫myObject.authorizeCallback(帶入以json編碼之回傳資訊); 而當myObject不存在時(以myObject in window偵測)則還是導回redirect_uri的網址。
步驟二:將使用者導向登入與授權畫面
步驟三:如果授權成功,Xuite會將存取金鑰(access_token)等相關資訊回傳給應用程式端,以下為回傳之參數:
access_token
存取金鑰
token_type
金鑰類型
expires_in
該access_token的有效時間
scope
回傳取得授權的scope範圍
state
當使用者在送出授權請求的時橫,若有帶入state參數,在此一並回傳

Requesting Access token from Code

URL: https://my.xuite.net/service/account/token.php 透過code換取access token所需帶入參數如下:

grant_type
必須,必須被設定為 "authorization_code"
client_id
必須,請送出註冊應用程式時的api key
client_secret
必須,請送出註冊應用程式時的secret key
code
必須,從認證伺服器取得的code
redirect_uri
必須,導回的url.
回傳參數為:
access_token
存取金鑰
expires_in
金鑰有效期限
refresh_token
更新金鑰

Requesting Access token from Refresh Token

URL: https://my.xuite.net/service/account/token.php 透過code換取access token所需帶入參數如下:

grant_type
必須,必須被設定為 "refresh_token"
client_id
必須,請送出註冊應用程式時的api key
client_secret
必須,請送出註冊應用程式時的secret key
refresh_token
必須,從認證伺服器取得的refresh_token
redirect_uri
必須,導回的url.
回傳參數為:
access_token
存取金鑰
expires_in
金鑰有效期限
refresh_token
更新金鑰