Sesuaikan domain Anda

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X. info

Saat membuat portal developer, Anda akan diberi nama domain contoh Apigee secara default untuk mengakses portal aktif dalam format berikut:

https://orgname-portalname.apigee.io

Dengan orgname adalah nama organisasi dan portalname ditentukan menggunakan nama portal yang dikonversi menjadi huruf kecil semua dan dengan spasi dan tanda hubung dihapus.

Sebelum meluncurkan developer portal, sebaiknya Anda memberikan nama domain kustom Anda sendiri. Misalnya, alternatif yang populer adalah:

https://developers.example.com

Untuk pertimbangan penggunaan domain kustom dengan penyedia identitas SAML, lihat Menggunakan domain kustom dengan penyedia SAML.

Bagian berikut menjelaskan cara menyesuaikan domain Anda.

Menyesuaikan nama domain (Apigee Edge)

Dengan portal terintegrasi Apigee Edge, untuk menyesuaikan nama domain, lakukan langkah-langkah berikut:

1. Daftarkan nama domain Anda.
2. Konfigurasi TLS.
3. Menambahkan nama domain kustom ke portal.
4. Konfigurasikan DNS Anda.

Setelah menambahkan domain kustom, Anda dapat mengedit atau menonaktifkannya. Untuk mendapatkan bantuan terkait pemecahan masalah, lihat Memecahkan masalah domain kustom.

Langkah 1: Daftarkan nama domain Anda

Jika Anda perlu mendaftarkan domain baru, ada banyak situs pendaftaran domain populer yang tersedia, seperti Google Domains. Anda dapat memilih situs pendaftaran domain mana pun.

Saat menentukan nama domain, pertimbangkan bahwa URL yang mudah digunakan dan dapat dibaca manusia adalah komponen utama dalam meningkatkan pengoptimalan mesin telusur, seperti yang dijelaskan dalam Menerapkan pengoptimalan mesin telusur (SEO).

Langkah 2: Konfigurasikan TLS

Untuk mendukung HTTPS, Anda perlu mengonfigurasi TLS dengan membuat keystore dan alias yang berisi sertifikat digital yang diperlukan di lingkungan portal, seperti yang dijelaskan dalam prosedur berikut.

Untuk mengonfigurasi TLS:

1. Beli sertifikat TLS dari certificate authority yang memiliki reputasi baik, seperti Layanan Kepercayaan Google. Anda dapat memilih certificate authority mana pun.
2. Login ke https://apigee.com/edge.
3. Pilih organisasi Anda dari menu profil pengguna.
4. Pilih Admin > Environment > TLS Keystores untuk menampilkan halaman TLS keystore.

5. Pilih portal dari drop-down lingkungan.

   

6. Buat keystore dan alias, seperti yang dijelaskan dalam Membuat keystore dan truststore menggunakan UI Edge.

Langkah 3: Tambahkan nama domain kustom ke portal Anda

Saat Anda menambahkan nama domain kustom ke portal, sistem akan membuat resource berikut (menggunakan fungsi yang sama yang digunakan untuk menerapkan nama domain kustom ke endpoint seperti api.example.com):

• Virtual host, yang memproses permintaan di port 443, menggunakan nama domain kustom yang Anda tentukan.

• Proxy API yang menggunakan URL domain kustom dengan endpoint targetnya ditetapkan ke domain portal default. Nama proxy API cocok dengan nama domain kustom dengan titik yang diganti dengan garis bawah. Proxy API di-deploy ke lingkungan portal.

Untuk menambahkan nama domain kustom ke portal Anda:

