התאמה אישית של הדומיין

אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X. מידע

כשיוצרים פורטל למפתחים, מקבלים כברירת מחדל שם דומיין לדוגמה של Apigee כדי לגשת לפורטל הפעיל בפורמט הבא:

https://orgname-portalname.apigee.io

כאשר orgname הוא שם הארגון ו-portalname מוגדר באמצעות שם הפורטל שהומר לאותיות קטנות, והוסרו ממנו רווחים ומקפים.

לפני שמשיקים פורטל למפתחים, מומלץ לספק שם דומיין מותאם אישית משלכם. לדוגמה, חלופה פופולרית היא:

https://developers.example.com

במאמר שימוש בדומיין מותאם אישית עם ספק SAML מוסבר על שיקולים לשימוש בדומיין מותאם אישית עם ספק זהויות ב-SAML.

בקטעים הבאים מוסבר איך להתאים אישית את הדומיין.

התאמה אישית של שם הדומיין (Apigee Edge)

כדי להתאים אישית את שם הדומיין בפורטלים משולבים של Apigee Edge, צריך לבצע את השלבים הבאים:

1. רישום שם הדומיין.
2. הגדרת TLS
3. הוספת שם דומיין מותאם אישית לפורטל.
4. מגדירים את ה-DNS.

אחרי שמוסיפים דומיין מותאם אישית, אפשר לערוך או להשבית אותו. לקבלת עזרה בפתרון בעיות, אפשר לעיין במאמר בנושא פתרון בעיות בדומיין מותאם אישית.

שלב 1: רושמים את שם הדומיין

אם אתם צריכים לרשום דומיין חדש, יש הרבה אתרים פופולריים לרישום דומיינים, כמו Google Domains. אתם בוחרים את האתר שבו תרשמו את הדומיין.

כשבוחרים שם דומיין, חשוב לזכור שכתובות URL ידידותיות למשתמש וקריאות הן רכיב מרכזי בשיפור האופטימיזציה למנועי חיפוש, כפי שמתואר במאמר הטמעה של אופטימיזציה למנועי חיפוש (SEO).

שלב 2: הגדרת TLS

כדי לתמוך ב-HTTPS, צריך להגדיר TLS על ידי יצירת מאגרי מפתחות וכינויים שמכילים את האישורים הדיגיטליים הנדרשים בסביבת הפורטל, כפי שמתואר בהליך הבא.

כדי להגדיר TLS:

1. רוכשים אישור TLS מרשות אישורים מוכרת, כמו Google Trust Services. אתם בוחרים את רשות האישורים.
2. נכנסים לכתובת https://apigee.com/edge.
3. בוחרים את הארגון בתפריט פרופיל המשתמש.
4. בוחרים באפשרות ניהול > סביבה > מאגרי מפתחות TLS כדי להציג את הדף 'מאגרי מפתחות TLS'.

5. בתפריט הנפתח של הסביבה, בוחרים באפשרות portal (פורטל).

   

6. יוצרים מאגר מפתחות וכינוי, כמו שמתואר במאמר יצירת מאגרי מפתחות ומאגרי אישורים באמצעות ממשק המשתמש של Edge.

שלב 3: הוספה של שם דומיין מותאם אישית לפורטל

כשמוסיפים שם דומיין בהתאמה אישית לפורטל, המערכת יוצרת בשבילכם את המשאבים הבאים (באמצעות אותה פונקציונליות שמשמשת להחלת שם דומיין בהתאמה אישית על נקודת קצה כמו api.example.com):

• מארח וירטואלי, שמקשיב ביציאה 443, באמצעות שם הדומיין המותאם אישית שאתם מציינים.

• שרת proxy של API שמשתמש בכתובת ה-URL של הדומיין המותאם אישית, כשהנקודה הסופית של היעד מוגדרת לדומיין ברירת המחדל של הפורטל. השם של proxy ל-API תואם לשם הדומיין המותאם אישית, והנקודות מוחלפות בקווים תחתונים. proxy ל-API נפרס בסביבת הפורטל.

כדי להוסיף שם דומיין מותאם אישית לפורטל:

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

   שדה	תיאור
   מאגר מפתחות	בוחרים מאגר מפתחות מהרשימה הנפתחת. הערה: הרשימה מתמלאת באמצעות מאגרי המפתחות שיצרתם בסביבת הפורטל בשלב 2. אחרי שבוחרים מאגר מפתחות, מופיע השדה כינוי.
   כינוי	בוחרים כינוי תקין מהרשימה הנפתחת. הערה: הרשימה מאוכלסת באמצעות הכינויים שיצרתם עבור מאגר המפתחות שנבחר. הרשימה לא כוללת מאגרי מפתחות עם שרשראות אישורים לא תקינות, דומיינים של Apigee או מאגרי אישורים מהימנים. כדי לדעת מתי יפוג התוקף של אישור ברשימה: כדי לראות את הסמלים: תוקף האישור יפוג בעוד יותר מ-30 יום, או שהדומיין המותאם אישית שנבחר כבר נמצא בשימוש. תוקף האישור יפוג בעוד 30 יום. פג התוקף של האישור. מציבים את הסמן מעל כינוי כדי להציג את מספר הימים שנותרו לתוקף של האישור. אחרי שבוחרים כינוי, מופיע השדה דומיין.
   דומיין	בוחרים דומיין מהרשימה הנפתחת. אם בחרתם כינוי עם תו כללי, צריך להזין את תת-הדומיין. הערה: הרשימה של הדומיינים מאוכלסת באמצעות השמות הנפוצים והחלופיים של האישור ברמה העליונה בשרשרת שהוגדרה על ידי הכינוי שנבחר.

   אחרי שממלאים את כל השדות, סמל הסטטוס של דומיין מותאם אישית מתעדכן באופן הבא:

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

   בנוסף, תצורת ה-DNS תאומת וסמל הסטטוס של הגדרת ה-DNS יעודכן באופן הבא:

   סטטוס	תיאור
   	הגדרת ה-DNS תקינה.
   	הגדרת ה-DNS לא תקינה. צריך להגדיר את ה-DNS, כמו שמתואר במאמר בנושא הגדרת ה-DNS.

