Xuite Developer Site 合作廠商登入

申請流程說明 取得 API Key API Key 狀態

什麼是Xuite API?

Xuite API提供簡單的方式進行Xuite網站的操作,開發者能以任何程式語言發展相關的應用程式,應用程式可以透過Xuite API進行Xuite資料的操作,例如:取得使用者授權的部落格文章、上傳或是下載使用者的相簿 / 影音、取得旅遊相關景點資訊與地理位置...等。

Xuite API架構


Xuite API以HTTP作為網路呼叫之基礎。應用程式透過呼叫api.xuite.net進行操作/取得結果。
連線網址以https://api.xuite.net/api.php 為起始,起始網址之後接續需求的參數,相關的操作功能與參數帶入方式請參閱 API說明文件

Method 命名規則

Xuite API之Method 命名原則為:站名.服務名.開放屬性.函式名稱

站名: xuite

服務名: {my, blog, photo, vlog, yo}

開放屬性: {public, private, cooperate, prepare, setting}

函式名稱: {getXxxxXxx, uploadPhotos, setName, …} 複數個回傳值加s

如: xuite.blog.public.getBlogs

介接流程簡介

public private prepare

介接流程說明

開放屬性為公開(public)的方法,不需要使用者授權即可取得,若開放屬性為個人(private或prepare),需使用OAuth 2驗證方式。 以下將說明不同類型之開放屬性流程:

public
開放屬性為public,應用程式帶入以下參數後,向Xuite API取得公開資訊,必須帶入的參數如下:
  • api_key:API key,API key會於註冊應用程式時配發。
  • api_sig:API 簽名,本簽名產生方式請參考API說明文件中的敘述。
  • method:欲取得之資訊
如有其餘需要帶入之參數,請參閱API說明文件 回傳格式為json,可分為三項:
  • ok:用來表示操作成功或失敗
  • rsp:回傳訊息內容
  • msg:若 ok 為 false 時提供錯誤訊息
關於不同Method回傳內容說明,請參閱API說明文件
private
取得個人資訊須先有使用者授權,Xuite API採用Oauth 2.0 draft-11(http://tools.ietf.org/html/draft-ietf-oauth-v2-11) 關於Oauth使用說明請參閱Oauth 2.0 說明文件 當取得使用者授權後,即可向Xuite API取得個人資訊,必須帶入的參數如下:
  • api_key:API key,API key會於註冊應用程式時配發。
  • api_sig:API 簽名,本簽名產生方式請參考API說明文件中的敘述。
  • method:欲取得之資訊
  • auth:使用者存取金鑰(access_token)
如有其餘需要帶入之參數,請參閱API說明文件 回傳格式為json,可分為三項:
  • ok:用來表示操作成功或失敗
  • rsp:回傳訊息內容
  • msg:若 ok 為 false 時提供錯誤訊息
關於不同Method回傳內容說明,請參閱API說明文件
prepare
進行檔案上傳等操作(prepare)的方法亦需要使用者授權。步驟請參考介接流程簡介,說明如下:
步驟1:取得使用者授權,請參閱Oauth 2.0 說明文件取得使用者授權,若先前已紀錄使用者授權之存取金鑰(access_token),則可略過此步。
步驟2:提出上傳資訊請求,必須帶入的參數如下:
  • api_key:API key,API key會於註冊應用程式時配發。
  • api_sig:API 簽名,本簽名產生方式請參考API說明文件中的敘述。
  • method:欲操作的方法,如照片上傳為xuite.photo.prepare.upload
  • auth:使用者存取金鑰(access_token)
提出上傳資訊請求,XUITE API將會回覆訊息如下
  • ok:用來表示操作成功或失敗
  • rsp:回傳訊息內容
    • otp:檢查碼
    • login_user_id:使用者登入user id
    • url:上傳資訊網址
  • msg:若 ok 為 false 時提供錯誤訊息
步驟3:傳送檔案,並且帶入必要的參數,**請注意**傳送檔案的位址與XUITE API位址不同,請連向步驟二中XUITE API 回傳之url參數,以下列出必須帶入之參數:
  • api_key:API key,API key會於註冊應用程式時配發。
  • api_sig:API 簽名,本簽名產生方式請參考API說明文件中的敘述。
  • method:欲操作的方法,如照片上傳為xuite.photo.prepare.upload
  • otp:請帶入步驟二回傳之檢查碼
如有其餘需要帶入之參數,請參閱API說明文件 回傳格式為json,可分為三項:
  • ok:用來表示操作成功或失敗
  • rsp:回傳訊息內容
  • msg:若 ok 為 false 時提供錯誤訊息
關於不同Method回傳內容說明,請參閱API說明文件