API 安裝指南
參考指南
變化點 2021
© 2021 Changepoint Canada ULC 保留所有權利。 美國政DFARS 227.7202-1(c)(227.7202)(ii) (OCT 3)、FAR 1995(a) (252.227)、FAR 7013-1 或 FAR 1988-12.212 (ALT III)，如適用。 本產品包含 Changepoint Canada ULC 的機密信息和商業機密。 未經 Changepoint Canada ULC 事先明確書面許可，禁止披露。 使用本產品須遵守用戶與 Changepoint Canada ULC 簽訂的許可協議的條款和條件。 文檔只能由被許可方復制以供內部使用。 未經 Changepoint Canada ULC 的明確書面同意，不得更改、修改或更改本文檔的內容。 Changepoint Canada ULC 可隨時更改此處指定的內容，無論是否通知。
安裝變更點 API
關於安裝 Changepoint API
Changepoint API 可用作 COM API、Windows Communication Foundation (WCF) 服務，並且為了向後兼容，可用作 Web 服務增強 (WSE) 服務。 有關 Changepoint API 的信息，請參閱 Changepoint API 參考。 有關升級說明、警告和已知問題，請參閱 Changepoint 中團隊文件夾中的發行說明。
升級 Changepoint API
如果您從 Changepoint 的早期版本升級，請使用 Windows 控制面板卸載 Changepoint API 的早期版本及其組件，然後再安裝此版本。
變更點 API 要求
您必須在安裝 Changepoint API 之前安裝 Changepoint。 有關軟件要求，請參閱 Changepoint 軟件兼容性矩陣，該矩陣位於 Changepoint 的 2021 發行說明和補丁團隊文件夾中。
File 路徑約定
在本文檔中，以下約定用於公共路徑：
- Changepoint 安裝的根路徑。
默認路徑為：
C：程式 Files (x86)Changepoint 變化點 - 常見 Changepoint 實用程序的根位置，例如 Login Settings 實用程序。
默認路徑為：
C：程式 Files (x86) 普通 FilesChangepoint 變化點
安裝變更點 API
- 從 Changepoint API 媒體根目錄，運行 setup.exe。
- 按照提示操作，直到出現“選擇功能”屏幕。
- 選擇要安裝的功能，然後單擊下一步。
- 選擇 API 目標文件夾，默認API，然後單擊下一步。
筆記： Changepoint 登錄設置實用程序安裝在LoginSettings，與您指定的目標文件夾無關。 - 如果您選擇了 Web 服務 API： 當選擇
a Web 出現站點屏幕，選擇一個 web將虛擬目錄添加到的站點，然後單擊下一步。
灣。 單擊下一步繼續。 6. API 安裝完成後，單擊“完成”。
將 Changepoint API 配置為可感知緩存
要將 Changepoint API 配置為可感知緩存，請替換“cache.xml”的值。 密碼”和“緩存。 CP 中的“服務器”鍵 Web 服務Web.config file 使用企業中使用的值Web.config file.
啟用 Web 服務增強 (WSE)
- 編輯 Web.config file 為了 web 服務。 默認位置是：
APICP Web 服務Web.config - 找到以下註釋行的三個實例：
< !– 如果您正在使用，請取消註釋以下元素 Web 服務增強 (WSE) API。 如果使用 WCF 服務且未安裝，請留下評論 Web 服務增強 (WSE) –> - 取消註釋每個註釋行實例後面的元素：
<section name=”microsoft.web.services2“……>web服務>web.服務2>
筆記： 這webServices> 要取消註釋的元素是web>.
配置日誌記錄 Web 服務API
您必須設置日誌 file 路徑和日誌級別。 日誌級別是累積的。 例如ample，如果您指定級別 3，則記錄級別 1、2 和 3。 默認日誌級別為 8。
- 編輯 web 服務 Web.config。 默認位置是：
APICP Web 服務Web.config - 設置日誌File小路。 默認值為APIAPILogs。 3. 設置日誌級別。 有效值為：
0 = 不記錄
1 = 源對象和方法
2 = 錯誤信息
3 = 輸入參數
4 = 退貨
5 =警告
8 = 檢查點
配置虛擬目錄身份驗證 Web 服務API
您必須為 CP 啟用匿名訪問並禁用集成 Windows 身份驗證WebInternet 信息服務 (IIS) 中的服務虛擬目錄。 有關詳細信息，請參閱 Microsoft IIS 文檔。
配置數據庫連接設置 Web 服務API
使用登錄設置實用程序加密數據庫連接設置 Web 服務API Web.config file. 有關詳細信息，請在 Changepoint 安裝指南中搜索“配置數據庫連接設置”。
為 Changepoint WCF 配置身份驗證 Web 服務
您可以為 Changepoint WCF 配置應用程序身份驗證和單點登錄 (SSO) Web 服務。
使用安全令牌服務 (STS) 可以使用以下實施選項：
- SSO 使用 ISAPI SSL 可選
- 需要使用 WS-Federation (ADFS 2.0) SSL 的 SSO
如果需要 SSL，配置腳本會確保使用它。
ISAPI 和應用程序身份驗證的配置腳本可以選擇啟用 SSL。
為 WCF 配置應用程序身份驗證 Web 服務
Changepoint WCF 的默認身份驗證類型 Web 服務是應用程序身份驗證。
使用本節中的過程來：
- 配置 Changepoint WCF Web 通過 SSL 使用應用程序身份驗證的服務
- 還原更改點 WCF Web 在實施了其中一種 SSO 實施後為應用程序身份驗證提供的服務
配置 PowerShell
- 打開 Windows PowerShell 提示符。
- 修改執行策略：
設定執行策略不受限制
Stage 1 收集配置參數
確定配置參數的值。
| 範圍 | 描述 |
| Web服務路徑 | Changepoint WCF 的位置 Web 服務 web 應用 files. 默認： \API\CP Web 服務 |
| 服務證書_ 姓名 |
將用於使用消息安全模式向客戶端驗證服務的證書名稱。 默認值：“CN=ChangepointAPICertificate”證書名稱。 |
| 需要 HTTPS | 需要 HTTPS（真/假） 預設值：假。 |
Stage 2 執行配置腳本
使用配置參數的值來修改 web網站。
- 打開 PowerShell 提示符。
筆記： 如果您的服務器啟用了用戶帳戶控制，您必須使用提升的管理員權限打開 PowerShell 提示符。 - 導航到 CP web 服務配置目錄，默認：
配置CPWeb服務 - 執行 ./Configuration_AppAuth.ps1
- 依照提示操作。
為 WCF 配置單點登錄 (SSO) Web 服務
配置 PowerShell
- 打開 Windows PowerShell 提示符。
- 修改執行策略：
設定執行策略不受限制
使用 ISAPI 為 WCF 配置 SSO Web 服務
Stage 1 收集配置參數
確定以下配置參數的值。
| 範圍 | 描述 |
| Web服務路徑 | Changepoint WCF 的位置 Web 服務 web 應用 files. 默認： \API\CP Web 服務 |
| 需要 HTTPS | 需要 HTTPS（真/假）。 預設值：假。 |
| 變化點_RSA_ Cookie_Transform |
您用於 Cookie 加密的證書的名稱。 默認值：“CN=ChangepointAPICertificate”證書名稱。 |
| 服務證書名稱 | 輸入將用於向使用消息安全模式的客戶端驗證服務的證書名稱。 默認值：“CN=ChangepointAPICertificate”證書名稱。 |
| 簽名證書名稱 | 輸入簽名證書名稱。 這是您用於簽署消息的證書的名稱。 默認值：“CN=ChangepointAPICertificate”證書名稱。 |
| ISAPI_模式 | ISAPI 模式。 默認值：新台幣 |
| ISAPI_標頭 | ISAPI_Mode 為“HEADER”時使用的標頭，例如amp樂，空白。 |
| 索賠類型 | 輸入 SSO 聲明類型。 預設: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn |
Stage 2 執行配置腳本
- 打開 PowerShell 提示符。
筆記： 如果您的服務器啟用了用戶帳戶控制，您必須使用提升的管理員權限打開 PowerShell 提示符。 - 導航到 CP web 服務配置目錄，默認：
配置CPWeb服務 - 執行：./Configuration_SSO_ISAPI.ps1
- 依照提示操作。
使用 WS-Federation (ADFS 2.0) 為 WCF 配置 SSO Web 服務
Stage 1 收集配置參數
確定下表中配置參數的值，如下所示。 確保 ADFS_Server_URI 位於最終用戶瀏覽器的 Intranet 區域中。
筆記： 默認情況下，Changepoint 配置為使用已發布的聯合元數據文檔自動更新用於簽署安全令牌的公鑰。 在 ADFS 中，這是：
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
在某些情況下，可能無法從 Changepoint 訪問 ADFS 服務器 web 服務器，因此您必須在運行配置腳本後手動更新配置。 有關詳細信息，請參閱第 12 頁的“手動更新公鑰”。
| 範圍 | 描述 |
| Web服務路徑 | Changepoint WCF 的位置 Web 服務 web 應用 files。 默認： \API\CP Web 服務 |
| Web服務_URI | 用於 Changepoint WCF 的域標識符 Web 服務。 例如ample.， https://changepointapi.abc.corp/CPWebService |
| Changepoint_RSA_Cookie_Transform | 用於 Cookie 加密的證書的名稱。 默認值：“CN=ChangepointApiCertificate”證書名稱。 |
| 服務證書名稱 | 將用於使用消息安全模式向客戶端驗證服務的證書名稱。 默認值：“CN=ChangepointApiCertificate”證書名稱。 |
| 簽名證書名稱 | 用於簽署消息的證書的名稱。 默認值：使用“CN=ChangepointApiCertificate”證書名稱。 |
| ADFS_FederationServiceName | 聯合服務名稱。 獲取名稱： 從 ADFS 服務器，啟動 ADFS 2.0 管理控制台。 •從左側菜單中選擇ADFS 2.0。 •從操作窗格中選擇編輯聯合服務屬性。 聯合服務名稱位於常規選項卡上。 |
| 索賠類型 | SSO 聲明類型。 默認值為： http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn |
Stage 2 執行配置腳本
配置 web使用配置參數值的站點。
- 打開 PowerShell 提示符。
筆記： 如果您的服務器啟用了用戶帳戶控制，您必須使用提升的管理員權限打開 PowerShell 提示符。 - 導航到更改點 web 服務配置目錄，默認： 配置CPWeb服務
- 執行：./Configuration_SSO_ADFS.ps1
- 依照提示操作。
Stage 3 創建信賴方信任
在 ADFS 2.0 控制台中創建信賴方信任。
- 在您的 ADFS 服務器上，啟動 ADFS 2.0 控制台。
- 選擇操作 > 添加信賴方信任。
- 單擊開始。
- 選擇導入在線或本地網絡上發布的依賴方的相關數據。
- 輸入聯邦元數據地址，然後點擊下一步，例如amp樂：
https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml - 輸入一個顯示名稱，例如 Changepoint WCF API，然後單擊下一步、下一步、下一步，然後單擊關閉。
- 為上述 Changepoint 依賴方添加聲明規則。 對於 Changepoint，默認的聲明規則名稱是“UPN”。
- 將 LDAP 屬性“用戶主體名稱”映射到傳出聲明類型“* UPN”或“UPN”。
手動更新公鑰
獲取 ADFS 服務器令牌簽名指紋
- 從 ADFS 服務器，啟動 ADFS 2.0 管理控制台。
- 選擇服務 > 證書，然後雙擊令牌簽名證書。
- 選擇“詳細資料”標籤。
- 選擇指紋字段。
- 要獲取指紋值，請刪除所有空格，包括第一個空格。
要更新 Web.config file
- 編輯 ADFS web.config。 默認位置是：
EnterpriseRP-STS_ADFS - 在下面元素，找到 ida:FederationMetadataLocation 鍵並清除其值：
- 在下面， 找出元素並將其替換為以下內容： https://ADFS_Federation.ServiceName/adfs/services/trust“>https://ADFS_Federation.ServiceName/adfs/services/trust” />
測試 COM API 連接
- 運行 API 測試工具包。 默認位置是：
APIAPI 組件ApiTestKit.exe。 - 單擊連接字符串 > 加密器。
- 在純文本連接字符串字段中：
一個。 將 SERVERNAME 和 DATABASENAME 替換為您的數據庫信息。
灣。 將 USERID 和 PASSWORD 替換為您的數據庫管理員用戶帳戶信息。
C。 根據需要輸入超時值。 - 點選加密。
- 在加密連接字符串字段中，複製文本。
- 關閉對話框。
- 在 API 測試工具包菜單上，單擊連接 > COM API 連接測試器。
- 在當前版本選項卡中，將加密的連接字符串粘貼到連接字符串字段中。
- 在 LoginId 和 Password 字段中，輸入 Changepoint 帳戶的登錄 ID 和密碼。
- 在 Loglevel (0-8) 字段中，指定要在 COM API 日誌中返回的錯誤信息的級別 file 如果測試結果顯示連接有問題。
0 = 不記錄
1 = 源對象和方法
2 = 錯誤信息
3 = 輸入參數
4 = 退貨
5 =警告
8 = 檢查點
默認值為8。 - 按一下“連接”。
如果連接成功，則在結果字段中會顯示一條成功消息。 如果連接失敗，請檢查 COM API 日誌 file 對於錯誤。 日誌的默認位置 file 是APIAPILogs。
檢查已安裝 API 組件的版本
您可以使用版本檢查器實用程序來獲取有關已安裝組件的詳細信息，包括發布版本和路徑。
- 運行 CPVersionChecker.exe。 默認路徑為： APIAPI 組件
- 點擊閱讀。
檢查版本 Web 服務API
- 從服務器啟動 Internet Explorer Web 服務 API 已安裝，並輸入地址：
http://localhost.port/CPWeb.Service/WSLogin.asmx 其中端口是端口號 web安裝 CP 的站點Web服務虛擬目錄。 - 在 WSLogin 頁面上，單擊 GetVersion 鏈接。
- 單擊調用。
測試 Web 服務 API 連接
- 從服務器啟動 Internet Explorer Web 服務 API 已安裝，並輸入地址： http://localhost.port/CPWeb.Service/WSLogin.asmx 其中端口是端口號 web安裝 CP 的站點Web服務虛擬目錄。
- 在 WSLogin 頁面上，單擊 TestConnection 鏈接。
- 單擊調用。 4.在測試結果中：
- 如果元素為假，測試連接成功。
- 如果元素為真，測試連接失敗。 更多
有關失敗原因的信息，請參閱和測試結果中的元素，並檢查 API 日誌。 API 日誌的默認路徑是： APIAPILogs
設定 Web 語言服務器上的服務 API
- 部署變更點 Web 語言服務器上的服務 API，您必須添加或更新 tag 在 Web 服務API web.config。 的默認位置 Web.config file 是： APICP Web 服務Web.config
- 如果 tag 已經存在，請確保文化和 uiCulture 屬性都是“en-US”。
- 如果 tag 不存在，添加以下內容、評論和元素到web> 節點：web>
Visual Basic 選項：設置 strict=”true” 以禁止所有可能發生數據丟失的數據類型轉換。 設置explicit="true" 強制聲明所有變量。 --> - 重新啟動 IIS。
文件/資源
 | API 軟件 |
參考
- 使用者手冊manual.tools