מדריך התקנת API
מדריך עזר
נקודת שינוי 2021

© 2021 Changepoint Canada ULC כל הזכויות שמורות. זכויות ממשלת ארה"ב-שימוש, שכפול או חשיפה על ידי ממשלת ארה"ב כפופים להגבלות כמפורט בהסכם הרישיון של Changepoint Canada ULC וכמפורט ב-DFARS 227.7202-1(a) ו-227.7202-3(a) (1995), DFARS 252.227-7013(c)(1)(ii) (OCT 1988), FAR 12.212(a) (1995), FAR 52.227-19, או FAR 52.227-14 (ALT III), לפי העניין. מוצר זה מכיל מידע סודי וסודות מסחריים של Changepoint Canada ULC. חשיפה אסורה ללא אישור מפורש מראש ובכתב של Changepoint Canada ULC. השימוש במוצר זה כפוף לתנאים ולהגבלות של הסכם הרישיון של המשתמש עם Changepoint Canada ULC. ניתן לשכפל תיעוד רק על ידי בעל הרישיון לשימוש פנימי. אין לשנות, לשנות או לשנות את התוכן של מסמך זה ללא הסכמה מפורשת בכתב של Changepoint Canada ULC. Changepoint Canada ULC רשאית לשנות את התוכן המצוין כאן בכל עת, עם או בלי הודעה מוקדמת.

תוֹכֶן לְהַסתִיר
1 התקנת ה-Changepoint API
2 בדיקת חיבור COM API
3 בודקים את Web חיבור שירותי API
4 מסמכים / משאבים
4.1 הפניות
5 פוסטים קשורים

התקנת ה-Changepoint 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
עליך להתקין את Changepoint לפני שתתקין את Changepoint API. לדרישות התוכנה, עיין ב- Changepoint Software Compatibility Matrix, הזמינה בתיקיית צוות הערות ותיקונים לשנת 2021 ב-Changepoint.
File מוסכמות נתיב
לאורך מסמך זה, נעשה שימוש במוסכמות הבאות עבור נתיבים נפוצים:

  • נתיב הבסיס של התקנת Changepoint.
    נתיב ברירת המחדל הוא:
    C: תוכנית Files (x86)ChangepointChangepoint
  • מיקום השורש עבור כלי עזר נפוצים של Changepoint, כגון כלי השירות Login Settings.
    נתיב ברירת המחדל הוא:
    C: תוכנית Files (x86) נפוץ FilesChangepointChangepoint

התקנת ה-Changepoint API

  1. מספריית השורש של המדיה של Changepoint API, הפעל את setup.exe.
  2. פעל לפי ההנחיות עד להופעת מסך בחר תכונות.
  3. בחר את התכונות שברצונך להתקין ולאחר מכן לחץ על הבא.
  4. בחר את תיקיית היעד של ה-API, ברירת מחדל ממשק API ולחץ על הבא.
    פֶּתֶק: כלי השירות Changepoint Login Settings מותקן ב LoginSettings, ללא קשר לתיקיית היעד שתציין.
  5. אם בחרת את Web שירות API: א. כאשר הבחירה
    a Web מסך האתר מופיע, בחר א webאתר כדי להוסיף אליו את הספרייה הוירטואלית ולאחר מכן לחץ על הבא.
    ב. לחץ על הבא כדי להמשיך. 6. בסיום ההתקנה של ה-API, לחץ על סיום.

הגדרת ה-Changepoint API כך שיהיה מודע למטמון
כדי להגדיר את ה-Changepoint API להיות מודע למטמון, החלף את הערכים עבור "cache. סיסמה" ו"מטמון. מקשי שרתים ב-CP Web שירותיםWeb.config file עם הערכים המשמשים ב-EnterpriseWeb.config file.
מפעיל Web שיפורי שירותים (WSE)

  1. ערוך את Web.config file עֲבוּר web שירותים. מיקום ברירת המחדל הוא:
    APICP Web שירותיםWeb.config
  2. מצא את שלושת המופעים של שורת ההערות הבאה:
    < !– בטל את ההערה לרכיב הבא אם אתה משתמש Web API של שיפורי שירות (WSE). השאר הערות אם אתה משתמש בשירותי WCF ולא מתקין Web שיפורי שירות (WSE) –>
  3. בטל את ההערה לרכיב שאחרי כל מופע של שורת ההערה:
    <שם הקטע="microsoft.web.services2″ … >webשירותים>web.services2>
    פֶּתֶק: הwebרכיב Services> שאין להגיב הוא צאצא שלוweb>.

