全部產品
Search
文件中心

DataWorks:調用API

更新時間:Nov 16, 2024

在API發布並授權之後,您可以通過簡單身份認證(在要求標頭中添加AppCode)或加密簽名身份認證(在要求標頭中添加AppKey和AppSecret)的方式調用API。本文為您介紹如何擷取認證資訊以及調用API的具體流程。

前提條件

您需要首先發布API至API Gateway,詳情請參見發布API

您需要擷取以下三個基礎條件,才可以調用API:

  • API:您即將要調用的API,明確API參數定義。

  • 應用App:作為您調用API時的身份,AppKey和AppSecret用於驗證您的身份。

  • API和App的許可權關係:App需要調用某個API,必須擷取調用該API的許可權。詳情請參見授權管理

背景資訊

API Gateway支援API授權和API調用SDK。您可以授權自己、企業內的人員或第三方使用API。

操作步驟

  1. 擷取API文檔。

    根據您擷取API的渠道不同,擷取方式略有差異。通常分為以下兩種方式:

    • 從資料超市購買的API服務。如需查看已購API列表,請在雲市場控制台中查詢。

    • 無需購買,由提供方主動授權的API服務。如需查看獲得授權的API服務,請在API Gateway控制台中查詢。

  2. 建立應用。

    應用App是您調用API服務時的身份。每個App有一組Key和Secret,即帳號和密碼。詳情請參見建立應用

  3. 擷取許可權。

    授權是指授予App調用某個API的許可權。您的App需要擷取API的授權才能調用該API。

    由於擷取API的渠道不同,建立授權的方式也不同。詳情請參見擷取授權

  4. 調用API。

    您可以直接用API Gateway控制台為您提供的多語言調用樣本來測試調用,可以自行編輯HTTP(S)請求來調用API。詳情請參見用戶端調用API樣本支援 HTTPS

查看API調用的認證資訊

  1. 登入DataWorks控制台,切換至目標地區後,單擊左側導覽列的資料開發與治理 > 資料服務,在下拉框中選擇對應工作空間後單擊進入資料服務

  2. 在資料服務頁面,單擊上方的服務管理

  3. 在左側導覽列,單擊API調用

    API調用頁面,您可以根據自身需求,查看或複製調用API時需要的身份認證資訊。