Hướng dẫn cài đặt phần mềm API Changepoint

Hướng dẫn cài đặt API
Hướng dẫn tham khảo
điểm thay đổi 2021

© 2021 Changepoint Canada ULC Bảo lưu mọi quyền. QUYỀN CỦA CHÍNH PHỦ Hoa Kỳ-Việc sử dụng, sao chép hoặc tiết lộ bởi Chính phủ Hoa Kỳ phải tuân theo các hạn chế như quy định trong thỏa thuận cấp phép Changepoint Canada ULC và như được quy định trong DFARS 227.7202-1 (a) và 227.7202-3 (a) (1995), DFARS 252.227-7013 (c) (1) (ii) (OCT 1988), FAR 12.212 (a) (1995), FAR 52.227-19, hoặc FAR 52.227-14 (ALT III), nếu có. Sản phẩm này chứa thông tin bí mật và bí mật thương mại của Changepoint Canada ULC. Việc tiết lộ bị cấm mà không có sự cho phép trước bằng văn bản của Changepoint Canada ULC. Việc sử dụng sản phẩm này phải tuân theo các điều khoản và điều kiện của Thỏa thuận cấp phép của người dùng với Changepoint Canada ULC. Tài liệu chỉ có thể được tái tạo bởi Bên được cấp phép để sử dụng nội bộ. Nội dung của tài liệu này không được thay đổi, sửa đổi hoặc thay đổi mà không có sự đồng ý rõ ràng bằng văn bản của Changepoint Canada ULC. Changepoint Canada ULC có thể thay đổi nội dung được chỉ định ở đây vào bất kỳ lúc nào, có hoặc không cần thông báo.

Nội dung trốn

1 Cài đặt API Changepoint

2 Kiểm tra kết nối API COM

3 Kiểm tra Web Kết nối API dịch vụ

4 Tài liệu / Tài nguyên

4.1 Tài liệu tham khảo

5 Bài viết liên quan

Cài đặt API Changepoint

Giới thiệu về cài đặt API Changepoint
API Changepoint có sẵn dưới dạng một API COM, một dịch vụ Windows Communication Foundation (WCF) và để tương thích ngược, như một Web Dịch vụ Cải tiến Dịch vụ (WSE). Để biết thông tin về API Changepoint, hãy xem Tham chiếu API Changepoint. Để biết ghi chú nâng cấp, cảnh báo và các vấn đề đã biết, hãy xem Ghi chú phát hành trong thư mục nhóm ở Changepoint.
Nâng cấp API Changepoint
Nếu bạn đang nâng cấp từ bản phát hành trước của Changepoint, hãy sử dụng Bảng điều khiển Windows để gỡ cài đặt phiên bản trước của API Changepoint và các thành phần của nó trước khi cài đặt phiên bản này.
Yêu cầu về API Changepoint
Bạn phải cài đặt Changepoint trước khi cài đặt API Changepoint. Để biết các yêu cầu về phần mềm, hãy xem Ma trận Tương thích Phần mềm Changepoint, có sẵn trong thư mục Nhóm Bản vá và Ghi chú phát hành năm 2021 trong Changepoint.
File quy ước đường đi
Trong toàn bộ tài liệu này, các quy ước sau được sử dụng cho các đường dẫn chung:

Đường dẫn gốc của cài đặt Changepoint.
Đường dẫn mặc định là:
C:Chương trình Files (x86) ChangepointChangepoint
Vị trí gốc cho các tiện ích Changepoint phổ biến, chẳng hạn như tiện ích Cài đặt đăng nhập.
Đường dẫn mặc định là:
C:Chương trình Files (x86) Chung FilesChangepointThay đổi điểm

Cài đặt API Changepoint

Từ thư mục gốc phương tiện API Changepoint, chạy setup.exe.
Làm theo lời nhắc cho đến khi màn hình Chọn Tính năng xuất hiện.
Chọn các tính năng bạn muốn cài đặt, sau đó nhấp vào Tiếp theo.
Chọn thư mục đích API, mặc định API và nhấp vào Tiếp theo.
Ghi chú: Tiện ích Cài đặt Đăng nhập Changepoint được cài đặt trong LoginSettings, bất kể thư mục đích mà bạn chỉ định.
Nếu bạn đã chọn Web API dịch vụ: a. Khi lựa chọn
a Web Màn hình trang web xuất hiện, chọn một webtrang web để thêm thư mục ảo vào, sau đó bấm Tiếp theo.
b. Nhấn Next để tiếp tục. 6. Khi quá trình cài đặt API hoàn tất, hãy nhấp vào Hoàn tất.

