אתם צופים במסמכי העזרה של Apigee Edge.
לעיון במאמרי העזרה של Apigee X. מידע
כשיוצרים פורטל למפתחים, כברירת מחדל מקבלים שם דומיין לדוגמה של Apigee כדי לגשת לפורטל הפעיל בפורמט הבא:
https://orgname-portalname.apigee.io
כאשר orgname
הוא שם הארגון ו-portalname
מוגדר באמצעות שם הפורטל שהומר לכל אותיות קטנות והרווחים והמקפים הוסרו ממנו.
לפני ההשקה של פורטל מפתחים, מומלץ לספק שם של דומיין מותאם אישית משלך. לדוגמה, אפשרות פופולרית היא:
https://developers.example.com
למידע נוסף על שימוש בדומיין מותאם אישית עם ספק זהויות של SAML, ראו שימוש בדומיין מותאם אישית עם ספק SAML.
בקטעים הבאים מוסבר איך להתאים אישית את הדומיין.
התאמה אישית של שם הדומיין (Apigee Edge)
כדי להתאים אישית את שם הדומיין בפורטלים המשולבים של Apigee Edge, מבצעים את הפעולות הבאות:
אחרי שמוסיפים דומיין מותאם אישית, אפשר לערוך אותו או להשבית אותו. לקבלת עזרה בפתרון בעיות, אפשר לעיין במאמר פתרון בעיות בדומיין מותאם אישית.
שלב 1: רושמים את שם הדומיין
אם אתם צריכים לרשום דומיין חדש, יש הרבה אתרים פופולריים לרישום דומיינים, כמו Google Domains. אתם יכולים לבחור את אתר הרישום של הדומיין שתרצו.
כשאתם מחליטים על שם הדומיין, חשוב לזכור שכתובות URL ידידותיות למשתמש שאפשר לקרוא אותן הן רכיב מפתח בשיפור האופטימיזציה למנועי חיפוש, כפי שמתואר בקטע הטמעת אופטימיזציה למנועי חיפוש (SEO).
שלב 2: מגדירים TLS
כדי לתמוך ב-HTTPS, צריך להגדיר TLS על ידי יצירת מאגרי מפתחות וכינויים שמכילים את האישורים הדיגיטליים הנדרשים בסביבת הפורטל, כפי שמתואר בתהליך הבא.
כדי להגדיר TLS:
- רוכשים אישור TLS מרשות אישורים מהימנה, כמו Google Trust Services. אתם יכולים לבחור את רשות האישורים שתרצו.
- נכנסים לכתובת https://apigee.com/edge.
- בוחרים את הארגון שלכם מתפריט פרופיל המשתמש.
- בוחרים באפשרות אדמין > סביבה > מאגרי מפתחות TLS כדי להציג את הדף 'מאגרי מפתחות TLS'.
בתפריט הנפתח של הסביבה, בוחרים באפשרות portal.
יוצרים מאגר מפתחות וכתובת חלופית, כפי שמתואר במאמר יצירת מאגרי מפתחות ומאגרי אמון באמצעות ממשק המשתמש של Edge.
שלב 3: מוסיפים שם דומיין מותאם אישית לפורטל
כשמוסיפים לפורטל שם של דומיין מותאם אישית, המערכת יוצרת עבורכם את המשאבים הבאים (באמצעות אותה הפונקציונליות שמשמשת להחלת שם דומיין מותאם אישית על נקודת קצה, כמו api.example.com
):
מארח וירטואלי, שמקשיב ביציאה 443 באמצעות שם הדומיין המותאם אישית שציינתם.
שרת proxy של API שמשתמש בכתובת ה-URL של הדומיין המותאם אישית, כאשר נקודת הקצה (endpoint) של היעד מוגדרת לדומיין ברירת המחדל של הפורטל. השם של שרת ה-proxy ל-API תואם לשם הדומיין המותאם אישית, כאשר הנקודות מוחלפות בקו תחתון. שרת ה-proxy של ה-API נפרס בסביבת הפורטל.
כדי להוסיף שם דומיין מותאם אישית לפורטל:
- בוחרים באפשרות פרסום > פורטלים ובוחרים את הפורטל הרצוי.
- בוחרים באפשרות הגדרות בתפריט הנפתח שבסרגל הניווט העליון או בדף הנחיתה.
- לוחצים על הכרטיסייה דומיינים.
- בקטע Custom Domain (דומיין מותאם אישית), ממלאים את השדות הבאים.
שדה תיאור מאגר מפתחות בוחרים מאגר מפתחות מהרשימה הנפתחת. הערה: הרשימה מאוכלסת באמצעות מאגרי המפתחות שיצרתם בסביבת הפורטל בשלב 2.
אחרי שבוחרים מאגר מפתחות, מוצג השדה Alias.
כינוי בוחרים כינוי חוקי מהרשימה הנפתחת. הערה: הרשימה מאוכלסת באמצעות כינויים שיצרתם למאגר המפתחות שנבחר. הרשימה לא כוללת מאגרי מפתחות עם רשתות אישורים לא תקינות, דומיינים של Apigee או מאגרי אמון.
כדי לבדוק מתי יפוג התוקף של אישור ברשימה:
- הצגת הסמלים:
- תוקף האישור יפוג בעוד יותר מ-30 יום, או שהדומיין המותאם אישית שנבחר כבר נמצא בשימוש.
- תוקף האישור יפוג בעוד 30 יום.
- תוקף האישור פג.
- מציבים את הסמן מעל כינוי כדי להציג את מספר הימים שנותרו לתוקף האישור.
אחרי שבוחרים כתובת אימייל חלופית, מוצג השדה Domain (דומיין).
דומיין בוחרים דומיין מהרשימה הנפתחת. אם בחרתם כינוי של תו כללי, מזינים את תת-הדומיין. הערה: רשימת הדומיינים מאוכלסת באמצעות השמות הנפוצים והאלטרנטיביים של האישור ברמה העליונה בשרשרת שהוגדרה על ידי הכינוי שנבחר.
סטטוס תיאור מאגר המפתחות, הכינוי והדומיין המותאם אישית תקינים. תוקף האישור יפוג בעוד 30 יום. מאגר המפתחות, הכינוי והדומיין המותאם אישית לא תקינים. סטטוס תיאור הגדרת ה-DNS תקינה. הגדרת ה-DNS לא חוקית. צריך להגדיר את ה-DNS, כפי שמתואר בקטע הגדרת ה-DNS. - הצגת הסמלים:
-
לוחצים על הפעלה (או על שמירה אם מבצעים עריכה).
אפשר להפעיל את הדומיין בהתאמה אישית גם אם הדומיין בהתאמה אישית או הגדרת ה-DNS לא תקינים.
שלב 4: מגדירים את ה-DNS
בשלב הבא, צריך להוסיף רשומת שם קנוני (CNAME) ל-DNS של הדומיין כדי להפנות אל {org_name}-portal.apigee.net
.
כדי לאשר את ערך ה-CNAME:
- בוחרים באפשרות פרסום > פורטלים ובוחרים את הפורטל.
- בוחרים באפשרות הגדרות בתפריט הנפתח שבסרגל הניווט העליון או בדף הנחיתה.
- לוחצים על הכרטיסייה דומיינים.
- בודקים את ערך ה-CNAME של הארגון בקטע Configure DNS (הגדרת DNS), כפי שמוצג באיור הבא:
הדוגמה הבאה היא דוגמה לרשומת ה-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 השתנה או נמחק:
- בוחרים באפשרות פרסום > פורטלים ובוחרים את הפורטל.
- בוחרים באפשרות הגדרות בתפריט הנפתח שבסרגל הניווט העליון או בדף הנחיתה.
- לוחצים על הכרטיסייה דומיינים.
- לוחצים על Save כדי לשחזר את ה-Proxy של ה-API.
עדכון האישור
למידע כללי על עדכון אישורי TLS, ראו עדכון אישור TLS.
- פועלים לפי השלבים המפורטים בקטע שלב 2: הגדרת TLS.
- פועלים לפי השלבים שמפורטים בקטע שלב 3: הוספת שם דומיין מותאם אישית לפורטל