הגדרת רישום עבור Web שירות API
עליך להגדיר את היומן file רמות נתיב ויומן. רמות היומן הן מצטברות. למשלample, אם אתה מציין רמה 3, אז רמות 1, 2 ו-3 נרשמות. רמת יומן ברירת המחדל היא 8.

  1. ערוך את web שירותים Web.config. מיקום ברירת המחדל הוא:
    APICP Web שירותיםWeb.config
  2. הגדר את היומןFileנָתִיב. ערך ברירת המחדל הוא APIAPILlogs. 3. הגדר את LogLevel. הערכים החוקיים הם:
    0 = אין רישום
    1 = אובייקט מקור ושיטה
    2 = הודעת שגיאה
    3 = קלט פרמטרים
    4 = החזרות
    5 = אזהרה
    8 = מחסום

הגדרת אימות ספריה וירטואלית עבור Web שירות API
עליך לאפשר גישה אנונימית ולהשבית אימות משולב של Windows עבור ה-CPWebמדריך שירות וירטואלי בשירותי מידע באינטרנט (IIS). למידע נוסף, עיין בתיעוד Microsoft IIS.
הגדרת הגדרות חיבור מסד הנתונים עבור Web שירות API
השתמש בכלי הגדרות התחברות כדי להצפין את הגדרות חיבור מסד הנתונים ב- Web שירות API Web.config file. למידע נוסף, חפש "הגדרת הגדרות חיבור למסד נתונים" במדריך ההתקנה של נקודת שינוי.
הגדרת אימות עבור Changepoint WCF Web שירותים
אתה יכול להגדיר אימות יישומים וכניסה יחידה (SSO) עבור Changepoint WCF Web שירותים.
אפשרויות היישום הבאות זמינות באמצעות Secure Token Service (STS):

  • SSO באמצעות ISAPI SSL אופציונלי
  • נדרש SSO באמצעות WS-Federation (ADFS 2.0) SSL

אם נדרש SSL, סקריפט התצורה מבטיח כי נעשה בו שימוש.
סקריפטי התצורה עבור ISAPI ואימות יישומים יכולים לאפשר SSL באופן אופציונלי.
הגדרת אימות יישומים עבור WCF Web שירותים
סוג האימות המוגדר כברירת מחדל עבור Changepoint WCF Web שירותים הם אימות יישומים.
השתמש בהליכים בסעיף זה כדי:

  • הגדר את Changepoint WCF Web שירותים לשימוש באימות יישומים עם SSL
  • החזר את Changepoint WCF Web שירותים לאימות יישומים לאחר הטמעת אחת מיישומי SSO

הגדר את PowerShell

  1. פתח בקשת Windows PowerShell.
  2. שנה את מדיניות הביצוע:
    Set-ExecutionPolicy ללא הגבלה

Stagה 1 אסוף פרמטרים של תצורה
קבע את הערכים עבור פרמטרי התצורה.

פָּרָמֶטֶר תֵאוּר
Webשירות_נתיב מיקום ה-Changepoint WCF Web שירותים web בַּקָשָׁה files.
בְּרִירַת מֶחדָל: \API\CP Web שירותים
תעודת שירות_
שֵׁם		 שם האישור שישמש לאימות השירות ללקוחות באמצעות מצב אבטחת הודעות.
ברירת מחדל: שם האישור "CN=ChangepointAPICertificate".
דורש HTTPS דרוש HTTPS (נכון/לא נכון)
ברירת מחדל: שקר.

Stagה 2 בצע סקריפטים של תצורה
השתמש בערכים של פרמטרי התצורה כדי לשנות את התצורה של webאתרים.

  1.  פתח בקשת PowerShell.
    פֶּתֶק: אם בשרת שלך מופעלת בקרת חשבון משתמש, עליך לפתוח את שורת PowerShell באמצעות הרשאות מנהל מוגברות.
  2. נווט אל ה-CP web ספריית תצורת השירות, ברירת מחדל:
    ConfigurationCPWebשֵׁרוּת
  3.  הפעל את ./Configuration_AppAuth.ps1
  4. עקוב אחר ההנחיות.