Định cấu hình API Changepoint để nhận biết bộ nhớ cache
Để định cấu hình API Changepoint nhận biết bộ nhớ cache, hãy thay thế các giá trị cho “bộ nhớ cache. Mật khẩu ”và“ bộ nhớ đệm. Máy chủ ”trong CP Web Dịch vụWeb.cấu hình file với các giá trị được sử dụng trong Doanh nghiệpWeb.cấu hình file.
Cho phép Web Cải tiến dịch vụ (WSE)

Chỉnh sửa Web.cấu hình file vì web dịch vụ. Vị trí mặc định là:
APICP Web Dịch vụWeb.cấu hình
Tìm ba trường hợp của dòng chú thích sau:
<! - Bỏ ghi chú phần tử sau nếu bạn đang sử dụng Web API Cải tiến Dịch vụ (WSE). Để lại bình luận nếu sử dụng dịch vụ WCF và không cài đặt Web Cải tiến dịch vụ (WSE) ->
Bỏ ghi chú phần tử theo sau mỗi trường hợp của dòng nhận xét:
<section name=”microsoft.web.services2 ″…>webDịch vụ>web.services2>
Ghi chú: CácwebServices> phần tử cần bỏ chú thích là phần tử con củaweb>.

Định cấu hình ghi nhật ký cho Web Dịch vụ API
Bạn phải đặt nhật ký file đường dẫn và cấp độ nhật ký. Các cấp độ nhật ký là tích lũy. Cho người yêu cũample, nếu bạn chỉ định cấp độ 3, thì cấp độ 1, 2 và 3 sẽ được ghi lại. Mức nhật ký mặc định là 8.

Chỉnh sửa web dịch vụ Web.config. Vị trí mặc định là:
APICP Web Dịch vụWeb.cấu hình
Đặt nhật kýFileĐường dẫn. Giá trị mặc định là APIAPILogs. 3. Đặt LogLevel. Các giá trị hợp lệ là:
0 = Không ghi nhật ký
1 = Đối tượng và phương thức nguồn
2 = Thông báo lỗi
3 = Các thông số đầu vào
4 = Lợi nhuận
5 = Cảnh báo
8 = Trạm kiểm soát

Định cấu hình xác thực thư mục ảo cho Web Dịch vụ API
Bạn phải bật quyền truy cập ẩn danh và tắt xác thực Windows tích hợp cho CPWebDịch vụ thư mục ảo trong Dịch vụ Thông tin Internet (IIS). Để biết thêm thông tin, hãy xem tài liệu Microsoft IIS.
Định cấu hình cài đặt kết nối cơ sở dữ liệu cho Web Dịch vụ API
Sử dụng tiện ích Cài đặt Đăng nhập để mã hóa cài đặt kết nối cơ sở dữ liệu trong Web Dịch vụ API Web.cấu hình file. Để biết thêm thông tin, hãy tìm kiếm “Định cấu hình Cài đặt Kết nối Cơ sở dữ liệu” trong Hướng dẫn Cài đặt Changepoint.
Định cấu hình xác thực cho Changepoint WCF Web Dịch vụ
Bạn có thể định cấu hình Xác thực ứng dụng và đăng nhập một lần (SSO) cho Changepoint WCF Web Dịch vụ.
Các tùy chọn triển khai sau có sẵn bằng cách sử dụng Dịch vụ Mã thông báo Bảo mật (STS):

SSO sử dụng ISAPI SSL tùy chọn
Yêu cầu SSO sử dụng WS-Federation (ADFS 2.0) SSL

Nếu SSL được yêu cầu, tập lệnh cấu hình đảm bảo rằng nó được sử dụng.
Các tập lệnh cấu hình cho ISAPI và xác thực ứng dụng có thể kích hoạt SSL tùy chọn.
Định cấu hình xác thực ứng dụng cho WCF Web Dịch vụ
Loại xác thực mặc định cho Changepoint WCF Web Dịch vụ là xác thực ứng dụng.
Sử dụng các quy trình trong phần này để:

cấu hình Changepoint WCF Web Dịch vụ sử dụng xác thực ứng dụng bằng SSL
hoàn nguyên Changepoint WCF Web Dịch vụ xác thực ứng dụng sau khi đã triển khai một trong các triển khai SSO

Định cấu hình PowerShell

Mở lời nhắc Windows PowerShell.
Sửa đổi chính sách thực thi:
Set-ExecutionPolicy Không hạn chế

Stage 1 Thu thập các thông số cấu hình
Xác định các giá trị cho các tham số cấu hình.

