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網關的控制臺進行重置。
可以創建多個APP,根據業務需求分別授權給不同的API。注意,API的授權對象是APP而不是阿里云用戶賬號。
可以在API網關控制臺完成對APP的創建、修改、刪除、查看詳情、密鑰管理、查看已授權API等管理操作。
每個APP可以額外添加新的AppKey和AppSecret,具體可在APP詳情頁添加,新增的密鑰對具備APP的所有權限且支持刪除,默認的密鑰對(創建APP時一起生成的)則無法刪除。
創建應用(APP):
登錄API網關控制臺,左側導航欄選擇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網關控制臺,在左側欄選擇API 管理>API列表,然后選擇API操作列下的>授權。
2.2 在授權頁面選擇要授權的環境,授權有效時間,選擇要授權的應用。在我的應用,此時直接單擊搜索,會自動加載本賬號下的APP。
如果要給其他賬號下APP授權,需要選擇應用ID,然后在文本框中輸入對應的應用ID,再單擊搜索進行查詢。
2023年11月之前購買的專享實例,若為APP額外添加了新的密鑰對后不生效,需提交工單升級實例版本。默認的密鑰對(創建APP時一起生成的)則不受版本影響。