5. לוחצים על הפעלה (או על שמירה אם עורכים הגדרה קיימת).
   אפשר להפעיל את הדומיין המותאם אישית גם אם הדומיין המותאם אישית או הגדרת ה-DNS לא תקינים.

שלב 4: הגדרת ה-DNS

לאחר מכן, צריך להוסיף רשומת שם קנוני (CNAME) ל-DNS של הדומיין כדי להפנות אל {org_name}-portal.apigee.net.

כדי לאשר את ערך ה-CNAME:

1. בוחרים באפשרות פרסום > פורטלים ובוחרים את הפורטל הרצוי.
2. בתפריט הנפתח בסרגל הניווט העליון או בדף הנחיתה, בוחרים באפשרות הגדרות.
3. לוחצים על הכרטיסייה דומיינים.
4. בקטע Configure DNS (הגדרת DNS), רואים את ערך CNAME של הארגון, כמו שמוצג באיור הבא:

בדוגמה הבאה מוצגת רשומת ה-CNAME שתגדירו עבור הדומיין המותאם אישית שמוצג למעלה (כלומר, עבור הדומיין המותאם אישית developers.example.com בארגון myorg):

developers.example.com. CNAME myorg-portal.apigee.net.

פתרון בעיות בדומיין מותאם אישית

בקטעים הבאים מפורטות הצעות לפתרון בעיות בדומיין המותאם אישית.

פתרון בעיות: אימות הגדרת ה-DNS של הדומיין באמצעות dig

אחרי שמעדכנים את ה-DNS של הדומיין כך שיכלול את רשומת ה-CNAME, עובר זמן עד שהשינויים מועברים לשרתי DNS אחרים ברחבי העולם. אפשר לשלוח שאילתה לשרת ה-DNS של הדומיין כדי לוודא שרשומת ה-CNAME הוגדרה בצורה נכונה, גם לפני שהיא מועברת באופן מלא לשרתי DNS אחרים, באמצעות dig.

לדוגמה, הפקודה dig הבאה שולחת שאילתה לשרת ה-DNS של הדומיין. בפלט פקודה, ANSWER SECTION מכיל את רשומת CNAME.

$ dig @your.domain.dns developer.mycompany.com
; <<>> DiG 9.8.3-P1 <<>> @your.domain.dns developer.mycompany.com
; (1 server found)
;; global options:  cmd
;; Got answer:
;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 41356
;; flags: qr rd ra; QUERY: 1, ANSWER: 3, AUTHORITY: 0, ADDITIONAL: 0
;; WARNING: recursion requested but not available

;; QUESTION SECTION:
;developer.mycompany.com.       IN  A

;; ANSWER SECTION:
developer.mycompany.com.    29  IN  CNAME   myorg-portal.apigee.net.

;; Query time: 141 msec
;; SERVER: 192.168.1.254#53(192.168.1.254)
;; WHEN: Mon Mar 20 16:41:59 2017
;; MSG SIZE  rcvd: 136

פתרון בעיות: לא ניתן לזהות את ה-proxy של המארח

כשמוסיפים שם דומיין בהתאמה אישית לפורטל, נוצר שרת proxy של API כברירת מחדל שמשתמש בכתובת ה-URL של הדומיין בהתאמה אישית, עם נקודת הקצה של היעד שמוגדרת לדומיין ברירת המחדל של הפורטל. אם תשנו או תמחקו את proxy ל-API שמשויך לדומיין מותאם אישית, תבטלו את ההגדרה של הדומיין המותאם אישית ותקבלו את הודעת השגיאה Unable to identify proxy for host כשניסיתם לגשת לכתובת ה-URL של הדומיין המותאם אישית. לדוגמה:

{"fault":{"faultstring":"Unable to identify proxy for host: developers.mycompany.com:443 and url: \/","detail":{"errorcode":"messaging.adaptors.http.flow.ApplicationNotFound"}}}

כדי לשחזר את ההגדרה של הדומיין המותאם אישית במקרה ששרת ה-proxy ל-API שונה או נמחק:

1. בוחרים באפשרות פרסום > פורטלים ובוחרים את הפורטל הרצוי.
2. בתפריט הנפתח בסרגל הניווט העליון או בדף הנחיתה, בוחרים באפשרות הגדרות.
3. לוחצים על הכרטיסייה דומיינים.
4. לוחצים על שמירה כדי לשחזר את proxy ל-API.

עדכון האישור

מידע כללי על עדכון אישורי TLS זמין במאמר בנושא עדכון אישור TLS.

1. פועלים לפי השלבים במאמר שלב 2: הגדרת TLS.
2. פועלים לפי השלבים שמפורטים במאמר שלב 3: הוספת שם דומיין מותאם אישית לפורטל