報告 API
Last updated: October 14, 2025
SkillUp 的報告 API 允許您以程式方式提取技能信號、徽章和認證數據,來自您的組織。這些 API 使您能夠將學習洞察與人力資源系統整合,建立自訂報告,並將學習成果與業務影響連結起來。
注意: 只有管理員才能生成存取這些 API 的憑證。
可用端點
端點
描述
Credentials API
返回 SkillUp 中所有可用徽章和認證的清單。
Users API
返回用戶數據,包括學習進度、徽章和已取得的認證。
配置報告 API
SkillUp API 使用 OAuth 2.0 客戶端憑證 流程來確保安全存取。只有授權系統才能請求和檢索報告資訊。
要配置報告 API:
步驟 1:產生 OAuth 憑證
登入 SkillUp 使用管理員帳戶。
點擊右上角的個人資料圖示並選擇 設定。
點擊 註冊新應用程式。
輸入您的應用程式名稱。
點擊 註冊應用程式。
將 Client ID 和 Client Secret 複製到剪貼簿,或點擊 下載 JSON 以將憑證儲存為檔案。
重要提示: 客戶端密鑰僅在產生期間顯示一次。在關閉對話框之前,您必須將其安全存儲,因為您無法再次檢索它。
您的應用程式已成功註冊,您可以開始進行 API 請求。
第二步:請求存取權杖
作為安全措施,您必須先透過向 /v1/oauth2/token端點發送 POST 請求來取得存取權杖。
授權標頭必須包含您的客戶端憑證,並以 Base64 格式編碼。
將您的 client ID 和 client secret 使用冒號 (:) 組合起來。
範例:client_id:client_secret使用 Base64 編碼該字串。
在編碼後的字串前加入前綴
Basic以建立授權標頭。
範例:Basic <base64_encoded_string>。
注意: 存取權杖 (JWT) 有效期為 10 分鐘。到期後,請重複這些步驟以請求新的權杖。
範例
如果 client_id = "abc123" 且 client_secret = "def456"
組合: “abc123:def456”
Base64 編碼:“YWJjMTIzOmRlZjQ1Ng==”
最終標頭:“Basic YWJjMTIzOmRlZjQ1Ng==”
請求
curl -X POST https://www.hackerrank.com/skillup/api/v1/oauth2/token \
-H "Authorization: Basic <base64_encoded_credentials>" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "grant_type=client_credentials"
標頭
標頭
必需
值
Authorization
Yes
Basic <base64_encoded_credentials>
Content-Type
Yes
application/x-www-form-urlencoded
Body 參數
參數
必需
值
grant_type
Yes
client_credentials
回應
{
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"expires_in": 600
}欄位
類型
描述
access_token
string
API 驗證的存取權杖
expires_in
integer
Token 有效期限(秒)(600 秒)
步驟 3:存取 SkillUp API
取得有效的存取權杖後,使用它來呼叫 SkillUp 報告 API。
在您的請求的授權標頭中包含該權杖。
範例請求
curl -X GET https://www.hackerrank.com/skillup/api/v2/credentials \
-H "Authorization: Bearer <access_token>"錯誤處理
Status Code
Error
Description
400
錯誤的請求
缺少或無效的參數
401
未授權
存取令牌無效或已過期
403
禁止訪問
令牌缺少必要的權限
429
請求過多
在短時間內發出過多請求
最佳實踐
安全存儲憑證。切勿在客戶端程式碼中暴露客戶端憑證。
令牌有效期為10分鐘。快取並重用存取令牌,而不是為每個請求生成新的令牌
在當前令牌過期前請求新的令牌。
速率限制
請求類型
限制
Token 請求
每秒 1 次請求
API 請求
每秒 1 次請求
欲了解更多資訊,請聯繫 skillup-support@hackerrank.com。