Buat portal di API Gateway - Amazon API Gateway

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Buat portal di API Gateway

Portal adalah kumpulan produk. Anda mengontrol otorisasi, branding, dan publikasi portal Anda. Saat Anda membuat portal, status publikasikannya adalahDisabled. 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(ACM) di AS Timur (Virginia N.) dan didukung oleh Amazon. CloudFront Untuk informasi selengkapnya, lihat Persyaratan untuk menggunakan SSL/TLS sertifikat dengan CloudFront.

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 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.

  2. Di panel navigasi utama, pilih Portal.

  3. Pilih Buat portal.

  4. Di bawah detail portal, untuk nama Portal, masukkan nama.

  5. Untuk deskripsi Portal, masukkan deskripsi.

  6. 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.

      2. Untuk ID klien Aplikasi, pilih ID klien aplikasi.

        Di klien aplikasi, Anda harus menyetel URL callback ke URL default portal.

      3. Untuk domain kumpulan pengguna, masukkan domain kumpulan pengguna. Untuk informasi selengkapnya, lihat Mengonfigurasi domain kumpulan pengguna.

  7. 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 dihttps://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.

      2. 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.

  8. Untuk menambahkan monitor aplikasi CloudWatch RUM ke portal Anda, untuk monitor aplikasi RUM, pilih monitor aplikasi. Untuk informasi lebih lanjut, lihat CloudWatch RUM.

  9. 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.

  2. 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.

  2. Untuk menyesuaikan desain portal Anda, Anda memiliki dua opsi:

    1. Anda dapat memilih tema Portal untuk menerapkan tema warna pra-dibuat di portal Anda.

    2. Anda dapat menggunakan pemilih warna untuk memilih semua opsi desain portal Anda.

  3. 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.

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.