הגדרת כניסה יחידה (SSO) עבור WCF Web שירותים
הגדר את PowerShell

  1. פתח בקשת Windows PowerShell.
  2. שנה את מדיניות הביצוע:
    Set-ExecutionPolicy ללא הגבלה

הגדרת SSO באמצעות ISAPI עבור WCF Web שירותים
Stagה 1 אסוף פרמטרים של תצורה
קבע את הערכים עבור פרמטרי התצורה הבאים.

פָּרָמֶטֶר תֵאוּר
Webשירות_נתיב המיקום של Changepoint WCF Web שירותים web בַּקָשָׁה files.
בְּרִירַת מֶחדָל: \API\CP Web שירותים
דורש HTTPS דרוש HTTPS (True/False).
ברירת מחדל: שקר.
Changepoint_RSA_
Cookie_Transform		 שם האישור שבו אתה משתמש להצפנת Cookie.
ברירת מחדל: שם האישור "CN=ChangepointAPICertificate".
ServiceCertificate_Name הזן את שם האישור שישמש לאימות השירות ללקוחות באמצעות מצב אבטחת הודעות.
ברירת מחדל: שם האישור "CN=ChangepointAPICertificate".
SigningCertificate_Name הזן את שם תעודת החתימה. זהו השם של האישור שבו אתה משתמש לחתימה על הודעות.
ברירת מחדל: שם האישור "CN=ChangepointAPICertificate".
ISAPI_Mode מצב ISAPI.
ברירת מחדל: NT
ISAPI_Header הכותרת המשמשת כאשר ISAPI_Mode היא "HEADER", למשלample, ריק.
ClaimType הזן את סוג תביעת SSO.
בְּרִירַת מֶחדָל: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stagה 2 בצע סקריפטים של תצורה

  1. פתח בקשת PowerShell.
    פֶּתֶק: אם בשרת שלך מופעלת בקרת חשבון משתמש, עליך לפתוח את שורת PowerShell באמצעות הרשאות מנהל מוגברות.
  2. נווט אל ה-CP web ספריית תצורת השירות, ברירת מחדל:
    ConfigurationCPWebשֵׁרוּת
  3. בצע: ./Configuration_SSO_ISAPI.ps1
  4. עקוב אחר ההנחיות.

הגדרת SSO באמצעות WS-Federation (ADFS 2.0) עבור WCF Web שירותים
Stagה 1 אסוף פרמטרים של תצורה
קבע את הערכים עבור פרמטרי התצורה בטבלה שלהלן. ודא שה-ADFS_Server_URI נמצא באזור האינטראנט של הדפדפן של משתמש הקצה.
פֶּתֶק: כברירת מחדל, Changepoint מוגדרת לעדכן אוטומטית את המפתחות הציבוריים המשמשים לחתימה על אסימוני אבטחה באמצעות מסמך המטא נתונים של הפדרציה שפורסם. ב-ADFS זה:
https://ADFS_Federation.ServiceName/FederationMetadata/2007-06/FederationMetadata.xml
במקרים מסוימים ייתכן שלא ניתן יהיה להגיע לשרת ADFS מ-Changepoint web שרת כך שתצטרך לעדכן את התצורה באופן ידני לאחר הפעלת סקריפט התצורה. לפרטים, ראה "עדכון ידני של מפתחות ציבוריים" בעמוד 12.