Tham số	Sự miêu tả
WebDịch vụ_Đường dẫn	Vị trí của Changepoint WCF Web Dịch vụ web ứng dụng files. Mặc định: \ API \ CP Web Dịch vụ
Dịch vụChứng chỉ_ Tên	Tên chứng chỉ sẽ được sử dụng để xác thực dịch vụ cho khách hàng bằng chế độ bảo mật Thư. Mặc định: Tên chứng chỉ “CN = ChangepointAPICertificate”.
yêu cầu HTTPS	Yêu cầu HTTPS (Đúng / Sai) Mặc định: Sai.

Stage 2 Thực thi các tập lệnh cấu hình
Sử dụng các giá trị cho các thông số cấu hình để sửa đổi cấu hình của webcác trang web.

Mở lời nhắc PowerShell.
Ghi chú: Nếu máy chủ của bạn đã bật Kiểm soát tài khoản người dùng, bạn phải mở lời nhắc PowerShell bằng quyền quản trị viên nâng cao.
Điều hướng đến CP web thư mục cấu hình dịch vụ, mặc định:
CP cấu hìnhWebDịch vụ
Thực thi ./Configuration_AppAuth.ps1
Làm theo lời nhắc.

Định cấu hình đăng nhập một lần (SSO) cho WCF Web Dịch vụ
Định cấu hình PowerShell

Mở lời nhắc Windows PowerShell.
Sửa đổi chính sách thực thi:
Set-ExecutionPolicy Không hạn chế

Định cấu hình SSO bằng ISAPI cho WCF Web Dịch vụ
Stage 1 Thu thập các thông số cấu hình
Xác định giá trị cho các thông số cấu hình sau.

Tham số	Sự miêu tả
WebDịch vụ_Đường dẫn	Vị trí của Changepoint WCF Web Dịch vụ web ứng dụng files. Mặc định: \ API \ CP Web Dịch vụ
yêu cầu HTTPS	Yêu cầu HTTPS (Đúng / Sai). Mặc định: Sai.
Điểm thay đổi_RSA_ Cookie_Transform	Tên của chứng chỉ mà bạn sử dụng để mã hóa Cookie. Mặc định: Tên chứng chỉ “CN = ChangepointAPICertificate”.
Dịch vụCertificate_Name	Nhập tên chứng chỉ sẽ được sử dụng để xác thực dịch vụ cho khách hàng bằng chế độ bảo mật Thư. Mặc định: Tên chứng chỉ “CN = ChangepointAPICertificate”.
Ký tênCertificate_Name	Nhập tên chứng chỉ ký. Đây là tên của chứng chỉ mà bạn sử dụng để ký thư. Mặc định: Tên chứng chỉ “CN = ChangepointAPICertificate”.
Chế độ ISAPI_	Chế độ ISAPI. Mặc định: NT
ISAPI_Header	Tiêu đề được sử dụng khi ISAPI_Mode là “HEADER”, ví dụample, trống.
Yêu Cầu Loại	Nhập Loại Yêu cầu SSO. Mặc định: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Thực thi các tập lệnh cấu hình

Mở lời nhắc PowerShell.
Ghi chú: Nếu máy chủ của bạn đã bật Kiểm soát tài khoản người dùng, bạn phải mở lời nhắc PowerShell bằng quyền quản trị viên nâng cao.
Điều hướng đến CP web thư mục cấu hình dịch vụ, mặc định:
CP cấu hìnhWebDịch vụ
Thực thi: ./Configuration_SSO_ISAPI.ps1
Làm theo lời nhắc.

Định cấu hình SSO bằng WS-Federation (ADFS 2.0) cho WCF Web Dịch vụ
Stage 1 Thu thập các thông số cấu hình
Xác định các giá trị cho các tham số cấu hình trong bảng, bên dưới. Đảm bảo rằng ADFS_Server_URI nằm trong vùng Intranet của trình duyệt của người dùng cuối.
Ghi chú: Theo mặc định, Changepoint được định cấu hình để tự động cập nhật khóa công khai được sử dụng để ký mã thông báo bảo mật bằng cách sử dụng tài liệu siêu dữ liệu liên kết đã xuất bản. Trong ADFS, đây là:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
Trong một số trường hợp, có thể không truy cập được máy chủ ADFS từ Changepoint web vì vậy bạn sẽ phải cập nhật cấu hình theo cách thủ công sau khi chạy tập lệnh cấu hình. Để biết chi tiết, hãy xem “Cập nhật khóa công khai theo cách thủ công” trên trang 12.

