API授權是指應用(APP)與API建立授權關係。應用(APP)是調用API時的身份,應用(APP)需要獲得API的授權才能調用該API。
前提條件
API認證方式為 阿里雲APP認證。
1 應用(APP)
應用(APP)是調用API的身份,每個APP預設有一對AppKey和AppSecret金鑰組,AppKey需要在請求時作為參數在Header傳入,AppSecret需要用於計算請求籤名。詳細摘要簽名的計算行程方式,請查看文檔使用摘要簽名認證方式調用API。
AppKey和AppSecret金鑰組,具備該APP的全部許可權,需要妥善保管。如果發生泄露,您可以在API Gateway的控制台進行重設。
可以建立多個APP,根據業務需求分別授權給不同的API。注意,API的授權對象是APP而不是阿里雲使用者帳號。
可以在API Gateway控制台完成對APP的建立、修改、刪除、查看詳情、密鑰管理、查看已授權API等管理操作。
每個APP可以額外添加新的AppKey和AppSecret,具體可在APP詳情頁添加,新增的金鑰組具備APP的所有許可權且支援刪除,預設的金鑰組(建立APP時一起產生的)則無法刪除。
建立應用(APP):
登入API Gateway控制台,左側導覽列選擇API調用>應用管理,然後單擊右上方的建立APP。
在建立應用頁面填寫應用程式名稱,單擊建立。
在建立APP時,若有需要可以設定APP標籤,自訂AK資訊,配置拓展欄位。
標籤設定:通過標籤(Tag)功能對APP進行標記。
自訂AK資訊:允許使用者在建立APP時自訂AK以及AppCode,同時允許使用者修改已經在生產中的APP的AK以及AppCode,即時生效。
拓展欄位:允許使用者為APP配置一個擴充欄位,並且將這個擴充欄位作為系統參數傳輸給後端服務,系統參數名稱為CaAppExtInfo。
重要2023年8月前購買的專享執行個體,如果拓展欄位不生效需提交工單升級執行個體版本。
2 API授權
授權,是指授予某個APP調用某個API的許可權。APP需要獲得API的授權才能調用該API。
自己建立的APP,API可以直接授權。
雲市場購買的API,使用者有權操作已購買的API授權給自己的APP;如果沒有APP,購買時雲市場會為您建立一個APP,並且授權,具體請前往雲市場的控制台查看。
如果想要使用夥伴(其他帳號)提供的API,並無購買行為,是線下協議。那麼需要自行建立APP,並且向API的提供者提供您的應用ID。API的提供者可以通過搜尋應用ID來操作授權。
API授權:
2.1 登入API Gateway控制台,在左側欄選擇API 管理>API列表,然後選擇API操作列下的>授權。
2.2 在授權頁面選擇要授權的環境,授權有效時間,選擇要授權的應用。在我的應用程式,此時直接單擊搜尋,會自動載入本帳號下的APP。
如果要給其他帳號下APP授權,需要選擇應用ID,然後在文字框中輸入對應的應用ID,再單擊搜尋進行查詢。
2023年11月之前購買的專享執行個體,若為APP額外添加了新的金鑰組後不生效,需提交工單升級執行個體版本。預設的金鑰組(建立APP時一起產生的)則不受版本影響。