鍵.png)
使用這些基本 REST API 最佳實踐構(gòu)建出色的 API
你可能也喜歡這些API文章!
POST /auth/v1/token
content-type:application/json;
| 名稱 | 位置 | 類型 | 是否必須 | 描述 |
|---|---|---|---|---|
| username | body | String | 是 | 用戶名（若為子用戶，則用戶名為“主用戶名.子用戶名”） |
| password | body | String | 是 | 密碼 |
| 名稱 | 位置 | 類型 | 是否必須 | 描述 |
|---|---|---|---|---|
| access_token | Body | String | 是 | Token |
| expires_in | Body | String | 是 | 失效時間（秒） |
| refresh_token | Body | String | 是 | 刷新token |
| refresh_expires_in | Body | String | 是 | 刷新token失效時間（秒） |
請求示例
content-type:application/json; 請求url為：POST?https://iam.inspurcloudapi.com/auth/v1/token
{
"username":"cloud-operator.testuser1",
"password":"123456a?"
}響應示例
{
"access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lk...ygzrBPvyK5A",
"expires_in": 5400,
"refresh_expires_in": 7200,
"refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwi...nh54bxMbC6Dsg",
"token_type": "bearer",
"not-before-policy": 0,
"session_state": "f2e3f54e-5251-4cab-a12b-d918d3687e7f",
"scope": ""
}| 名稱 | 參數(shù)類型 | 是否必須 | 說明 |
|---|---|---|---|
| Authorization | String | 是 | 用戶token，用于鑒權(quán)，格式為“Bearer + 空格 + 通過GetToken接口獲取的token” |
| 名稱 | 參數(shù)類型 | 是否必須 | 說明 |
|---|---|---|---|
| Action | String | 是 | 操作指令名稱，取值參閱API概覽 |
| Timestamp | String | 是 | 當前 UNIX 時間戳，可記錄發(fā)起API請求的時間。 |
| Nonce | String | 是 | 隨機正整數(shù)，與 Timestamp 聯(lián)合起來, 用于防止重放攻擊。 |
| Version | String | 是 | API版本號，格式為YYYY-MM-DD。當前取值：2019-01-31 |
| Format | String | 否 | 返回參數(shù)的語言類型。取值范圍：json | xml。默認值：xml |
| 返回值 | 說明 |
|---|---|
| 200 | 請求成功。 |
| 201 | 請求成功并且服務器創(chuàng)建了新的資源。 |
| 202 | 服務器已接受請求，下發(fā)的任務會延遲處理。 |
| 204 | 服務器成功處理了請求。 |
| 返回值 | 說明 |
|---|---|
| 300 multiple choices | 被請求的資源存在多個可供選擇的響應。 |
| 400 Bad Request | 服務器未能處理請求。 |
| 401 Unauthorized | 被請求的頁面需要用戶名和密碼。 |
| 403 Forbidden | 對被請求頁面的訪問被禁止。 |
| 404 Not Found | 服務器無法找到被請求的頁面。 |
| 405 Method Not Allowed | 請求中指定的方法不被允許。 |
| 406 Not Acceptable | 服務器生成的響應無法被客戶端所接受。 |
| 407 Proxy Authentication Required | 用戶必須首先使用代理服務器進行驗證，這樣請求才會被處理。 |
| 408 Request Timeout | 請求超出了服務器的等待時間。 |
| 409 Conflict | 由于沖突，請求無法被完成。 |
| 500 Internal Server Error | 請求未完成。服務異常。 |
| 501 Not Implemented | 請求未完成。服務器不支持所請求的功能。 |
| 502 Bad Gateway | 請求未完成。服務器從上游服務器收到一個無效的響應。 |
| 503 Service Unavailable | 請求未完成。系統(tǒng)暫時異常。 |
| 504 Gateway Timeout | 網(wǎng)關(guān)超時。 |
| 名稱 | 參數(shù)類型 | 說明 |
|---|---|---|
| RequestId | String | 請求流水號 |
| Code | String | 返回碼 |
| Data | Data數(shù)據(jù)結(jié)構(gòu) | 返回結(jié)果數(shù)據(jù) |
| Message | String | 描述信息 |
| 名稱 | 參數(shù)類型 | 說明 |
|---|---|---|
| RequestId | String | 請求流水號 |
| Code | String | 返回碼,異常響應時返回錯誤碼 |
| Message | String | 異常描述 |
正常響應：
<CreateOrImportKeypairResponse>
<Code>201</Code>
<Data></Data>
<RequestId>c213c0d1-c40d-4905-89a3-4ec5e3375c5a</RequestId>
<Message>Created</Message>
</CreateOrImportKeypairResponse>異常響應：
<CreateOrImportKeypairResponse>
<Code>101.007003</Code>
<RequestId>2d1b438d-aea5-4edd-b1c2-8c65cc626b21</RequestId>
<Message>名稱可能已存在！</Message>
</CreateOrImportKeypairResponse>Q：如何找到inspur API開放平臺?
A：冪簡集成是國內(nèi)領(lǐng)先的API集成管理平臺，專注于為開發(fā)者提供全面、高效、易用的API集成解決方案。冪簡API平臺可以通過以下兩種方式找到所需API：通過關(guān)鍵詞搜索API(例如，輸入’inspur API開放平臺‘這類品類詞，更容易找到結(jié)果)、或者從API hub分類頁進入尋找。
Q：子用戶是否需要進行實名認證？
A：子用戶無需進行實名認證，我們認為子用戶是主賬號下的員工或程序，具有主賬號賦予的某些權(quán)限
Q：如何為子用戶授權(quán)？
A：在控制臺策略管理>自定義策略>創(chuàng)建自定義策略，創(chuàng)建相關(guān)資源權(quán)限的策略（詳見操作指南>策略管理>創(chuàng)建自定義策略）。
然后在策略管理>自定義策略，列表中關(guān)聯(lián)用戶（詳見操作指南>策略管理>關(guān)聯(lián)用戶）；或在人員管理>用戶管理中為用戶授權(quán)（詳見操作指南>人員管理>為用戶授權(quán)）
Q：SK密鑰丟失？
A：Access Key由浪潮云頒發(fā)給訪問者。丟失后無法找回，只能通過控制臺刪除已有密鑰再新增。請妥善保存。
Q：Access KEY的正確使用方式是什么，SK密鑰丟失了怎么辦？
A：
開發(fā)者應用訪問浪潮云的OpenAPI時，需要使用由浪潮云頒發(fā)的SECRET KEY對請求進行簽名。并攜帶簽名信息發(fā)起請求。這個調(diào)用不應該在瀏覽器端，因為SECRET KEY不可能保存在瀏覽器端。
開發(fā)者需要將請求中的所有內(nèi)容，包括請求uri、請求Body體、請求方式、請求頭（header）及請求參數(shù)等信息，按照一定的順序組裝。使用指定的加密算法計算得出簽名值signatrue。并攜帶此簽名作為身份憑證訪問浪潮云資源。
Q：inspur API開放平臺的替代品有哪些？
除了inspur API開放平臺，還有其他替代服務商也提供類似api服務，例如：
CYBERARK API開放平臺、ConnectionPoint API開放平臺、Passbolt API開放平臺
更多競品可以在冪簡集成開放平臺中找到。
Q：inspur API開放平臺這個密鑰還適用于哪些api？
獲取指定服務信息、獲取指定服務的資源類型列表、獲取指定資源類型的操作列表
本文全面且細致地介紹了如何獲取Inspur API開放平臺訪問token的分步指南，為開發(fā)者們提供了一份條理清晰、操作簡便的實用手冊。從Inspur API平臺的賬號注冊，到完成開發(fā)者身份認證，再到最終成功獲取訪問token，每一步操作都配以詳盡的說明與指導，確保開發(fā)者能夠輕松、準確地完成整個流程。獲取訪問token只是利用Inspur API的第一步，如何高效、安全地集成并應用這些強大的數(shù)據(jù)處理與服務功能才是關(guān)鍵。因此，在本文中，我們不僅指導了如何獲取訪問token，還強調(diào)了獲取后進行初步測試與驗證的重要性。通過測試，開發(fā)者可以確保Inspur API能夠順利集成到應用中，并發(fā)揮出最佳效果，從而提升應用的性能和用戶體驗。本文為開發(fā)者們提供了一個全面、詳盡且極具實用性的操作指南，幫助他們順利獲取Inspur API開放平臺的訪問token，并將這一強大的數(shù)據(jù)處理與服務功能高效地集成到應用中。我們相信，隨著開發(fā)者們對這一指南的深入理解和實踐，將能夠在數(shù)據(jù)處理、業(yè)務自動化與數(shù)據(jù)智能化等領(lǐng)域取得更加顯著的成果，為企業(yè)的數(shù)字化轉(zhuǎn)型與業(yè)務增長提供強有力的支持。