Tham số	Sự miêu tả
WebDịch vụ_Đường dẫn	Vị trí của Changepoint WCF Web Dịch vụ web ứng dụng fileS. Mặc định: \ API \ CP Web Dịch vụ
WebDịch vụ_URI	Định danh miền mà bạn sử dụng cho Changepoint WCF Web Dịch vụ. Cho người yêu cũample., https://changepointapi.abc.corp/CPWebService
Điểm thay đổi_RSA_ Cookie_Transform	Tên của chứng chỉ mà bạn sử dụng để mã hóa Cookie. Mặc định: Tên chứng chỉ “CN = ChangepointApiCertificate”.
Dịch vụCertificate_Name	Tên chứng chỉ sẽ được sử dụng để xác thực dịch vụ cho khách hàng bằng chế độ bảo mật Thư. Mặc định: Tên chứng chỉ “CN = ChangepointApiCertificate”.
Ký tênCertificate_Name	Tên của chứng chỉ mà bạn sử dụng để ký thư. Mặc định: Tên chứng chỉ “CN = ChangepointApiCertificate” được sử dụng.
ADFS_FeederServiceName	Tên dịch vụ liên kết. Để lấy tên: Từ máy chủ ADFS, Khởi chạy bảng điều khiển quản lý ADFS 2.0. • Chọn ADFS 2.0 từ menu bên trái. • Từ ngăn Hành động, chọn Chỉnh sửa Thuộc tính Dịch vụ Liên kết. Tên Dịch vụ Liên kết nằm trên tab Chung.
Yêu Cầu Loại	Loại yêu cầu SSO. Giá trị mặc định là: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stage 2 Thực thi các tập lệnh cấu hình
Cấu hình webcác trang web sử dụng các giá trị cho các thông số cấu hình.

Mở lời nhắc PowerShell.
Ghi chú: Nếu máy chủ của bạn đã bật Kiểm soát tài khoản người dùng, bạn phải mở lời nhắc PowerShell bằng quyền quản trị viên nâng cao.
Điều hướng đến Changepoint web thư mục cấu hình dịch vụ, mặc định: CP cấu hìnhWebDịch vụ
Thực hiện: ./Configuration_SSO_ADFS.ps1
Làm theo lời nhắc.

Stage 3 Tạo niềm tin cho bên dựa vào
Tạo Niềm tin của Bên dựa vào trong Bảng điều khiển ADFS 2.0.

Trên máy chủ ADFS của bạn, khởi chạy bảng điều khiển ADFS 2.0.
Chọn Hành động> Thêm sự tin cậy của Bên dựa vào.
Nhấp vào Bắt đầu.
Chọn Nhập dữ liệu về bên phụ thuộc được xuất bản trực tuyến hoặc trên mạng cục bộ.
Nhập địa chỉ siêu dữ liệu Liên kết, sau đó bấm Tiếp theo, ví dụamplê:
https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml
Nhập Tên hiển thị, ví dụ: Changepoint WCF API và nhấp vào Tiếp theo, Tiếp theo, Tiếp theo, sau đó Đóng.
Thêm Quy tắc xác nhận quyền sở hữu cho Bên dựa vào Changepoint ở trên. Đối với Changepoint, tên quy tắc Xác nhận quyền sở hữu mặc định là “UPN”.
Ánh xạ Thuộc tính LDAP “Tên-Chính-Người dùng” với Loại Yêu cầu Đi đi “* UPN” hoặc “UPN”.

Cập nhật khóa công khai theo cách thủ công
Để có được Dấu tay ký tên mã thông báo máy chủ ADFS

Từ máy chủ ADFS, Khởi chạy bảng điều khiển Quản lý ADFS 2.0.
Chọn Dịch vụ> Chứng chỉ và nhấp đúp vào chứng chỉ ký mã thông báo.
Chọn tab Chi tiết.
Chọn trường Thumbprint.
Để nhận giá trị dấu vân tay, hãy xóa tất cả các khoảng trắng kể cả khoảng trắng đầu tiên.

Để cập nhật Web.cấu hình file

Chỉnh sửa ADFS web.config. Vị trí mặc định là:
EnterpriseRP-STS_ADFS
Bên dưới , tìm khóa ida: FederationMetadataLocation và xóa giá trị của nó:
Dưới , tìm và thay thế nó bằng phần tử sau: https://ADFS_Federation.ServiceName/adfs/services/trust“>https://ADFS_Federation.ServiceName/adfs/services/trust”/>

Kiểm tra kết nối API COM