1. Pilih Publish > Portals, lalu pilih portal Anda.
2. Pilih Setelan di menu drop-down di menu navigasi atas atau di halaman landing.
3. Klik tab Domains.
4. Di bagian Custom Domain, lengkapi kolom berikut.
   

   Kolom	Deskripsi
   Keystore	Pilih keystore dari menu drop-down. Catatan: Daftar diisi menggunakan keystore yang telah Anda buat di lingkungan portal pada langkah 2. Setelah Anda memilih keystore, kolom Alias akan ditampilkan.
   Alias	Pilih alias yang valid dari menu drop-down. Catatan: Daftar diisi menggunakan alias yang telah Anda buat untuk keystore yang dipilih. Daftar ini tidak menyertakan keystore dengan rantai sertifikat, domain Apigee, atau truststore yang tidak valid. Untuk menentukan kapan masa berlaku sertifikat dalam daftar akan berakhir: Lihat ikon: Sertifikat akan berakhir masa berlakunya dalam lebih dari 30 hari atau domain kustom yang dipilih mungkin sudah digunakan. Sertifikat akan berakhir dalam waktu 30 hari. Sertifikat sudah tidak berlaku. Posisikan kursor di atas alias untuk menampilkan jumlah hari yang tersisa di mana sertifikat akan valid. Setelah Anda memilih alias, kolom Domain akan ditampilkan.
   Domain	Pilih domain dari menu drop-down. Jika Anda telah memilih alias karakter pengganti, masukkan subdomain. Catatan: Daftar domain diisi menggunakan nama umum dan alternatif untuk sertifikat level teratas dalam rantai yang ditentukan oleh alias yang dipilih.

   Setelah Anda mengisi semua kolom, ikon status Domain Kustom akan diperbarui, seperti berikut:

   Status	Deskripsi
   	Keystore, alias, dan domain kustom valid.
   	Masa berlaku sertifikat akan berakhir dalam 30 hari.
   	Keystore, alias, dan domain kustom tidak valid.

   Selain itu, konfigurasi DNS akan divalidasi dan ikon status Konfigurasi DNS akan diperbarui, sebagai berikut:

   Status	Deskripsi
   	Konfigurasi DNS valid.
   	Konfigurasi DNS tidak valid. Anda harus mengonfigurasi DNS, seperti yang dijelaskan dalam Mengonfigurasi DNS.

5. Klik Aktifkan (atau Simpan jika Anda sedang mengedit).
   Anda dapat mengaktifkan domain kustom meskipun konfigurasi DNS atau domain kustom tidak valid.

Langkah 4: Konfigurasikan DNS Anda

Selanjutnya, Anda perlu menambahkan data nama kanonis (CNAME) ke DNS domain untuk mengarah ke {org_name}-portal.apigee.net.

Untuk mengonfirmasi nilai CNAME:

1. Pilih Publikasi > Portal, lalu pilih portal Anda.
2. Pilih Setelan di menu drop-down di menu navigasi atas atau di halaman landing.
3. Klik tab Domains.
4. Lihat nilai CNAME untuk organisasi Anda di bagian Configure DNS, seperti yang ditunjukkan pada gambar berikut:

Berikut adalah contoh data CNAME yang akan Anda konfigurasi untuk domain kustom yang ditampilkan di atas (yaitu, untuk domain kustom developers.example.com di organisasi myorg):

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

Memecahkan masalah domain kustom

Bagian berikut memberikan saran untuk memecahkan masalah domain kustom.

Memecahkan masalah: Memverifikasi penyiapan DNS domain menggunakan dig

Setelah DNS domain Anda diperbarui untuk menyertakan data CNAME, perlu waktu agar perubahan tersebut diterapkan ke server DNS lain di seluruh dunia. Anda dapat membuat kueri server DNS domain untuk memverifikasi bahwa data CNAME disiapkan dengan benar, bahkan sebelum data tersebut disebarkan sepenuhnya ke server DNS lainnya, menggunakan dig.

Misalnya, perintah dig berikut membuat kueri server DNS domain Anda. Dalam output perintah, ANSWER SECTION berisi entri data 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

Memecahkan masalah: Tidak dapat mengidentifikasi proxy untuk host

Saat Anda menambahkan nama domain kustom ke portal, proxy API akan dibuat secara default yang menggunakan URL domain kustom dengan endpoint targetnya ditetapkan ke domain portal default. Jika Anda mengubah atau menghapus proxy API yang terkait dengan domain kustom, Anda akan membatalkan validasi konfigurasi domain kustom dan menerima pesan error Unable to identify proxy for host saat mencoba mengakses URL domain kustom. Contoh:

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

Untuk memulihkan konfigurasi domain kustom jika proxy API telah diubah atau dihapus:

1. Pilih Publikasi > Portal, lalu pilih portal Anda.
2. Pilih Setelan di menu drop-down di menu navigasi atas atau di halaman landing.
3. Klik tab Domains.
4. Klik Simpan untuk memulihkan proxy API.

Memperbarui sertifikat

Untuk informasi umum tentang cara memperbarui sertifikat TLS, lihat Memperbarui sertifikat TLS.

1. Ikuti langkah-langkah di Langkah 2: Konfigurasikan TLS.
2. Ikuti langkah-langkah di Langkah 3: Tambahkan nama domain kustom ke portal Anda