Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
# Portal API Gateway
Anda dapat menggunakan portal API Gateway untuk membagikan dokumentasi Anda APIs dan API dengan konsumen API di halaman web. Sebuah portal berisi satu set *produk portal*. Setiap produk portal adalah pengelompokan logis REST APIs dan berisi dokumentasi yang Anda buat dan publikasikan untuk konsumen API Anda. Halaman produk dalam portal berisi dokumentasi khusus di tingkat produk portal. *Halaman endpoint REST produk* berisi dokumentasi untuk masing-masing REST APIs dan jalur, metode, dan tahap REST API. Kombinasi halaman produk dan halaman akhir REST produk menyediakan dokumentasi lengkap untuk memungkinkan konsumen API mempelajari cara mulai menggunakan REST APIs Anda.
Gunakan portal untuk melakukan hal berikut:
+ Gunakan API Gateway untuk seluruh siklus hidup API Anda, mulai dari membuat hingga mendokumentasikan dan APIs mendistribusikannya.
+ Bagikan produk portal di seluruh AWS akun.
+ Sesuaikan dan bagikan lokasi pusat untuk produk portal Anda dan sediakan halaman produk.
## Pertimbangan-pertimbangan
Pertimbangan berikut dapat memengaruhi penggunaan portal API Gateway Anda:
+ Anda hanya dapat membuat portal untuk berbagi REST APIs.
+ Portal dibuat di tingkat AWS Wilayah. Portal Anda hanya dapat berisi REST APIs yang berada di Wilayah yang sama tempat Anda membuat portal.
+ Anda hanya dapat menggunakan Konsol Manajemen AWS, AWS CLI, atau AWS SDKs untuk membuat dan berbagi portal Anda.
+ Anda hanya dapat mengontrol akses ke portal Anda menggunakan kumpulan pengguna Amazon Cognito. Konsumen portal Anda dapat masuk langsung melalui kumpulan pengguna, atau mereka dapat bergabung melalui penyedia identitas pihak ketiga (iDP). Jika Anda menggunakan kumpulan pengguna Amazon Cognito, Anda tidak dapat menyetel rahasia klien untuk kumpulan pengguna Anda. Untuk informasi selengkapnya, lihat [kumpulan pengguna Amazon Cognito](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools.html).
# Produk portal di API Gateway
*Produk portal* mewakili layanan atau fungsionalitas yang ingin Anda bagikan. Produk portal Anda adalah kumpulan titik akhir REST produk dan halaman produk. *Titik akhir REST produk* adalah titik akses ke produk portal Anda, dan mereka terdiri dari jalur dan metode REST API dan tahap penerapannya. *Halaman produk* adalah dokumentasi yang Anda berikan untuk menjelaskan bagaimana konsumen API dapat menggunakan titik akhir produk Anda. Produk portal dapat berisi seluruh `Prod` tahap sebagai kumpulan titik akhir REST produk atau hanya `GET /pets` sumber daya yang dikerahkan ke `Prod` tahap sebagai titik akhir REST produk tunggal.
Produk portal Anda dapat disesuaikan. Anda dapat menambahkan dokumentasi khusus, mengganti nama titik akhir REST produk, mengatur ulang urutan tampilan, menambahkan bagian baru, dan berbagi produk di seluruh akun. AWS Agar perubahan apa pun yang Anda buat pada produk portal Anda berlaku, Anda harus menerbitkan ulang portal apa pun yang menggunakan produk portal Anda.
## Contoh produk portal adopsi hewan peliharaan
Sebagai contoh, Anda dapat memiliki beberapa REST APIs yang mewakili layanan adopsi hewan peliharaan. Anda dapat menggunakan API Gateway untuk membuat produk `pet adoption` portal. Produk portal ini akan membantu pelanggan menemukan mana yang harus APIs mereka gunakan untuk bertemu dan mengadopsi hewan peliharaan. Produk portal ini menggunakan REST APIs yang sudah Anda buat, tetapi memungkinkan Anda untuk berkumpul kembali dan mengaturnya. Anda juga dapat memberikan dokumentasi tentang syarat dan ketentuan penggunaan produk portal adopsi hewan peliharaan Anda dan membiarkan pelanggan mencobanya APIs. Informasi ini semua disimpan dalam produk portal Anda.
Tabel berikut menunjukkan tiga APIs yang mewakili produk portal adopsi hewan peliharaan, dan nama operasi titik akhir REST produk terkait dan nama bagian halaman.
| SISA API ID | Jalur dan metode REST API | Tahap REST API | Nama operasi | Bagian halaman |
| --- | --- | --- | --- | --- |
| kf5387miad | GET /dogs | Prod | View dogs | AdoptAnimals |
| kf5387miad | GET /dogs/\$1dogId\$1 | Prod | View dog | AdoptAnimals |
| ra8obxcevg | GET /cats | Prod | View cats | AdoptAnimals |
| ra8obxcevg | GET /cats/\$1catId\$1 | Prod | View cat | AdoptAnimals |
| h0rpx9cm62 | ANY /user/\$1userId\$1/\$1petId\$1\$1 | Beta | Request visit | AdoptProcess |
Dalam contoh ini, dua REST APIs, `ra8obxcevg` dan`kf5387miad`, dikelompokkan bersama di `AdoptAnimals` bagian. Hasil navigasi pemesanan ini akan terlihat seperti berikut di portal:
![\[Portal adopsi hewan peliharaan\]](http://docs.aws.amazon.com/id_id/apigateway/latest/developerguide/images/apigateway-portal.png)
Karena `ANY` metode ini adalah metode catch-all, portal menampilkan semua metode HTTP yang didukung. Portal ini juga berisi dokumentasi yang dibuat oleh pemilik produk portal.
## Langkah selanjutnya
Untuk memulai dengan produk portal, Anda dapat melakukan hal berikut:
+ Untuk membuat produk portal, lihat[Membuat produk portal di API Gateway](apigateway-portals-create-portal-product.md).
+ Untuk mempelajari tentang fungsi try it, lihat[Aktifkan coba untuk titik akhir REST produk API Gateway di portal Anda](apigateway-portals-try-it.md).
+ Untuk mempelajari tentang halaman produk, lihat[Membuat halaman produk di API Gateway](apigateway-portals-create-product-page.md).
+ Untuk mempelajari tentang berbagi produk portal Anda, lihat[Bagikan produk portal di API Gateway](apigateway-portals-share-resources.md).
Setelah Anda membuat produk portal, Anda dapat mempublikasikannya ke portal. Lihat informasi yang lebih lengkap di [Buat portal di API Gateway](apigateway-portals-create-portal.md).
# Membuat produk portal di API Gateway
Prosedur berikut menunjukkan cara membuat produk portal. Portal adalah kumpulan *produk portal*. Setelah Anda membuat produk portal Anda, Anda membuat titik akhir REST produk dan halaman produk. Untuk mempelajari tentang produk portal, lihat[Produk portal di API Gateway](apigateway-portals-portal-product.md).
## Pertimbangan-pertimbangan
Pertimbangan berikut dapat memengaruhi cara Anda membuat produk portal:
+ Produk portal Anda dapat berisi REST pribadi dan publik APIs. Private APIs tidak didukung untuk fungsi try it dan, sebagai hasilnya, memiliki perbedaan visual di portal Anda. Sebagai pemilik portal, Anda mungkin perlu memberikan dokumentasi untuk menjelaskan hal ini.
+ Jika Anda membuat produk portal menggunakan AWS CLI atau AWS SDKs, portal Anda tidak akan memiliki titik akhir produk atau halaman produk. Anda perlu menambahkan sumber daya ini menggunakan konsol AWS CLI atau. Untuk mempelajari cara membuat endpoint REST produk, lihat[Membuat titik akhir REST produk di API Gateway](apigateway-portals-create-product-rest-endpoint.md). Untuk mempelajari cara membuat halaman produk, lihat[Membuat halaman produk di API Gateway](apigateway-portals-create-product-page.md).
## Buat produk portal
Prosedur berikut menunjukkan cara membuat produk portal.
**Untuk membuat produk portal**
1. Masuk ke konsol API Gateway di [https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway).
1. Di panel navigasi utama, pilih **produk Portal**.
1. Pilih **Buat produk**.
1. Untuk **nama Produk**, masukkan nama produk portal Anda.
1. Untuk **deskripsi Produk**, masukkan deskripsi.
1. Pilih **Berikutnya**.
1. Untuk memilih titik akhir REST produk Anda, di bawah **titik akhir API** pilih API, lalu pilih tahapan.
1. Untuk menambahkan titik akhir ke titik akhir REST produk Anda, pilih titik akhir API, lalu pilih **Tambahkan** ke produk.
**catatan**
Jangan memilih **Berikutnya** tanpa terlebih dahulu memilih **Tambahkan ke produk**.
![\[Produk portal\]](http://docs.aws.amazon.com/id_id/apigateway/latest/developerguide/images/apigateway-portal-product.png)
Titik akhir API akan muncul di daftar **titik akhir API Terpilih**.
1. Pilih **Berikutnya**.
1. Tinjau pilihan Anda dan pilih **Buat produk**.
Setelah Anda membuat produk portal menggunakan konsol, semua halaman produk dan halaman titik akhir REST produk Anda adalah draf dan tidak akan muncul di portal. Agar halaman produk dan halaman akhir REST produk Anda terlihat oleh konsumen, Anda perlu menambahkan draf Anda ke bagian. Jika Anda membuat produk portal Anda menggunakan AWS CLI atau AWS SDKs, Anda menambahkan draf ke bagian dalam AWS CLI perintah. Terlepas dari bagaimana Anda menambahkan draf Anda ke bagian, Anda harus mempublikasikan portal yang menggunakan produk portal Anda agar dapat dilihat oleh konsumen.
**Untuk menambahkan draf Anda ke bagian halaman**
1. Draf Anda tercantum di tab **Dokumentasi**. Ada **halaman dokumentasi Draf untuk halaman** produk Anda dan halaman **referensi Draft API untuk halaman** titik akhir REST produk Anda. Pilih **halaman referensi Draft API**.
1. Pilih halaman referensi API draf.
Jika Anda tidak memiliki titik akhir REST produk, Anda tidak akan memiliki halaman referensi API draf apa pun. Untuk mempelajari cara membuat endpoint REST produk, lihat[Membuat titik akhir REST produk di API Gateway](apigateway-portals-create-product-rest-endpoint.md).
1. Pilih **Edit halaman**.
1. Di halaman ini, Anda dapat menimpa bagian dokumentasi API yang ada atau menggunakan dokumentasi API Gateway. Agar konten halaman akhir REST produk Anda dapat dilihat oleh konsumen, di bawah **nama Bagian**, masukkan nama. Jika ini adalah `/pets-GET` titik akhir, nama halaman bisa `Pets` jadi.
1. Pilih **Simpan perubahan**.
1. Nama halaman baru yang Anda buat muncul di bagian **halaman referensi API**.
Agar halaman baru dapat dilihat oleh konsumen, Anda masih perlu mempublikasikan ulang portal Anda. Lihat informasi yang lebih lengkap di [Publikasikan portal di API Gateway](apigateway-portals-publish-portal.md).
# Membuat titik akhir REST produk di API Gateway
Titik akhir REST produk adalah titik akses ke produk portal Anda. Setiap titik akhir terdiri dari jalur dan metode REST API dan tahap penerapannya. Titik akhir mencakup dokumentasi apa pun yang telah Anda tetapkan untuk REST API Anda, atau dapat diperbarui dengan dokumentasi khusus. Saat membuat endpoint REST produk, Anda mengonfigurasi pengaturan berikut:
+ Nama operasi titik akhir REST produk. Jika REST API Anda memiliki jalur dan metode`GET /pets`, di portal, namanya adalah`/pets`. Dengan menggunakan nama operasi, Anda dapat mengubah nama titik akhir REST produk menjadi`Pet summaries`. Ini tidak memengaruhi API Anda yang ada.
+ Fungsi try it untuk titik akhir produk Anda. Ini memungkinkan konsumen API mencoba Anda APIs di portal Anda. Jika Anda membuat titik akhir produk untuk API pribadi, fungsi try it akan disetel ke`UNAVAILABLE`. Untuk informasi selengkapnya, lihat [Aktifkan coba untuk titik akhir REST produk API Gateway di portal Anda](apigateway-portals-try-it.md).
+ [Jika saat ini Anda memiliki bagian dokumentasi yang ditentukan untuk REST API, Anda dapat mengimpor dokumentasi atau mengganti dokumentasi yang ada dan membuat dokumentasi tingkat produk baru menggunakan GitHub Flavored Markdown.](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) Setiap penggantian dokumentasi tidak disebarkan kembali ke bagian dokumentasi API Gateway API Anda. Jika Anda mengimpor bagian dokumentasi saat ini, API Gateway menyinkronkan perubahan di seluruh API Anda ke titik akhir REST produk Anda.
## Buat titik akhir REST produk
Prosedur berikut menunjukkan cara menambahkan titik akhir REST produk ke produk portal yang ada. Untuk mempelajari cara membuat produk portal dan titik akhir REST produk bersama-sama, lihat[Membuat produk portal di API Gateway](apigateway-portals-create-portal-product.md).
**Untuk membuat endpoint REST produk untuk portal produk**
1. Masuk ke konsol API Gateway di [https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway).
1. Di panel navigasi utama, pilih **produk Portal**.
1. Pilih produk portal.
1. Pilih tab **Titik akhir terkait**, lalu pilih **Tambahkan titik akhir**.
1. Untuk memilih titik akhir REST produk Anda, di bawah **titik akhir API** pilih API, lalu pilih tahapan.
1. Untuk menambahkan titik akhir ke titik akhir REST produk Anda, pilih titik akhir API, lalu pilih **Tambahkan** ke produk.
Titik akhir API akan muncul di daftar **titik akhir API Terpilih**.
1. Pilih **Kirim**.
1. Halaman akhir REST produk Anda sekarang menjadi draf. Pilih **halaman referensi Draft API**, lalu pilih halaman endpoint REST produk Anda untuk menyelesaikan konten halaman.
1. Pilih **Edit halaman**.
1. Untuk mengganti dokumentasi API Gateway yang ada, untuk **sumber Dokumentasi**, aktifkan **Ganti dokumentasi** dan lakukan hal berikut:
1. Untuk **Menampilkan konten**, pilih **Buat penggantian**.
1. Untuk **nama Operasi**, masukkan nama operasi baru.
1. Untuk **badan Halaman**, masukkan dokumentasi kustom Anda.
1. (Opsional) Untuk **Endpoint**, masukkan titik akhir kustom yang muncul di portal Anda.
1. Untuk memungkinkan pelanggan menjalankan API Anda di portal Anda, pilih **fungsi Coba itu**. Untuk informasi selengkapnya, lihat [Aktifkan coba untuk titik akhir REST produk API Gateway di portal Anda](apigateway-portals-try-it.md).
1. Untuk **nama Bagian**, masukkan nama atau pilih bagian yang ada. Saat Anda menambahkan titik akhir REST produk Anda ke bagian, konsumen dapat melihat konten Anda di portal yang dipublikasikan.
1. Pilih **Simpan perubahan**.
Agar halaman baru dapat dilihat oleh konsumen, Anda masih perlu mempublikasikan ulang portal Anda. Lihat informasi yang lebih lengkap di [Publikasikan portal di API Gateway](apigateway-portals-publish-portal.md).
# Membuat halaman produk di API Gateway
Halaman produk membantu konsumen produk Anda memahami dan menggunakan produk Anda. Dokumentasi berada di tingkat produk, jadi portal apa pun yang menyertakan produk Anda memiliki dokumentasi ini. API Gateway mendukung dua jenis halaman produk yang ditulis dalam [GitHub Flavored Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax):
Halaman Ikhtisar
Saat Anda membuat produk, API Gateway secara otomatis membuat halaman **Ikhtisar** untuk produk Anda berdasarkan informasi yang Anda berikan saat membuat produk. Halaman ini memiliki format tambahan yang tidak dapat diubah. Anda dapat memodifikasi teks atau menghapus halaman dari produk portal.
Halaman kustom
Halaman kustom adalah halaman yang ditulis dalam Markdown. Anda dapat menggunakan bagian ini untuk syarat dan ketentuan atau tutorial tentang cara menggunakan produk Anda. Anda dapat mengubah halaman kustom menjadi halaman ikhtisar. Saat Anda mengubah halaman kustom menjadi halaman ikhtisar, konten halaman diformat agar sesuai dengan halaman ikhtisar.
## Pertimbangan-pertimbangan
Pertimbangan berikut dapat memengaruhi penggunaan halaman produk Anda:
+ Dokumentasi ini tidak berada di tingkat API dan tidak menyertakan metode, sumber daya, atau parameter permintaan apa pun. Untuk mempelajari cara memodifikasi dokumentasi di tingkat API untuk suatu produk, lihat. [Memperbarui titik akhir REST produk di API Gateway](apigateway-portals-update-product-endpoint.md)
+ Anda tidak dapat langsung mengunggah `.md` file ke produk Anda.
+ Anda dapat mengubah urutan halaman produk dengan memodifikasi daftar halaman dalam urutan tampilan produk portal Anda. Untuk informasi selengkapnya, lihat [Memperbarui produk portal di API Gateway](apigateway-portals-update-portal-product.md).
+ Anda perlu mempublikasikan ulang portal apa pun yang menyertakan produk Anda agar perubahan dokumentasi diterapkan.
+ Jika Anda memiliki beberapa portal yang menggunakan produk portal yang sama, halaman produk sama di semua portal. Untuk memiliki titik akhir REST produk yang sama tetapi halaman produk yang berbeda, buat beberapa produk.
## Buat halaman produk
Prosedur berikut menunjukkan cara membuat halaman produk.
**Untuk membuat halaman produk**
1. Masuk ke konsol API Gateway di [https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway).
1. Di panel navigasi utama, pilih **produk Portal**.
1. Pilih produk.
1. Di bawah **Dokumentasi**, pilih **Buat halaman kustom**.
1. Untuk **judul Halaman**, masukkan judul halaman.
1. Untuk **Body**, masukkan dokumentasi tambahan Anda menggunakan GitHub Flavored Markdown.
Bagian **Pratinjau** menunjukkan bagaimana konten Anda muncul di portal. Gaya visual akhir mungkin berubah berdasarkan pengaturan portal Anda.
1. Pilih **Buat halaman produk**.
1. Halaman produk Anda sekarang menjadi draf. Pilih **halaman dokumentasi draf**, lalu pilih halaman produk Anda untuk menyelesaikan konten halaman.
1. Pilih **Edit halaman**.
1. Untuk **nama Bagian**, masukkan nama atau pilih bagian yang ada. Ketika Anda menambahkan halaman produk Anda ke bagian, konsumen dapat melihat konten Anda di portal yang dipublikasikan.
1. Pilih **Simpan perubahan**.
Agar halaman baru dapat dilihat oleh konsumen, Anda masih perlu mempublikasikan ulang portal Anda. Lihat informasi yang lebih lengkap di [Publikasikan portal di API Gateway](apigateway-portals-publish-portal.md).
# Memperbarui produk portal di API Gateway
Ketika Anda memperbarui produk portal, Anda dapat mengubah nama, deskripsi, atau urutan tampilan bagaimana titik akhir REST produk dan halaman produk Anda muncul. Untuk mengubah urutan tampilan, Anda mengubah daftar halaman untuk halaman produk dan nama bagian untuk titik akhir produk. Jika Anda melakukan ini menggunakan AWS CLI atau SDKs, Anda menentukan halaman produk ARN atau ARN titik akhir REST produk. Anda perlu mempublikasikan ulang portal apa pun yang menggunakan produk Anda untuk konsumen API Anda untuk melihat perubahan yang tercermin dalam portal.
## Perbarui produk portal
Prosedur berikut menunjukkan cara mengubah daftar bagian untuk menyusun ulang titik akhir REST produk karena akan muncul di portal. Dalam prosedur ini, kami menganggap Anda memiliki setidaknya dua titik akhir REST produk di produk portal Anda.
**Untuk memperbarui produk portal**
1. Masuk ke konsol API Gateway di [https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway).
1. Di panel navigasi utama, pilih **produk Portal**.
1. Pilih produk.
1. Di tab **Dokumentasi**, untuk **halaman Produk**, pilih **Kelola**.
1. Seret dan lepas titik akhir REST produk untuk menyusun ulang mereka. Anda juga dapat memindahkan titik akhir REST produk dan halaman produk ke bagian halaman draf. Halaman di halaman draf tidak akan terlihat di portal Anda.
1. (Opsional) Ganti nama nama titik akhir REST produk atau tambahkan bagian referensi API baru. Perubahan ini tidak akan memengaruhi REST Anda APIs.
1. Pilih **Simpan perubahan**.
# Memperbarui titik akhir REST produk di API Gateway
Saat memperbarui titik akhir REST produk, Anda dapat mengubah semua pengaturan titik akhir produk kecuali jalur dan metode REST API dan tahap penerapannya. Setiap perubahan pada titik akhir produk Anda diperbarui secara otomatis, tetapi Anda perlu mempublikasikan ulang portal apa pun yang menggunakan produk Anda untuk melihat perubahan yang tercermin dalam portal.
## Memperbarui titik akhir REST produk
Prosedur berikut menunjukkan cara memperbarui titik akhir REST produk untuk menimpa dokumentasi API saat ini dengan dokumentasi referensi API kustom.
**Untuk memperbarui titik akhir REST produk**
1. Masuk ke konsol API Gateway di [https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway).
1. Di panel navigasi utama, pilih **produk Portal**.
1. Pilih produk.
1. Di tab **Dokumentasi**, di bawah **halaman referensi API**, pilih nama titik akhir REST produk, seperti **/dogs - GET**.
1. Untuk **Pratinjau**, pilih **Edit halaman**.
1. Untuk **sumber Dokumentasi**, aktifkan **Ganti dokumentasi**.
1. Untuk **Menampilkan konten**, pilih **Ganti konten yang ada**.
Jika Anda memilih **Hapus semua konten**, konten akan dihapus dari halaman, tetapi Anda dapat memilih **Ganti konten yang ada** untuk mengakses dokumentasi lagi.
1. Di **badan Halaman**, masukkan dokumentasi referensi API kustom menggunakan [GitHub Flavored Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).
Dokumentasi ini tidak akan disebarkan kembali ke API Gateway.
1. Pilih **Simpan perubahan**.
1. Anda harus menerbitkan ulang portal apa pun yang menggunakan produk portal ini agar perubahan diterapkan.
# Memperbarui halaman produk di API Gateway
Saat Anda memperbarui halaman produk, Anda dapat mengubah semua pengaturan halaman produk. Setiap perubahan pada halaman produk Anda diperbarui secara otomatis, tetapi Anda perlu mempublikasikan ulang portal apa pun yang menggunakan produk Anda untuk melihat perubahan yang tercermin dalam portal.
# Bagikan produk portal di API Gateway
Anda dapat berbagi produk portal di seluruh Akun AWS penggunaan AWS RAM. Ketika Anda berbagi produk portal, akun lain dapat menggunakan produk portal Anda di portal mereka sendiri. Dengan produk portal bersama, Anda dapat membuat satu katalog organisasi APIs dan menerapkan standar tata kelola di seluruh ekosistem API Anda. Pada saat yang sama, berbagi produk portal memberikan fleksibilitas bagi penyedia API untuk mengembangkan, menguji, dan memelihara APIs di akun mereka sendiri.
## Pertimbangan-pertimbangan
Pertimbangan berikut dapat memengaruhi cara Anda berbagi sumber daya portal:
+ Saat Anda membagikan produk Anda dengan akun lain, akun tersebut tidak dapat mengubah properti REST API Anda. Ini termasuk titik akhir integrasi, strategi otorisasi, atau konfigurasi tahap.
+ Ketika Anda menambahkan produk portal akun lain ke portal Anda, pemilik produk portal tidak dapat melihat atau mengontrol properti lain dari portal Anda. Pemilik produk portal hanya tahu bahwa produk tersebut digunakan di portal Anda.
+ Produk portal API Gateway dibagikan di Wilayah AWS level tersebut.
+ Anda dapat menggunakan satu pembagian sumber daya dengan beberapa prinsipal, dan setelah Anda membuat pembagian sumber daya, Anda dapat menambahkan lebih banyak prinsipal ke dalamnya. Kami menyarankan bahwa jika memungkinkan, Anda menggunakan kembali bagian sumber daya Anda.
+ Jika kedua akun berada di organisasi yang sama menggunakan AWS Organizations, pembagian sumber daya secara otomatis diterima. Anda masih perlu membuat pembagian sumber daya menggunakan AWS RAM.
+ Jika kedua akun berada dalam organisasi yang sama menggunakan AWS Organizations dan berbagi sumber daya dalam organisasi Anda diaktifkan, setiap prinsipal di organisasi yang Anda bagikan secara otomatis diberikan akses ke pembagian sumber daya. Tidak perlu undangan dan Anda dapat melewati pembagian sumber daya.
+ Jika akun yang Anda bagikan produk tidak menerima pembagian sumber daya dalam waktu **12 jam**, Anda harus membagikan sumber daya lagi.
+ Setelah Anda membuat pembagian sumber daya, AWS RAM perbarui kebijakan berbagi produk produk Anda untuk mencegah akses ke prinsipal tanpa akses eksplisit. `allow` Untuk informasi selengkapnya, lihat [Menentukan apakah permintaan diizinkan atau ditolak dalam akun](https://docs.aws.amazon.com//IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-denyallow) di Panduan Pengguna IAM.
Kebijakan sumber daya yang diperbarui akan terlihat seperti berikut:
```
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"apigateway:GetProduct",
"apigateway:ListEndpoints",
"apigateway:ListPages",
"apigateway:GetEndpoint",
"apigateway:GetPage"
],
"Resource": [
"arn:aws:apigateway:us-east-1:111122223333:/portalproducts/product-id",
"arn:aws:apigateway:us-east-1:111122223333:/portalproducts/product-id/*"
]
}
]
}
```
AWS RAM telah mencegah prinsipal tanpa mengizinkan akses eksplisit untuk menambahkan produk Anda ke portal mereka, dengan menambahkan yang berikut:
```
"StringNotEquals": { "aws:PrincipalAccount": "555555555555" }
```
Untuk mempelajari cara berbagi produk, lihat[Bagikan produk portal Anda dengan pemilik portal di API Gateway](apigateway-portals-share-products.md). Untuk mempelajari cara menambahkan produk yang dibagikan dengan Anda ke portal Anda, lihat[Menambahkan produk portal bersama ke portal Anda di API Gateway](apigateway-portals-use-shared-products.md).
# Bagikan produk portal Anda dengan pemilik portal di API Gateway
Sebagai pemilik produk, Anda dapat berbagi produk Anda dengan pemilik portal di Akun AWS penggunaan lain AWS RAM. Anda mempertahankan kontrol penuh atas semua halaman produk dan halaman akhir REST produk.
## Pertimbangan-pertimbangan
Pertimbangan berikut dapat memengaruhi cara Anda berbagi produk portal:
+ Anda dapat berbagi atau membatalkan berbagi produk portal Anda kapan saja. Jika Anda membatalkan pembagian produk portal saat sedang digunakan di portal yang diterbitkan, pemilik portal tidak akan dapat melihat produk portal, melihat pembaruan apa pun yang dibuat untuk itu, atau menerbitkan ulang atau melihat pratinjau portal hingga mereka menghapus produk portal.
+ Anda dapat melihat produk portal yang telah Anda bagikan dengan akun lain.
+ Anda tidak dapat memodifikasi portal apa pun yang berisi produk portal Anda, kecuali Anda membuat portal sendiri.
## Bagikan produk portal Anda
Prosedur berikut menunjukkan cara membuat berbagi sumber daya.
------
#### [ Konsol Manajemen AWS ]
Untuk menggunakan Konsol Manajemen AWS, lihat [Membuat bagian sumber daya AWS RAM di](https://docs.aws.amazon.com/ram/latest/userguide/working-with-sharing-create.html) *Panduan AWS RAM Pengguna*.
Untuk **Pilih jenis sumber daya**, pilih **Produk API Gateway**.
------
#### [ AWS CLI ]
Berikut ini [create-resource-share](https://docs.aws.amazon.com/cli/latest/reference/ram/create-resource-share.html)membuat pembagian sumber daya untuk nama domain kustom pribadi Anda. Diperlukan beberapa menit untuk menyelesaikan sumber daya dan asosiasi utama. Untuk kepala sekolah, berikan ID akun atau ID Organizations, seperti. `arn:aws:organizations::123456789012:organization/o-1234abcd` Anda dapat memberikan beberapa prinsip untuk berbagi sumber daya Anda.
```
aws ram create-resource-share \
--region us-west-2 \
--name portal-product-resource-share \
--permission-arns arn:aws:ram::aws:permission/AWSRAMDefaultPermissionAPIGatewayDeveloperPortalProduct \
--resource-arns arn:aws:apigateway:us-west-2:111122223333:/portalproducts/p000000000 \
--principals 222222222222
```
------
Untuk membatalkan pembagian produk portal Anda, gunakan AWS RAM untuk menghapus pembagian sumber daya.
Kapan saja, Anda dapat memodifikasi kebijakan berbagi produk untuk memodifikasi prinsipal mana yang dapat menggunakan produk portal Anda di portal mereka.
**Untuk memperbarui kebijakan berbagi produk**
1. Masuk ke konsol API Gateway di [https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway).
1. Di panel navigasi utama, pilih **produk Portal**.
1. Pilih produk.
1. Di tab **Berbagi produk**, untuk **kebijakan berbagi produk**, pilih **Kelola kebijakan berbagi produk**.
1. Jika Anda belum pernah membagikan produk Anda sebelumnya, kebijakan berbagi produk Anda akan menolak semua akses ke akun lain ke produk portal Anda. Anda perlu memperbarui kebijakan untuk mengizinkan akses akun tertentu ke produk portal Anda.
1. Setelah memperbarui kebijakan berbagi produk, pilih **Simpan perubahan**.
# Menambahkan produk portal bersama ke portal Anda di API Gateway
Sebagai pemilik portal, Anda dapat menggunakan produk portal yang dibagikan dengan Anda oleh akun lain di portal Anda. Anda mempertahankan kontrol penuh atas portal Anda.
## Pertimbangan-pertimbangan
Pertimbangan berikut dapat memengaruhi cara Anda berbagi sumber daya portal:
+ Anda harus menerima pembagian sumber daya produk dari pemilik produk untuk menggunakan produk mereka di portal Anda. Jika Anda dan pemilik produk berada di Organizations yang sama, AWS RAM dapat menyelesaikan beberapa langkah berbagi untuk Anda.
+ Jika pemilik produk tidak membagikan produk saat berada di portal yang dipublikasikan, produk akan tetap terlihat di portal, tetapi Anda tidak akan dapat mempublikasikan portal lagi sampai Anda menghapus produk ini. Adalah tanggung jawab Anda sebagai pemilik portal untuk menghapus produk dari portal Anda, karena pemilik produk tidak dapat melakukannya untuk Anda.
+ Anda dapat melihat produk portal, halaman produk, dan halaman titik akhir REST produk, tetapi Anda tidak dapat memodifikasi sumber daya ini.
+ Jika suatu produk dibagikan dengan Anda, Anda tidak dapat membagikannya dengan akun lain.
## (Opsional) Terima pembagian sumber daya
Setelah pemilik produk Anda membuat pembagian sumber daya, Anda memiliki **waktu 12 jam** untuk menerimanya. Jika Anda berada di organisasi yang sama menggunakan AWS Organizations sebagai pemilik produk, pembagian secara otomatis diterima. Jika Anda berada di organisasi yang mengaktifkan sumber daya bersama otomatis, sumber daya akan dibagikan secara otomatis dengan Anda.
------
#### [ Konsol Manajemen AWS ]
*Untuk menggunakan Konsol Manajemen AWS, lihat [Menerima dan menolak undangan berbagi sumber daya](https://docs.aws.amazon.com/ram/latest/userguide/working-with-shared-invitations.html) di Panduan Pengguna.AWS RAM *
------
#### [ AWS CLI ]
Untuk menemukan semua sumber daya yang dibagikan dengan Anda, gunakan [get-resource-share-invitations](https://docs.aws.amazon.com/cli/latest/reference/ram/get-resource-share-invitations.html)perintah berikut:
```
aws ram get-resource-share-invitations \
--region us-west-2
```
Gunakan ARN berbagi sumber daya yang dihasilkan untuk menerima undangan berbagi sumber daya. [accept-resource-share-invitation](https://docs.aws.amazon.com/cli/latest/reference/ram/accept-resource-share-invitation.html)Perintah berikut menerima pembagian sumber daya.
```
aws ram accept-resource-share-invitation \
--resource-share-invitation-arn arn:aws:ram:us-west-2:123456789012:resource-share-invitation/1e3477be-4a95-46b4-bbe0-c4001EXAMPLE \
--region us-west-2
```
------
## Tambahkan produk bersama ke portal Anda
Setelah Anda menerima pembagian sumber daya, Anda menambahkan produk ke portal Anda.
------
#### [ Konsol Manajemen AWS ]
**Untuk menambahkan produk bersama ke portal Anda**
1. Masuk ke konsol API Gateway di [https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway).
1. Di panel navigasi utama, pilih **Portal**.
1. Pilih portal.
1. Di tab **Produk**, untuk **produk Portal**, pilih **Tambahkan produk**.
1. Tambahkan produk ke portal Anda. Produk bersama ditampilkan seperti `shared` dalam daftar produk.
1. Pilih **Simpan perubahan**.
------
#### [ AWS CLI ]
Untuk menemukan semua produk portal yang dibagikan dengan Anda, gunakan `get-portal-products` perintah berikut:
```
aws apigatewayv2 get-portal-products \
--resource-owner OTHER_ACCOUNTS \
--region us-west-2
```
Untuk menambahkan produk portal bersama ke portal Anda, gunakan `update-portal` perintah berikut:
```
aws apigateway update-portal \
--included-portal-product-arns arn:aws:apigateway:us-west-2:111122223333:/portalproducts/p000000000 \
--region us-west-2
```
------
# Aktifkan coba untuk titik akhir REST produk API Gateway di portal Anda
Gunakan coba untuk membiarkan konsumen API memanggil titik akhir produk Anda dari portal Anda. Ketika konsumen API menggunakan mencobanya, mereka memasukkan parameter permintaan metode dan memanggil titik akhir produk Anda. Kemudian, API Gateway memanggil API Anda melalui internet publik dan mengembalikan respons di jendela try it. Anda dapat menggunakan halaman produk khusus untuk memberikan informasi tambahan tentang parameter yang diperlukan untuk mengakses API Anda.
API Gateway menggunakan batasan berikut untuk melindungi Anda APIs:
+ API Gateway hanya mengizinkan 3 permintaan per detik ke API Anda.
+ API Gateway menggunakan batas waktu tunggu bawaan 29000 ms. API Anda yang sebenarnya mungkin memiliki batas waktu tunggu yang lebih tinggi, tetapi API Gateway tidak menerapkan batas waktu ini saat pelanggan menggunakan mencobanya.
+ API Gateway membatasi payload respons hingga 6MB.
## Pertimbangan-pertimbangan
Pertimbangan berikut mungkin memengaruhi cara Anda menggunakannya:
+ Coba itu tidak didukung saat Anda melihat pratinjau portal.
+ Coba itu tidak didukung untuk REST APIs dengan fitur-fitur berikut:
+ Pribadi APIs
+ APIs yang menggunakan TLS timbal balik
+ APIs yang menggunakan sertifikat SSL pribadi atau yang ditandatangani sendiri
Sebagai pemilik portal, Anda bertanggung jawab untuk berkomunikasi dengan konsumen API Anda, alasan mengapa tombol try it tidak ada untuk REST APIs yang tidak didukung. API Gateway tidak menjelaskan hal ini untuk Anda.
## Aktifkan coba untuk titik akhir REST produk
Prosedur berikut menunjukkan cara mengaktifkan try it untuk endpoint produk.
Untuk mempelajari cara menggunakannya, coba di portal, lihat[Menggunakan portal API Gateway](apigateway-portals-use-portal.md).
**Aktifkan coba untuk titik akhir REST produk**
1. Di panel navigasi utama, pilih **produk Portal**.
1. Pilih produk.
1. Di tab **Dokumentasi**, di bawah **halaman referensi API**, pilih nama titik akhir REST produk, seperti **/dogs - GET**.
1. Pilih **Edit halaman**.
1. Untuk memungkinkan pelanggan menjalankan API Anda di portal Anda, pilih **Coba fungsionalitas itu**.
1. Pilih **Simpan perubahan**.
1. Anda harus menerbitkan ulang portal apa pun yang menggunakan produk portal ini agar perubahan diterapkan.
# Menghapus produk portal di API Gateway
Ketika Anda menghapus produk portal, itu tidak dapat dipulihkan.
## Hapus produk portal
Prosedur berikut menunjukkan cara menghapus produk portal.
**Untuk menghapus produk portal**
1. Masuk ke konsol API Gateway di [https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway).
1. Di panel navigasi utama, pilih **produk Portal**.
1. Pilih produk portal.
1. Pilih **Hapus**.
1. Konfirmasikan pilihan Anda lalu pilih **Hapus**.
1. Anda harus menerbitkan ulang portal apa pun yang menggunakan produk portal ini agar perubahan diterapkan.
# Buat portal di API Gateway
Portal adalah kumpulan produk. Anda mengontrol otorisasi, branding, dan publikasi portal Anda. Saat Anda membuat portal, status publikasikannya adalah`Disabled`. Ini berarti portal Anda tidak dapat ditemukan di web. Untuk memungkinkan konsumen mengakses portal Anda, Anda perlu mempublikasikannya. Sebelum Anda mempublikasikan portal Anda, Anda juga dapat melihat pratinjaunya.
API Gateway mendukung portal pada browser berikut:
+ Firefox
+ Google Chrome
+ Microsoft Edge
+ Safari
## Pilih nama domain
Secara default, URL portal Anda di-host di nama domain milik Amazon berikut:
```
https://p-portalId.apigw-portal.us-east-1.on.aws
```
Untuk menyesuaikan nama domain, Anda dapat memberikan nama domain yang Anda miliki dan sertifikat SSL untuk domain kustom. Sertifikat harus dikelola dengan [AWS Certificate Manager](https://docs.aws.amazon.com/acm/latest/userguide/)(ACM) di AS Timur (Virginia N.) dan didukung oleh Amazon. CloudFront Untuk informasi selengkapnya, lihat [Persyaratan untuk menggunakan SSL/TLS sertifikat dengan CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cnames-and-https-requirements.html).
Saat Anda menggunakan nama domain khusus, API Gateway membuat CloudFront distribusi, diamankan saat transit dengan sertifikat ACM Anda. Kemudian, API Gateway menyediakan catatan alias, yang Anda tambahkan ke konfigurasi DNS Anda. Catatan alias adalah nama domain milik Amazon. Anda harus menambahkan catatan alias ini untuk mengarahkan lalu lintas ke CloudFront distribusi untuk domain kustom Anda. Nama domain yang Anda berikan harus unik dan belum digunakan oleh daftar alias pada CloudFront distribusi yang ada.
Jika Anda menggunakan nama domain Anda sendiri, API Gateway menggunakan kebijakan `TLS_1_2` keamanan untuk melindungi portal Anda. Untuk informasi selengkapnya, lihat [Protokol dan sandi yang didukung](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html) antar pemirsa. Anda tidak dapat mengubah nilai ini.
## Buat portal
Anda menggunakan konsol API Gateway untuk membuat dan mengonfigurasi portal Anda. Prosedur berikut memandu Anda melalui semua langkah yang diperlukan. Anda juga dapat memilih **Skip to Review dan membuat** di akhir prosedur pertama untuk membuat portal kosong.
Prosedur berikut menunjukkan cara membuat portal. Pertama, Anda menentukan detail portal Anda.
**Untuk menentukan detail portal Anda**
1. Masuk ke konsol API Gateway di [https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway).
1. Di panel navigasi utama, pilih **Portal**.
1. Pilih **Buat portal**.
1. Di bawah detail portal, untuk **nama Portal**, masukkan nama.
1. Untuk **deskripsi Portal**, masukkan deskripsi.
1. Untuk **otorisasi Portal**, pilih cara mengotorisasi portal Anda.
+ Jika ini adalah pertama kalinya Anda membuat portal, kami sarankan Anda memilih **None**. Jika Anda berencana menambahkan produksi apa pun APIs ke portal Anda, gunakan **Memerlukan otorisasi**.
+ Untuk mengharuskan konsumen portal mengautentikasi untuk menggunakan portal Anda, pilih **Memerlukan otorisasi**, dan lakukan hal berikut:
1. Untuk kumpulan pengguna **Amazon Cognito, pilih kumpulan pengguna** Anda.
Kumpulan pengguna harus berada di Wilayah yang sama dengan portal Anda.
1. Untuk **ID klien Aplikasi**, pilih ID klien aplikasi.
Di klien aplikasi, Anda harus menyetel URL callback ke URL default portal.
1. Untuk **domain kumpulan pengguna**, masukkan domain kumpulan pengguna. Untuk informasi selengkapnya, lihat [Mengonfigurasi domain kumpulan pengguna](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html).
1. Untuk **konfigurasi Domain**, pilih nama domain untuk portal Anda.
+ Jika ini adalah pertama kalinya Anda membuat portal, kami sarankan Anda memilih **Domain default**. Setelah Anda mempublikasikan portal Anda, itu akan tersedia di`https://p-portalId.apigw-portal.us-east-1.on.aws`.
+ Untuk memberikan nama domain kustom yang Anda miliki, pilih **Custom domain name** dan lakukan hal berikut:
1. Untuk **nama Domain**, masukkan nama domain yang sepenuhnya memenuhi syarat.
1. Untuk **sertifikat ACM**, pilih sertifikat ACM yang mencakup nama domain.
Anda harus menambahkan catatan alias yang disediakan API Gateway ke catatan DNS Anda, untuk melayani lalu lintas dari portal Anda.
1. Untuk menambahkan monitor aplikasi CloudWatch RUM ke portal Anda, untuk **monitor aplikasi RUM**, pilih monitor aplikasi. Untuk informasi lebih lanjut, lihat [CloudWatch RUM](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM.html).
1. Pilih **Berikutnya**.
Setelah Anda menentukan detail portal Anda, Anda menambahkan produk portal. Anda dapat mengubah produk portal di portal Anda kapan saja, tetapi Anda perlu mempublikasikan ulang portal Anda agar perubahan diterapkan.
**Untuk memilih produk portal Anda**
1. Dari daftar sumber daya, pilih produk yang akan ditambahkan ke portal Anda.
1. Pilih **Berikutnya**.
Setelah Anda memilih produk Anda, Anda menyesuaikan desain portal. Untuk mengunggah logo portal, Anda harus memiliki gambar yang diunggah ke Amazon S3. Anda dapat mengubah nilai-nilai ini kapan saja, tetapi Anda perlu mempublikasikan ulang portal Anda agar perubahan diterapkan.
**(Opsional) Untuk menyesuaikan portal Anda**
1. Untuk **logo Portal**, berikan URI S3 untuk file Anda.
Hanya`.svg`,`.png`, atau `.jpg` didukung.
1. Untuk menyesuaikan desain portal Anda, Anda memiliki dua opsi:
1. Anda dapat memilih **tema Portal** untuk menerapkan tema warna pra-dibuat di portal Anda.
1. Anda dapat menggunakan pemilih warna untuk memilih semua opsi desain portal Anda.
1. Pilih **Berikutnya**.
Setelah Anda memilih desain portal, tinjau informasi untuk portal.
**Untuk meninjau portal Anda**
+ Tinjau pengaturan Anda di halaman ulasan dan buat. Setelah Anda puas dengan pengaturan, pilih **Buat**.
Jika Anda menggunakan kumpulan pengguna Amazon Cognito untuk mengontrol akses ke portal, Anda harus menyetel URL panggilan balik ke URL default portal di klien aplikasi. Untuk informasi selengkapnya, lihat [Pengaturan khusus aplikasi dengan klien aplikasi](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html).
Portal Anda tidak akan tersedia untuk konsumen setelah Anda membuatnya. Anda harus mempublikasikan portal Anda agar dapat diakses di internet. Lihat informasi yang lebih lengkap di [Publikasikan portal di API Gateway](apigateway-portals-publish-portal.md).
# Memperbarui portal di API Gateway
Anda dapat memperbarui tema, logo, atau produk portal di portal Anda. Ketika Anda memperbarui portal Anda, perubahan tidak akan berlaku sampai Anda mempublikasikan ulang portal Anda.
## Perbarui portal
Prosedur berikut menunjukkan cara memperbarui desain portal.
**Untuk memperbarui desain portal**
1. Masuk ke konsol API Gateway di [https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway).
1. Di panel navigasi utama, pilih **Portal**.
1. Pilih portal.
1. Di tab **Desain portal**, pilih **Edit**.
1. Untuk memperbarui logo portal, pilih **Perbarui logo portal**. Anda dapat menghapus logo yang ada atau menggunakan logo baru.
1. Buat pembaruan tema atau latar belakang apa pun untuk desain portal Anda.
1. Pilih **Simpan perubahan**.
1. (Opsional) Pilih **Buat pratinjau portal** untuk melihat perubahan Anda.
Setelah mengonfirmasi perubahan, publikasikan portal Anda.
1. Pilih **Publikasikan portal**.
1. Masukkan deskripsi untuk pembaruan portal Anda dan pilih **Publikasikan**.
# Pratinjau portal di API Gateway
Anda dapat melihat pratinjau portal Anda sebelum mempublikasikannya. API Gateway membuat URL berumur pendek yang dapat Anda gunakan untuk melihat pratinjau versi portal Anda yang akan dilihat pelanggan setelah portal Anda diterbitkan.
## Pertimbangan-pertimbangan
Pertimbangan berikut dapat memengaruhi cara Anda melihat pratinjau portal:
+ Coba itu tidak diaktifkan untuk portal pratinjau Anda. Untuk informasi selengkapnya, lihat [Aktifkan coba untuk titik akhir REST produk API Gateway di portal Anda](apigateway-portals-try-it.md).
## Pratinjau portal
Prosedur berikut menunjukkan cara melihat pratinjau portal.
**Untuk melihat pratinjau portal**
1. Masuk ke konsol API Gateway di [https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway).
1. Di panel navigasi utama, pilih **Portal**.
1. Pilih portal.
1. Pilih **Hasilkan pratinjau portal**.
Jangan me-refresh halaman Anda.
1. Setelah API Gateway menghasilkan pratinjau Anda, pilih **Buka pratinjau portal**.
Pratinjau portal Anda akan terbuka di tab baru.
# Publikasikan portal di API Gateway
Agar konsumen API dapat mengakses portal Anda, Anda harus mempublikasikannya. URL portal dapat ditemukan oleh siapa saja di internet. Kami menyarankan Anda melihat pratinjau dan mengamankan portal Anda sebelum menerbitkannya.
## Pertimbangan-pertimbangan
API Gateway mungkin perlu beberapa menit untuk mempublikasikan portal Anda. Anda dapat memantau **status Publikasikan** di konsol.
## Publikasikan portal
Prosedur berikut menunjukkan cara mempublikasikan portal.
**Untuk mempublikasikan portal**
1. Masuk ke konsol API Gateway di [https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway).
1. Di panel navigasi utama, pilih **Portal**.
1. Pilih portal.
1. Pilih **Publikasikan portal**.
1. (Opsional) Untuk **Deskripsi perubahan**, masukkan deskripsi perubahan Anda.
Saat Anda mempublikasikan portal, kami sarankan Anda selalu memberikan deskripsi singkat tentang perubahan Anda.
1. Pilih **Terbitkan**.
API Gateway membutuhkan beberapa menit untuk menyelesaikan penerbitan portal Anda. API Gateway menyediakan tautan ke portal Anda saat tersedia.
Untuk menghapus portal Anda, Anda harus menonaktifkannya terlebih dahulu. Lihat informasi yang lebih lengkap di [Nonaktifkan portal di API Gateway](apigateway-portals-disable-portal.md).
# Menggunakan portal API Gateway
Setelah Anda mempublikasikan portal Anda, itu tersedia di web. Untuk menggunakan portal Anda, salin **nama domain default Portal** atau **nama domain** dan masukkan di browser. Jika portal Anda menggunakan nama domain, nama domain default tidak dapat digunakan untuk mengakses portal Anda.
## Gunakan portal
Prosedur berikut menunjukkan cara mengakses portal dan menggunakannya untuk titik akhir REST produk.
**Untuk menggunakan portal**
1. Masuk ke konsol API Gateway di [https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway).
1. Di panel navigasi utama, pilih **Portal**.
1. Pilih portal.
1. Salin **nama domain default Portal** atau **nama domain** dan masukkan di browser.
1. Di beranda portal, Anda dapat mencari produk portal dan menemukan halaman produk. Gunakan pencarian di bagian atas portal untuk mencari semua konten di portal Anda. Gunakan bilah pencarian di bawah **Produk** untuk mencari produk portal.
1. Pilih produk portal.
1. Pilih produk REST endpoint.
1. Di jendela **Coba**, masukkan parameter untuk mencoba panggilan ke API Anda.
1. Pilih **Cobalah**. API Gateway akan memanggil API Anda dan menampilkan hasilnya di jendela.
## Memecahkan masalah portal Anda
Berikut ini memberikan saran pemecahan masalah untuk kesalahan dan masalah yang mungkin Anda temui saat menggunakan portal.
### Situs web portal tidak dapat dihubungi
Jika Anda menerima pesan kesalahan bahwa situs web portal tidak dapat dihubungi, pastikan Anda mempublikasikan portal Anda. Jika Anda menggunakan nama domain, pastikan Anda menambahkan catatan alias yang disediakan API Gateway untuk mengarahkan lalu lintas ke CloudFront distribusi domain kustom Anda.
### Mencobanya gagal
Jika Anda tidak dapat menggunakannya untuk titik akhir REST produk, pastikan status try it. `ACTIVE` Selain itu, pastikan Anda memasukkan parameter yang benar untuk menjalankan API Anda.
### Halaman tidak muncul di portal Anda
Jika Anda membuat halaman endpoint REST produk atau halaman produk dan tidak terlihat di portal Anda, pastikan halaman Anda bukan draf. Untuk memverifikasi ini, lakukan hal berikut:
**Untuk memverifikasi halaman Anda tidak dalam draf**
1. Masuk ke konsol API Gateway di [https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway).
1. Di panel navigasi utama, pilih **produk Portal**.
1. Pilih produk portal Anda.
1. Di tab **Dokumentasi**, konfirmasikan halaman Anda tidak berada di **halaman dokumentasi** **Draft atau bagian halaman referensi API Draft**, tetapi berada di **halaman dokumentasi kustom** atau **halaman referensi API**.
# Nonaktifkan portal di API Gateway
Saat Anda menonaktifkan portal, portal Anda tidak lagi tersedia di web. Setelah Anda menonaktifkan portal, Anda dapat menghapus portal atau menerbitkannya kembali jika perlu.
## Nonaktifkan portal
Prosedur berikut menunjukkan cara menonaktifkan portal.
**Untuk menonaktifkan portal**
1. Masuk ke konsol API Gateway di [https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway).
1. Di panel navigasi utama, pilih **Portal**.
1. Pilih portal.
1. Pilih **Tindakan**, lalu pilih **Nonaktifkan portal**.
1. Konfirmasikan pilihan Anda dan pilih **Nonaktifkan portal**.
**Status Publikasikan** akan berubah menjadi **Dinonaktifkan**.
Untuk menghapus status nonaktifkan portal, publikasikan portal lagi.
# Menghapus portal di API Gateway
Ketika Anda menghapus portal, itu tidak dapat dipulihkan dan Anda harus menonaktifkannya terlebih dahulu. Jika Anda ingin menghapus portal Anda dari web, Anda dapat menonaktifkannya. Ini memungkinkan Anda memodifikasi portal Anda dan menerbitkannya kembali nanti.
## Hapus portal
Prosedur berikut menunjukkan cara menghapus portal.
**Untuk menghapus portal**
1. Masuk ke konsol API Gateway di [https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway).
1. Di panel navigasi utama, pilih **Portal**.
1. Pilih portal.
1. Jika portal Anda tidak dinonaktifkan, nonaktifkan dengan memilih **Tindakan**, **Nonaktifkan portal**.
Dibutuhkan beberapa menit agar portal Anda dinonaktifkan. Anda dapat memantau **status Publikasikan** untuk melihat kapan status publikasi portal Anda dinonaktifkan.
1. Setelah Anda tidak mempublikasikan portal Anda, Anda dapat menghapusnya. Untuk menghapus portal Anda, pilih **Tindakan**, **Hapus portal**. Konfirmasikan pilihan Anda lalu pilih **Hapus**.