IBM API Connect 名詞解釋
IBM® API Connect 的術語與定義名詞解釋。
- 方案 (Plan)
- API 用以供開發者使用的包裝建構。「方案」能夠讓來自一個以上 API 的作業集合可供使用,並且會發佈到應用程式開發者的社群。應用程式開發者可透過登錄應用程式來存取「方案」,以取得 API 的存取權。
「方案」內含一組原則設定。在最簡單的形式中,「方案」可定義單一配額原則,此原則會套用至所有透過「方案」存取的 API 作業。在更進階的案例中,其他原則可以與「方案」相關聯。
- 用戶端 ID (client ID)
- 可用於識別個別應用程式的資訊片段。應用程式必須傳遞 IBM API Connect 系統可識別的應用程式金鑰,並獲授與 API 存取權時,才能呼叫 API。應用程式金鑰由用戶端透過 HTTP 查詢參數傳遞。
- 用戶端密碼 (client secret)
- 與應用程式金鑰並用的資訊片段,可用於驗證應用程式的身分。API 可配置成要求用戶端應用程式提供其應用程式金鑰與應用程式密碼。應用程式密碼只有應用程式才知道。應用程式密碼由用戶端透過 HTTP 查詢參數所傳遞。
- 安全定義 (security definition)
- 安全定義可指定 API 安全特定層面的所有設定;例如,用來鑑別 API 存取的使用者登錄。
- 伺服器 (server)
- 單一應用裝置,例如 IBM DataPower® 應用裝置。
沙盤推演型錄 (Sandbox Catalog)
在沙盤推演型錄中,發佈和生命週期動作會略過核准。「非沙盤推演型錄」轉換為「沙盤推演」時,會取消擱置中的核准。沙盤推演型錄用於測試開發中的 API。
- 角色 (role)
- 角色會定義可針對使用者啟用功能的權限。每一個角色都有一組不同的權限。
- 使用者登錄 (user registry)
- 使用者登錄是確保安全存取型錄和 API 的一種方式。使用者可以利用使用者登錄來保護 API,因此在呼叫 API 時,必須提供使用者認證。
- 供應商延伸 (vendor extension)
- 供應商延伸可新增至 REST API,以延伸 OpenAPI (Swagger 2.0) 規格。
- 服務 (service)
- 服務是伺服器處理程序,是伺服器網路中的實體。
- 社群 (community)
- 開發者組織的集合。這在發佈 API 時,是一個群組的概念。社群可用於限制 API 的顯示與存取設定。
API 可以發佈到選取的社群,這表示只有那些組織內的應用程式開發者能夠查看 API。
空間 (Space)
「空間」是「型錄」的細分。每一個「空間」都由不同的 API 提供者開發團隊使用,而且有自己的一組管理功能,這些功能與關聯團隊發佈至該「空間」的 API 特定相關,讓每一個團隊都能夠獨立管理其 API。
- 型錄 (Catalog)
- 「型錄」是暫置目標,作用如同閘道和「開發者入口網站」的邏輯分割區。API 呼叫和「開發者入口網站」的 URL 是特定「型錄」所特有的。
- 訂閱 (subscription)
- 訂閱是應用程式開發者用以取得 API 所提供資源之存取權的方法。應用程式開發者使用「開發者入口網站」來訂閱其中已發佈 API 的方案。
- 原則 (policy)
- 原則是一種配置,用來控制在執行時的 API 呼叫處理期間,「閘道」伺服器中的特定層面處理。原則是組合流程的建置區塊。原則提供一些方法來配置功能,例如安全、記載、遞送要求至目標服務,以及將資料從某種格式轉換成另一種格式。您可以在 API 或方案的環境定義中配置原則。
- 產品 (product)
- 產品提供一種方法,您可以透過該方法將 API 分組到預定用於特定用途的套件。此外,它們包含「方案」,可用來區分不同的供應項目。您只能在「產品」內建立「方案」,然後在「型錄」中發佈這些「產品」。
- 組合 (assembly)
- 一種應用程式設計介面,提供各種與應用程式互動的功能:對外部服務發出呼叫,然後轉換及聚集回應,再將回應轉遞至發出呼叫的應用程式。
- 組織 (organization)
- 擁有 API 的實體,或使用 API 的應用程式。提供者組織擁有 API 及關聯的「方案」,另外還可以擁有應用程式。開發者組織只能擁有應用程式。組織至少有一個擁有者。組織可以是專案小組、部門或公司科處。
開發型錄 (Development Catalog)
在開發型錄中,發佈和生命週期動作會略過核准。「非開發型錄」轉換為「開發型錄」時,會取消擱置中的核准。開發型錄用於測試開發中的 API。
- 路徑 (Path)
- 路徑可定義使用者藉以存取 REST API 的路徑。路徑包含一個以上的 HTTP 作業,例如 GET 或 POST。
- 管理伺服器 (Management server)
- 「管理伺服器」儲存所有雲端配置,並控制 API Connect 內其他伺服器之間的通訊。
- 管理服務 (Management service)
- 「管理服務」由一個以上「管理伺服器」組成。
- 應用程式 (application)
- 一種用戶端程式碼,可存取 API 與服務、系統或內容互動。應用程式通常是 Web 應用程式或行動式應用程式。
- 叢集 (cluster)
- 雲端中提供特定功能的一或多部伺服器集合。
- API 作業 (API operation)
- 可呼叫之 REST API 的單位。API 作業包含一個 HTTP 動詞和一個 URL 路徑(附屬於 API 的環境定義根目錄)。
- API 開發者 (API Developer)
- 「API 開發者」可針對他們所屬的提供者組織,建立及配置 API、「產品」及原則。「API 開發者」可以是一個以上提供者組織的成員。「API 開發者」對 API 技術實作的著重程度,高於他們對與應用程式開發者的商業關係的著重程度。
- LoopBack 資料來源 (LoopBack data source)
LoopBack 資料來源是代表後端服務的 JavaScript 物件,例如資料庫、REST API(要取用的)或 SOAP Web 服務。資料來源有連接器支援,而連接器會直接與資料庫或其他後端服務通訊。
- LoopBack 模型 (LoopBack model)
LoopBack 模型是代表應用程式資料的 JavaScript 物件,包括驗證規則、資料存取功能和商業邏輯。依預設,LoopBack 模型提供一個 REST API,並連接至資料來源以存取後端資料。
- Proxy
- 一種應用程式設計介面,可將要求轉遞至使用者定義的後端資源,並將回應轉送回發出呼叫的應用程式。
- SSL 設定檔 (SSL Profile)
- SSL 設定檔用來保護透過網站的資料傳輸。SSL 憑證可保證您提交至網站的資訊不會遭竊或遭到竄改。