Chạy Bộ kiểm tra API. Vị trí mặc định là:
Thành phần APIAPIApiTestKit.exe.
Nhấp vào Chuỗi kết nối> Mã hóa.
Trong trường Chuỗi kết nối văn bản thuần túy:
một. Thay thế SERVERNAME và DATABASENAME bằng thông tin cơ sở dữ liệu của bạn.
b. Thay thế USERID và PASSWORD bằng thông tin tài khoản người dùng quản trị cơ sở dữ liệu của bạn.
c. Nhập giá trị thời gian chờ nếu cần.
Nhấp vào Mã hóa.
Trong trường Chuỗi kết nối được mã hóa, hãy sao chép văn bản.
Đóng hộp thoại.
Trên menu Bộ kiểm tra API, nhấp vào Kết nối> Bộ kiểm tra kết nối API COM.
Trong tab Phiên bản Hiện tại, dán chuỗi kết nối được mã hóa vào trường Chuỗi kết nối.
Trong trường LoginId và Password, hãy nhập ID đăng nhập và mật khẩu cho tài khoản Changepoint của bạn.
Trong trường Loglevel (0-8), chỉ định mức thông tin lỗi sẽ được trả lại trong nhật ký COM API file nếu kết quả kiểm tra cho thấy sự cố với kết nối.
0 = Không ghi nhật ký
1 = Đối tượng và phương thức nguồn
2 = Thông báo lỗi
3 = Các thông số đầu vào
4 = Lợi nhuận
5 = Cảnh báo
8 = Trạm kiểm soát
Giá trị mặc định là 8.
Nhấp vào Kết nối.
Nếu kết nối thành công, thông báo thành công sẽ hiển thị trong trường Kết quả. Nếu kết nối không thành công, hãy kiểm tra nhật ký COM API file cho các lỗi. Vị trí mặc định của nhật ký file Là APIAPILogs.

Kiểm tra phiên bản của các thành phần API đã cài đặt
Bạn có thể sử dụng tiện ích kiểm tra phiên bản để lấy thông tin chi tiết về các thành phần đã cài đặt, bao gồm phiên bản phát hành và đường dẫn.

Chạy CPVersionChecker.exe. Đường dẫn mặc định là: Thành phần APIAPI
Nhấp vào Đọc.

Kiểm tra phiên bản của Web Dịch vụ API

Khởi chạy Internet Explorer từ máy chủ nơi Web API dịch vụ được cài đặt và nhập địa chỉ:
http://localhost.port/CPWeb.Service/WSLogin.asmx trong đó cổng là số cổng của webtrang web mà bạn đã cài đặt CPWebDịch vụ thư mục ảo.
Trên trang WSLogin, nhấp vào liên kết GetVersion.
Nhấp vào Gọi.

Kiểm tra Web Kết nối API dịch vụ

Khởi chạy Internet Explorer từ máy chủ nơi Web API dịch vụ được cài đặt và nhập địa chỉ: http://localhost.port/CPWeb.Service/WSLogin.asmx trong đó cổng là số cổng của webtrang web mà bạn đã cài đặt CPWebDịch vụ thư mục ảo.
Trên trang WSLogin, hãy nhấp vào liên kết TestConnection.
Nhấp vào Gọi. 4. Trong kết quả kiểm tra:

Nếu phần tử là false, kết nối thử nghiệm đã thành công.
Nếu phần tử là true, kết nối thử nghiệm không thành công. Để biết thêm
thông tin về lý do cho sự thất bại, xem và trong kết quả thử nghiệm và kiểm tra nhật ký API. Đường dẫn mặc định đến nhật ký API là: APIAPILogs

Thiết lập Web API dịch vụ trên máy chủ ngôn ngữ

Để triển khai Changepoint Web API dịch vụ trên máy chủ ngôn ngữ, bạn phải thêm hoặc cập nhật tag trong Web Dịch vụ API web.config. Vị trí mặc định của Web.cấu hình file Là: APICP Web Dịch vụWeb.cấu hình
Nếu tag đã tồn tại, hãy đảm bảo rằng cả hai thuộc tính culture và uiCulture đều là “en-US”.
Nếu tag chưa tồn tại, hãy thêm phần sau , bình luận, và các yếu tố củaweb> nút:web>
Tùy chọn Visual Basic: Đặt nghiêm ngặt = ”true” để không cho phép tất cả các chuyển đổi loại dữ liệu có thể xảy ra mất dữ liệu. Đặt explicit = ”true” để buộc khai báo tất cả các biến. ->
Khởi động lại IIS.