在API發布後,您可以將API授權給他人,或擷取他人已授權的API,以實現資料共用。本文為您介紹如何對API進行授權及不同情境下API的授權方案。
前提條件
僅支援對發行的API進行下線、授權和變更協議等操作,詳情請參見發布API。
進入API管理頁面
登入DataWorks控制台,切換至目標地區後,單擊左側導覽列的資料服務,在下拉框中選擇對應工作空間後單擊進入資料服務。
單擊頁面頂部功能表列的服務管理,進入API管理頁面。
授權API
在發布的API頁簽下,單擊相應API後的授權。
在API授權對話方塊中,配置各項參數。
參數
描述
API名稱
待授權API的名稱,預設不可以修改。
要授權的雲帳號ID
需要獲得當前API調用許可權的阿里雲帳號ID。您可以在帳號管理頁面查看。
要授權的工作空間
在下拉式清單中選擇當前阿里雲帳號下,待授權的工作空間名稱。
授權有效期間
調用API許可權的有效期間,包括短期和長期:
短期:您需要選擇到期日,在該日期前均有權調用API。
長期:選中長期後,永久有權調用API。
單擊確認。
您還可以在發布的API頁簽,進行以下操作:
單擊相應API後的下線,在下線API服務對話方塊中,單擊確認,下線當前API。
說明如果已授權的API被下線或刪除,則獲得授權的工作空間將無法繼續調用該API。
如果已授權的API被下線或修改後重新發布,則需要API的負責人對新發布的API重新授權。
單擊相應API後的測試,進入API測試頁面測試API。詳情請參見測試API。
滑鼠移至上方至相應API後的更多,單擊協議變更。在API協議變更對話方塊中,設定變更後的API協議,單擊確認。
說明如果您刪除了原有協議,則原有協議的介面會調用失敗,請謹慎操作。
協議變更即時生效。
查看獲得授權的API
在API管理頁面,單擊獲得授權的API,查看所有獲得授權的API。
您可以對獲得授權的API進行以下操作:
單擊相應API後的測試,進入API測試頁面測試API。詳情請參見測試API。
單擊相應API後的刪除,在刪除授權對話方塊中,單擊確認。
查看授權給他人的API
在API管理頁面,單擊授權給他人的API,查看所有授權給他人的API。
您可以對已授權的API進行以下操作:
單擊相應API後的測試,進入API測試頁面測試API。詳情請參見測試API。
單擊相應API後的授權管理。在API授權管理對話方塊中,取消或修改相應工作空間的授權。
API授權方案
API授權是指應用(APP)與API建立授權關係。應用(APP)是調用API時的身份,應用(APP)需要獲得API的授權才能調用該API。DataWorks資料服務預設會對工作空間下的API添加“阿里雲APP認證”的認證方式,並授權給與工作空間同名的應用(APP)(詳情請參見查看API調用的認證資訊),這樣一來,調用方即可使用獲得授權的應用(APP)下的AppCode或AppKey&Secret來安全地調用API。
調用API的過程中,常見問題包括:如何標識及區分調用流量的來源、如何合理分配調用鑒權的身份認證資訊等。以下將從不同情境及需求來說明如何對資料服務API進行不同粒度的授權。