鍵.png)
使用這些基本 REST API 最佳實(shí)踐構(gòu)建出色的 API
1. 使用您的 Twitch 帳戶登錄開發(fā)者控制臺。
2. 在開發(fā)者控制臺上選擇“應(yīng)用程序”選項(xiàng)卡,然后單擊“注冊您的應(yīng)用程序”。
3. 將名稱設(shè)置為您的應(yīng)用程序的名稱。該名稱在所有 Twitch 應(yīng)用程序中必須是唯一的。如果您的應(yīng)用程序需要用戶同意才能訪問或修改用戶的資源,則您的應(yīng)用程序的名稱會(huì)列在“其他連接”下的“連接”頁面上。
4. 將OAuth 重定向 URL設(shè)置為您的應(yīng)用用于授權(quán)的回調(diào) URL。添加重定向 URL 后,點(diǎn)擊添加。
5. 選擇您的應(yīng)用所屬的類別(應(yīng)用程序類型)。
6. 單擊“我不是機(jī)器人”復(fù)選框。
7. 單擊“創(chuàng)建”。
8. 返回“應(yīng)用程序”選項(xiàng)卡,在“開發(fā)者應(yīng)用程序”下找到您的應(yīng)用程序,然后單擊“管理”。
9. 記下您的客戶端 ID,您將使用它來獲取訪問令牌并在所有 API 請求中設(shè)置 Client-Id 標(biāo)頭。客戶端 ID 被視為公開的,可以嵌入到網(wǎng)頁的源代碼中。
10. 根據(jù)您用于獲取令牌的流程,您可能需要客戶端密鑰。例如,授權(quán)代碼授予流程需要客戶端密鑰。單擊“新建密鑰”以生成您將用于獲取訪問令牌的密鑰。您必須復(fù)制密鑰并將其存儲在安全的地方。獲取新密鑰會(huì)使之前的密鑰失效,這可能會(huì)導(dǎo)致您的 API 請求失敗,直到您更新應(yīng)用為止。
Twitch 需要 OAuth 訪問令牌才能訪問大多數(shù) Twitch 資源。資源需要應(yīng)用訪問令牌或用戶訪問令牌。要確定資源需要哪種類型的令牌,請參閱您計(jì)劃使用的端點(diǎn)的參考內(nèi)容。
由于獲取用戶端點(diǎn)(我們用它來獲取有關(guān) TwitchDev 用戶的信息)接受任一類型的令牌,因此我們獲取一個(gè)應(yīng)用訪問令牌,因?yàn)檫@樣更簡單。有關(guān)應(yīng)用訪問令牌的信息,請參閱客戶端憑據(jù)授予流程。
在本練習(xí)中,打開終端窗口并輸入以下 cURL POST 命令(您需要在計(jì)算機(jī)上安裝 cURL)。使用注冊應(yīng)用時(shí)收到的客戶端 ID 和密鑰更新客戶端 ID 和密鑰占位符。
curl -X POST 'https://id.twitch.tv/oauth2/token' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'client_id=<your client id goes here>&client_secret=<your client secret goes here>&grant_type=client_credentials'
注意有關(guān)在 Microsoft Windows 上運(yùn)行查詢的信息,請參閱cURL 示例。
響應(yīng)包含帶有訪問令牌的 JSON 對象。
{
"access_token": "jostpf5q0puzmxmkba9iyug38kjtg",
"expires_in": 5011271,
"token_type": "bearer"
}
要獲取有關(guān) TwitchDev 用戶的信息,請使用獲取用戶端點(diǎn)。端點(diǎn)需要用戶的名稱或 ID。因?yàn)槲覀冎烙脩舻拿Q,所以將登錄查詢參數(shù)設(shè)置為 TwitchDev 的登錄名,即 twitchdev(全部小寫)。請記住將 OAuth Bearer 令牌替換為您的令牌,將客戶端 ID 替換為您的應(yīng)用的 ID。
curl -X GET 'https://api.twitch.tv/helix/users?login=twitchdev' \
-H 'Authorization: Bearer jostpf5q0puzmxmkba9iyug38kjtg' \
-H 'Client-Id: wbmytr93xzw8zbg0p1izqyzzc5mbiz'
注意有關(guān)在 Microsoft Windows 上運(yùn)行查詢的信息,請參閱cURL 示例。
以下示例顯示請求返回的 JSON 響應(yīng)。
{
"data": [
{
"broadcaster_type": "partner",
"created_at": "2021-07-30T20:32:28Z",
"description": "Supporting third-party developers building Twitch integrations from chatbots to game integrations.",
"display_name": "TwitchDev",
"id": "141981764",
"login": "twitchdev",
"offline_image_url": "https://static-cdn.jtvnw.net/jtv_user_pictures/3f13ab61-ec78-4fe6-8481-8682cb3b0ac2-channel_offline_image-1920x1080.png",
"profile_image_url": "https://static-cdn.jtvnw.net/jtv_user_pictures/8a6381c7-d0c0-4576-b179-38bd5ce1d6af-profile_image-300x300.png",
"type": "",
"view_count": 6652509
}
]
}
Q:如何找到Twitch API
A:冪簡集成是國內(nèi)領(lǐng)先的API集成管理平臺,專注于為開發(fā)者提供全面、高效、易用的API集成解決方案。冪簡API平臺可以通過以下兩種方式找到所需API:通過關(guān)鍵詞搜索API(例如,輸入’Twitch API‘這類品類詞,更容易找到結(jié)果)、或者從API hub分類頁進(jìn)入尋找。
Q:API密鑰錯(cuò)誤
A:在發(fā)送API請求時(shí),需要提供有效的API密鑰進(jìn)行身份驗(yàn)證。如果提供的API密鑰錯(cuò)誤或無效,將無法成功獲取Twitch API的狀態(tài)信息。
Q:請求錯(cuò)誤?
A:檢查發(fā)送的HTTP請求是否正確,包括URL和參數(shù)。確保使用了正確的API端點(diǎn)URL,并將所需的參數(shù)作為查詢參數(shù)或請求體的一部分發(fā)送。
Q:跨域請求問題?
A:由于安全策略限制,瀏覽器可能會(huì)阻止跨域請求。如果JavaScript代碼在瀏覽器中運(yùn)行,而API請求是發(fā)往不同域名(例如從用戶的域名到Twitch API域名),需要確保在API請求中設(shè)置了正確的CORS頭部,或者使用代理服務(wù)器來轉(zhuǎn)發(fā)請求。
Q:Twitch API故障或限制
A:有時(shí)Twitch API本身可能會(huì)遇到故障或限制,導(dǎo)致無法獲取狀態(tài)信息。可以查看Twitch開發(fā)者社區(qū)或Twitch支持頁面,以了解是否有已知的問題或限制。
提供AI大模型API的服務(wù)商除了Twitch API,還有其他替代服務(wù)商也提供類似api服務(wù),例如:
Restream API開放平臺、streamboxy API開放平臺、Livebox API開放平臺
更多競品可以在冪簡集成開放平臺中找到。
Q:Twitch API這個(gè)密鑰還適用于哪些api?
Creator Goals、Requesting event notifications、Creating a prediction
“Twitch API開放平臺訪問token分步指南”為開發(fā)者們提供了一份詳盡、實(shí)用的操作手冊,全面覆蓋了從注冊Twitch API開放平臺賬號到成功獲取訪問token的整個(gè)流程。本指南通過一系列清晰明了、易于操作的步驟,詳細(xì)闡述了如何完成開發(fā)者身份認(rèn)證,并最終獲取到Twitch API的訪問token。每一步操作都配以詳盡的說明和指導(dǎo),確保開發(fā)者能夠輕松、快速地完成整個(gè)流程。本指南還特別強(qiáng)調(diào)了獲取訪問token后,進(jìn)行API可用性測試的重要性。通過測試,開發(fā)者可以確保Twitch API能夠順利集成到應(yīng)用中,并發(fā)揮出最佳效果,從而提升應(yīng)用的性能和用戶體驗(yàn)。這一步驟不僅是對API功能的驗(yàn)證,更是對開發(fā)者工作成果的保障。這份指南為開發(fā)者們提供了一個(gè)全面、詳盡且實(shí)用的指導(dǎo),幫助他們輕松獲取Twitch API開放平臺的訪問token,并將其有效地集成到應(yīng)用中,以提供更加豐富的直播數(shù)據(jù)交互與處理能力。無論是對于初學(xué)者還是有一定經(jīng)驗(yàn)的開發(fā)者來說,這份指南都將是一份寶貴的資源,助力他們在直播數(shù)據(jù)處理的道路上越走越遠(yuǎn)。