פָּרָמֶטֶר תֵאוּר
Webשירות_נתיב מיקום ה-Changepoint WCF Web שירותים web בַּקָשָׁה fileס. בְּרִירַת מֶחדָל: \API\CP Web שירותים
Webשירות_URI מזהה דומיין שבו אתה משתמש עבור Changepoint WCF Web שירותים. למשלampל., https://changepointapi.abc.corp/CPWebService
Changepoint_RSA_ Cookie_Transform שם האישור שבו אתה משתמש להצפנת קובצי Cookie. ברירת מחדל: שם האישור "CN=ChangepointApiCertificate".
ServiceCertificate_Name שם האישור שישמש לאימות השירות ללקוחות באמצעות מצב אבטחת הודעות.
ברירת מחדל: שם האישור "CN=ChangepointApiCertificate".
SigningCertificate_Name שם התעודה שבה אתה משתמש לחתימה על הודעות.
ברירת מחדל: נעשה שימוש בשם האישור "CN=ChangepointApiCertificate".
ADFS_ FederationServiceName שם שירות הפדרציה. כדי לקבל את השם: משרת ADFS, הפעל את מסוף הניהול של ADFS 2.0.
בחר ADFS 2.0 מהתפריט השמאלי.
•בחלונית הפעולה בחר ערוך מאפייני שירות הפדרציה.
שם שירות הפדרציה נמצא בכרטיסייה כללי.
ClaimType סוג תביעת SSO. ברירת המחדל היא: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

Stagה 2 בצע סקריפטים של תצורה
הגדר את webאתרים המשתמשים בערכים של פרמטרי התצורה.

  1. פתח בקשת PowerShell.
    פֶּתֶק: אם בשרת שלך מופעלת בקרת חשבון משתמש, עליך לפתוח את שורת PowerShell באמצעות הרשאות מנהל מוגברות.
  2. נווט אל נקודת השינוי web ספריית תצורת השירות, ברירת מחדל: ConfigurationCPWebשֵׁרוּת
  3.  בצע: ./Configuration_SSO_ADFS.ps1
  4. עקוב אחר ההנחיות.

Stagה 3 צור אמון צד מסתמך
צור את אמון הצד המסתמך במסוף ADFS 2.0.

  1. בשרת ה-ADFS שלך, הפעל את מסוף ADFS 2.0.
  2. בחר פעולה > הוסף אמון צד מסתמך.
  3. לחץ על התחל.
  4. בחר ייבא נתונים על הצד המסתמך שפורסמו באינטרנט או ברשת מקומית.
  5. הזן את כתובת המטא-נתונים של הפדרציה ולאחר מכן לחץ על הבא, למשלampעל:
    https://changepointapi.abc.corp/cpwebservice/federationmetadata/2007-06/federationmetadata.xml
  6. הזן שם תצוגה, למשל Changepoint WCF API, ולחץ על הבא, הבא, הבא ולאחר מכן סגור.
  7. הוסף כלל תביעה עבור הצד המסתמך על נקודת השינוי לעיל. עבור Changepoint, שם כלל התביעה המוגדר כברירת מחדל הוא "UPN".
  8. מפה את תכונת ה-LDAP "שם עיקרי משתמש" לסוג תביעה יוצאת "* UPN" או "UPN".

עדכון ידני של מפתחות ציבוריים
כדי להשיג את טביעת האצבע של חתימת אסימון שרת ADFS

  1. משרת ADFS, הפעל את מסוף ניהול ADFS 2.0.
  2. בחר שירות > אישורים ולחץ פעמיים על אישור חתימת האסימון.
  3. בחר בכרטיסייה פרטים.
  4. בחר בשדה טביעת אצבע.
  5. כדי לקבל את ערך טביעת האגודל, הסר את כל הרווחים כולל הרווח הראשון.

כדי לעדכן את Web.config file

  1. ערוך את ה-ADFS web.config. מיקום ברירת המחדל הוא:
    EnterpriseRP-STS_ADFS
  2. תחת רכיב, מצא את מפתח ida:FederationMetadataLocation ונקה את הערך שלו:
  3. תַחַת , למצוא את ה אלמנט והחליפו אותו ברכיב הבא: https://ADFS_Federation.ServiceName/adfs/services/trust">https://ADFS_Federation.ServiceName/adfs/services/trust" />

