- 開發前必讀
- 帳號登⼊入說明
- 數據源API
- 領域頻道資料
- 來源頻道資料
- 來源網站資料
- 產業品牌分析API
- 口碑分析資料
- 話題列列表
- 熱門話題
- 話題自動類聚
- 話題自動摘要
- 熱詞列表
- 新詞列表
- 資料詞雲
- 競品關聯分析
- 五大情緒指標分析
- 趨勢詞列表
- 發文ID統計資料
- 當日資料危機分析
- 自訂主題分析API
- 口碑分析資料
- 話題列表
- 熱門話題
- 話題自動類聚
- 話題自動摘要
- 五大情緒指標分析
- 發文ID統計資料料
- ID分析API
- 領域頻道發文ID統計資料
- 領域頻道熱門ID統計資料
- 趨勢分析API
- 領域頻道趨勢詞列表
- 關聯分析API
- 領域頻道熱詞關聯
- 領域頻道新詞關聯
- 文本內容分析API
- 文本熱詞分析
- 文本新詞分析
- 文本詞雲分析
- 文本正負評價分析
- 文本情緒分析
- 文本自動摘要
- 熱點分析API
- 領域頻道熱門話題
- 領域頻道熱詞
- 意見領袖分析API
- 意見領袖粉絲分析
- 意見領袖活耀度分析
- 意見領袖發回文列表
- 微博及微信公眾號數據API
- 微博發文資料
- 微博回文資料
- 微信發文資料
開發前必讀
1.前置作業
⾸先,您必須先完成註冊後,並完成相關的設定,才能開始使⽤API端點所提供的服務。2.開發者規範
開發通則
• ⽬前請求與回應的編碼格式皆為UTF-8。
• 部分API服務的參數為可選或不可選,但在使⽤時請注意,參數值必須轉換為UTF-8並進⾏URL編碼。
• 部分API服務使⽤的請求⽅法為POST,此時務必在請求標頭(HTTP header)中添加以下設置:
Content-Type: application/json
• 使⽤API服務端點(endpoint)前,必須先進⾏登⼊並取得權杖(token)(註1)。
此後,每次使⽤API服務端點 時,於請求標頭(HTTP header)中,添加以下設置:(註2)
Authorization: Bearer 此處置⼊入傳回的權杖(token)
範例:
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjEyMzQ1Njc4OTAiLCJuYW1lIjoiSm9obiBEb2UifQ.mlSlNwi
0i7c9IPjcfXF6_JzmNeWaG0_dFigqcCUSFXM
註1: 權杖的時限為⼆⼗分鐘,超過此限後需要重新登⼊後取得。註2: “Bearer”之後必須插⼊⼀個空⽩隔開,再添加權杖(token)。
請求HTTP標頭設置
標頭 | 必填 | 說明 |
Accept | 是 | application/json |
Authorization | 是 | 填⼊於登⼊完成後,由API服務端點所傳回的權杖(token) |
Content-Type | 否 | pplication/json(註3) |
回應狀態碼
⽬前我們的API會為每個請求,返回適當的HTTP狀態碼。代碼 | ⽂字 | 說明 |
200 | OK | 成功。 |
201 | Created | 請求已經被實現,並依請求的需要⽽創建出⼀個新的資源,且URI已隨Location標頭返回。 |
202 | Accepted | 請求已被接受,但尚未被處理,最終該請求有可能會或可能不會被執⾏,並且可能在處理時被 禁⽌。 |
400 | Bad Request | 該請求無效或無法以其他⽅式提供。 伴隨的錯誤信息將進⼀步解釋。 沒有被授權的請求將被 視為是無效的,並且返回這個狀態。 |
401 | Unauthorized | 缺少或不正確的授權憑證。 此狀態也可能在其他未定義的情況下返回。 |
403 | Forbidden | 該請求已收到,但請求已被拒絕或不被允許訪問,隨附的錯誤信息將解釋拒絕的原因。返回此 狀態的其他原因與下表中的錯誤代碼⼀起列出。 |
404 | Not Found | 請求的URI無效或請求的資源不存在。 |
406 | Not Acceptable | 在請求中存在不正確的資料格式時返回。 |
410 | Gone | 此資源已不存在,通常⽤於指⽰該API端點已關閉。 |
429 | Too Many Requests | 當由於已達服務使⽤次數限制⽽無法提供服務時返回。 |
500 | Internal Server Error | 系統發⽣異常,通常這樣的狀態是暫時的,例如正處於⾼附載的狀態下,或是API端點暫時 出現異常,請留意本站公告或是稍後再試。 |
502 | Bad Gateway | API服務已關閉或正在升級。 |
503 | Gateway Timeout | 提供服務的伺服器已啟動,但由於內部設備發⽣異常,暫時無法提供服務,請稍後再試。 |
錯誤代碼
代碼 | ⽂字 | 說明 |
32 | Could not authenticate you. | 對應於HTTP 401,該請求的驗證數據存在問題。 |
34 | Sorry, that resource does not exist. | 對應於HTTP 404,未找到指定的資源。 |
64 | Your account is suspended and is not permitted to access this feature. | 對應於HTTP 403,正在使⽤的訪問權杖屬於暫停的⽤⼾。 |
87 | Client is not permitted to perform this action. | 對應於HTTP 403,所調⽤的端點不是允許的URL 。 |
89 | Invalid or expired token | 請求中使⽤的訪問權杖不正確或已過期。 |
92 | SSL is required | API服務只允許使⽤SSL連接。 將請求更新為安全連接。 |
99 | Unable to verify your credentials. | 對應於HTTP 403,憑證無法驗證。 檢查權杖是否仍然有效。 |
131 | Internal error | 對應於HTTP 500,發⽣未知的內部錯誤。 |
135 | Could not authenticate you | 對應於HTTP 401,時間戳超出範圍(通常由驗證時的時鐘漂移引起 - 檢查您的 系統時鐘) |
215 | Bad authentication data | 對應於HTTP 400,使⽤該⽅法需要驗證,但未提交或為無效授權。 |
220 | Your credentials do not allow access to this resource. | 對應於HTTP 403,正在使⽤的⾝份驗證權杖受到限制,無法訪問請求的資源。 |
251 | This endpoint has been retired and should not be used. | 對應於向⼀個過期的網址送出HTTP請求。 |
錯誤訊息返回格式
當使⽤用API服務發⽣生錯誤時,系統將返回以JSON格式的錯誤訊息,訊息內容包括狀狀態碼及錯誤訊息。{ "errors": [ { "message": "Sorry, that resource does not exist.", "code": 34 } ] }
API服務權杖獲取流程
⾸先,透過以下URL完成註冊取得⼀組帳號及密碼。http://api.i-buzz.com.tw/register
• 使⽤上⼀個步驟取得的帳號密碼,透過您撰寫的程式發送請求⾄下⾯的API服務端點獲取權杖。(註4)
http://api.i-buzz.com.tw/login
註4:有關程式登⼊⽅式,請參閱「帳號登⼊說明」