HTTPS menambahkan lapisan keamanan pada protokol HTTP standar dengan menggunakan Secure Sockets Layer (SSL) untuk mengenkripsi data, sehingga memastikan keamanan data selama transmisi.
API Gateway memungkinkan Anda mengamankan permintaan API dengan HTTPS. Anda dapat mengonfigurasi setiap API agar hanya mendukung HTTP, hanya HTTPS, atau keduanya. Untuk mengaktifkan HTTPS pada API Anda, ikuti langkah-langkah berikut.
Langkah 1: Prasyarat
Sebelum memulai, pastikan Anda telah menyiapkan hal-hal berikut:
Nama domain independen yang Anda miliki dan kendalikan.
Sertifikat SSL untuk nama domain tersebut.
Sertifikat SSL beserta kunci privatnya dalam format PEM. Catatan: API Gateway menggunakan Tengine, yaitu layanan berbasis Nginx, sehingga diperlukan sertifikat yang kompatibel dengan Nginx dalam format PEM.
Sertifikat SSL dan kunci privatnya biasanya disediakan dalam dua file terpisah, seperti XXXXX.pem dan XXXXX.key, yang dapat dibuka menggunakan editor teks.
KEY:
-----BEGIN RSA PRIVATE KEY-----
MIIEpAIBAAKCAQEA8GjIleJ7rlo86mtbwcDnUfqzTQAm4b3zZEo1aKsfAuwcvCud
....
-----END RSA PRIVATE KEY-----PEM:
-----BEGIN CERTIFICATE-----
MIIFtDCCBJygAwIBAgIQRgWF1j00cozRl1pZ+ultKTANBgkqhkiG9w0BAQsFADBP
...
-----END CERTIFICATE----- Langkah 2: Bind Sertifikat SSL
Masuk ke Konsol API Gateway. Di panel navigasi kiri, pilih . Klik nama kelompok API tempat Anda ingin melakukan bind sertifikat SSL. Sebelum dapat melakukan bind sertifikat SSL, Anda harus terlebih dahulu melakukan bind independent domain name ke kelompok API tersebut.
Pada baris yang berisi nama domain, klik Select Certificate di kolom SSL Certificate.
Tambahkan sertifikat SSL untuk Independent Domain Name.
Nama sertifikat dapat berisi karakter Tionghoa, huruf, angka, garis bawah (_), dan tanda hubung (-). Nama harus dimulai dengan huruf atau karakter Tionghoa serta memiliki panjang 4 hingga 50 karakter. Konten sertifikat dan kunci privat harus dalam format PEM dan tidak boleh melebihi 20 KB. Klik tombol Upload untuk mengimpor file. Untuk otentikasi timbal balik HTTPS, klik tautan Click to add CA certificate untuk menambahkan sertifikat CA.
Certificate Name: Nama kustom untuk membantu Anda mengidentifikasi sertifikat.
Certificate Content: Konten lengkap dari file sertifikat XXXXX.pem.
Private Key: Konten dari file kunci privat XXXXX.key. Klik OK untuk melakukan bind sertifikat.
Langkah 3: Sesuaikan Konfigurasi API
Setelah Anda melakukan bind sertifikat SSL, Anda dapat mengontrol protokol akses untuk setiap API. Protokol yang didukung adalah HTTP, HTTPS, atau keduanya. Untuk alasan keamanan, kami menyarankan agar Anda mengonfigurasi semua API agar menggunakan HTTPS.
Di Konsol API Gateway, buka dan temukan API target.
Klik nama API target, lalu klik Edit di pojok kanan atas.
Pada langkah Basic Information, klik Next untuk melanjutkan ke langkah Define API Request. Di bagian Protocol, pilih protokol yang diinginkan.
Pilih kedua opsi HTTP dan HTTPS.
Nilai yang valid untuk Protocol adalah:
HTTP: Mengizinkan akses API hanya melalui HTTP dan menolak akses melalui HTTPS.
HTTPS: Mengizinkan akses API hanya melalui HTTPS dan menolak akses melalui HTTP.
HTTP and HTTPS: Mengizinkan akses API melalui kedua protokol. Ini mengaktifkan akses HTTPS untuk API Anda.