בדיקת חיבור COM API

  1. הפעל את ערכת בדיקת ה-API. מיקום ברירת המחדל הוא:
    APIAPI ComponentsApiTestKit.exe.
  2. לחץ על מחרוזת חיבור > מוצפן.
  3. בשדה המחרוזת של חיבורי טקסט רגיל:
    א. החלף את SERVERNAME ואת DATABASENAME בפרטי מסד הנתונים שלך.
    ב. החלף את USERID ו-PASSWORD בפרטי חשבון המשתמש של מנהל מסד הנתונים שלך.
    ג. הזן את ערך הזמן הקצוב לפי הצורך.
  4. לחץ על הצפנה.
  5. בשדה 'מחרוזת חיבור מוצפנת', העתק את הטקסט.
  6. סגור את תיבת הדו-שיח.
  7. בתפריט API Test Kit, לחץ על Connection > COM API Connection Tester.
  8. בכרטיסייה גרסה נוכחית, הדבק את מחרוזת החיבור המוצפנת בשדה Connection String.
  9. בשדות LoginId וסיסמה, הזן את מזהה הכניסה והסיסמה עבור חשבון Changepoint שלך.
  10. בשדה Loglevel (0-8), ציין את רמת פרטי השגיאה שיש להחזיר ביומן COM API file אם תוצאת הבדיקה מראה על בעיה בחיבור.
    0 = אין רישום
    1 = אובייקט מקור ושיטה
    2 = הודעת שגיאה
    3 = קלט פרמטרים
    4 = החזרות
    5 = אזהרה
    8 = מחסום
    ברירת המחדל היא 8.
  11. לחץ על התחבר.
    אם החיבור הצליח, תוצג הודעת הצלחה בשדה התוצאה. אם החיבור נכשל, בדוק את יומן ה-API של COM file לשגיאות. מיקום ברירת המחדל של היומן file הוא APIAPILlogs.

בדיקת הגרסה של רכיבי API המותקנים
אתה יכול להשתמש בכלי בודק הגירסאות כדי לקבל פרטים על הרכיבים המותקנים, כולל גרסת הגרסה והנתיב.

  1. הפעל את CPVersionChecker.exe. נתיב ברירת המחדל הוא: רכיבי APIAPI
  2. לחץ על קרא.

בודק את הגרסה של Web שירות API

  1. הפעל את Internet Explorer מהשרת שבו Web שירות API מותקן, והזן את הכתובת:
    http://localhost.port/CPWeb.Service/WSLogin.asmx  כאשר יציאה הוא מספר היציאה של webהאתר שבו התקנת את ה-CPWebספרייה וירטואלית של שירות.
  2. בדף WSLogin, לחץ על הקישור GetVersion.
  3. לחץ על הפעל.

בודקים את Web חיבור שירותי API

  1. הפעל את Internet Explorer מהשרת שבו Web שירות API מותקן, והזן את הכתובת: http://localhost.port/CPWeb.Service/WSLogin.asmx  כאשר יציאה הוא מספר היציאה של webהאתר שבו התקנת את ה-CPWebספרייה וירטואלית של שירות.
  2. בדף WSLlogin לחץ על הקישור TestConnection.
  3. לחץ על הפעל. 4. בתוצאות הבדיקה:
  • אם הרכיב הוא שקר, חיבור הבדיקה הצליח.
  • אם הרכיב נכון, חיבור הבדיקה נכשל. לעוד
    מידע על הסיבות לכשל, ראה את ו רכיבים בתוצאות הבדיקה, ובדוק את יומני ה-API. נתיב ברירת המחדל ליומני ה-API הוא: APIAPILlogs

הגדרת ה Web שירות API בשרת שפה

  1. כדי לפרוס את ה-Changepoint Web Services API בשרת שפה, עליך להוסיף או לעדכן את tag ב- Web שירות API web.config. מיקום ברירת המחדל של Web.config file הוא: APICP Web שירותיםWeb.config
  2. אם ה tag כבר קיים, ודא שגם תכונות התרבות וגם uiCulture הן "en-US".
  3. אם ה tag לא קיים כבר, הוסף את הדברים הבאים , הערה ו אלמנטים לweb> צומת:web>
    אפשרויות Visual Basic: הגדר strict=" true" כדי לא לאפשר את כל המרות סוגי הנתונים שבהם עלול להתרחש אובדן נתונים. הגדר explicit="true" כדי לכפות הכרזה על כל המשתנים. –>
  4. הפעל מחדש את IIS.

מסמכים / משאבים

תוכנת Changepoint API [pdfמדריך התקנה
API, תוכנה, תוכנת API

הפניות

פוסטים קשורים

השאר תגובה

כתובת האימייל שלך לא תפורסם. שדות חובה מסומנים *