Mengontrol akses ke API dengan mendaftarkan aplikasi

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat Dokumentasi Apigee Edge.

Bagian ini menjelaskan cara mendaftarkan aplikasi dan mengelola kunci API.

Ringkasan

Cara utama untuk mengontrol siapa saja yang dapat mengakses API Anda adalah melalui pendaftaran aplikasi.

Sebagai penyedia API, Anda harus membuat satu atau beberapa Produk API yang memaketkan API Anda ke dalam tingkat layanan. Produk API memungkinkan Anda membatasi traffic dan tingkat akses dengan cara yang sangat terperinci level organisasi. Saat membuat produk API, Anda dapat menetapkan tingkat akses ke Publik, Pribadi, atau Internal saja. Untuk informasi selengkapnya, lihat Tingkat akses.

Saat mendaftarkan aplikasi, developer aplikasi memilih produk API yang akan digunakan dan Apigee menyediakan satu kunci API yang digunakan developer untuk mengakses produk API tersebut. Pengembang aplikasi melewati kunci API dalam setiap panggilan ke proxy API yang terdapat dalam produk API. Anda dapat mencabut kunci API aplikasi kapan saja, sehingga mencegah developer aplikasi mengakses semua atau sebagian produk API yang dirujuk oleh aplikasi tersebut.

Biasanya, developer aplikasi mendaftar untuk menggunakan produk API Anda menggunakan portal developer Anda. Langkah-langkah untuk membangun portal dan memublikasikan produk API telah dijelaskan di Membuat portal.

Anda dapat memiliki kontrol lebih terhadap proses pendaftaran aplikasi dengan mendaftarkan aplikasi Anda menggunakan Apigee UI atau Apigee API sebagai gantinya. Misalnya, Anda mungkin ingin mendaftarkan aplikasi untuk tim pengembangan atau untuk developer yang tidak dapat mengakses portal Anda.

Bagian berikut menjelaskan cara mendaftarkan aplikasi dan mengelola kunci API menggunakan UI dan API.

Menjelajahi halaman Aplikasi

Untuk mendaftarkan aplikasi dan mengelola kunci API di UI Apigee, gunakan Aplikasi {i>view<i}.

Untuk mengakses tampilan Apps menggunakan UI Apigee:

• Jika Anda menggunakan UI Apigee di Konsol Cloud: Pilih Distribusi > Aplikasi.
• Jika Anda menggunakan UI Apigee klasik: Pilih Publikasikan > Aplikasi.

Tampilan Aplikasi memungkinkan Anda melakukan hal berikut:

• Mendaftarkan aplikasi
• Melihat dan mengedit aplikasi
• Mengelola kredensial
• Menyetujui atau mencabut aplikasi
• Menghapus aplikasi
• Telusuri daftar aplikasi menurut nama, developer, ID aplikasi, kunci API konsumen, atau semua konten

Mendaftarkan aplikasi

Aplikasi dapat didaftarkan dengan cara berikut:

• Oleh developer aplikasi: Developer aplikasi dapat mendaftarkan aplikasi melalui portal Anda, sebagai dijelaskan dalam Cara aplikasi developer berinteraksi dengan portal Anda.
• Oleh administrator: Anda dapat mendaftarkan aplikasi di Apigee, seperti yang dijelaskan di bawah. Andalah yang menentukan cara memberikan kunci kepada developer aplikasi.

Aplikasi yang terdaftar akan ditambahkan ke:

• Daftar aplikasi terdaftar di Apigee. Lihat Melihat dan mengedit detail developer.
• Halaman aplikasi di developer portal.

Untuk mendaftarkan aplikasi di Apigee:

1. Akses halaman Aplikasi.
• Jika Anda menggunakan UI Apigee di Konsol Cloud: Pilih Distribusi > Aplikasi.
• Jika Anda menggunakan UI Apigee klasik: Pilih Publikasikan > Aplikasi.
2. Tentukan Detail Aplikasi, seperti yang dijelaskan dalam tabel berikut:

   Kolom	Deskripsi	Wajib?
   Nama	Nama aplikasi. Anda tidak dapat mengubah nama setelah aplikasi dibuat. Nama ini adalah yang digunakan dalam panggilan Apigee API.	Wajib
   Nama Tampilan	Nama tampilan untuk aplikasi yang muncul di UI Apigee dan developer portal.	Opsional
   Developer	Pilih nama developer dari drop-down. Catatan: Untuk alasan performa, tidak semua developer ditampilkan di menu drop-down. Mulai ketikkan nama atau email developer dalam kotak penelusuran, dan nilai {i>drop-down<i} akan disempurnakan secara otomatis agar sesuai dengan teks yang Anda ketik. Lihat juga Mendaftarkan developer aplikasi.	Wajib
   URL callback	Biasanya menetapkan URL aplikasi yang ditetapkan untuk menerima otorisasi kode atas nama aplikasi klien. Nilai ini tidak diperlukan untuk semua produk API.	Opsional
   Catatan	Catatan deskriptif untuk aplikasi.	Opsional

3. Tentukan Credentials, termasuk masa berlaku dan status kunci API serta produk API terkait. Di bagian Credentials, klik , lalu masukkan informasi berikut:

   Kolom	Deskripsi
   Kedaluwarsa	Konfigurasi durasi atau tanggal habis masa berlaku, atau setel kunci API ke tidak memiliki tanggal habis masa berlaku, lalu klik OK.
   Produk	Kaitkan satu atau beberapa produk API dengan kunci API tersebut: Klik Tambahkan produk. Pilih satu atau beberapa produk API dari daftar. Klik Tambahkan. Tetapkan Status ke Disetujui atau Dicabut untuk setiap produk API. Ulangi langkah-langkah ini untuk menambahkan produk API lainnya.

4. Tentukan Atribut Khusus:
   1. Di bagian Atribut Khusus, klik .
   2. Masukkan nama dan nilai.
   3. Klik Tambahkan atau Tambahkan & Mulai yang lain. Jumlah maksimum yang dapat Anda tambahkan adalah 18.
5. Klik Create.

Jika produk API yang Anda kaitkan dengan aplikasi memerlukan persetujuan manual untuk kunci API, setujui kebijakan tersebut, seperti yang dijelaskan di bagian Menyetujui atau mencabut kunci API.

Melihat aplikasi yang terdaftar untuk pengembang

Untuk melihat aplikasi yang didaftarkan untuk developer tertentu, gunakan salah satu metode berikut:

• Lihat semua aplikasi yang terdaftar, pilih Developer di drop-down Penelusuran, dan masukkan nama developer di kolom penelusuran.
• Lihat semua developer aplikasi terdaftar, lalu klik baris yang terkait dengan developer.

Melihat dan mengedit aplikasi

Untuk melihat dan mengedit aplikasi:

1. Akses halaman Aplikasi.
2. Klik di mana saja di baris aplikasi yang ingin Anda lihat dan edit. Apigee menampilkan detail aplikasi.
3. Untuk mengedit aplikasi, klik Edit.
4. Lakukan satu atau beberapa tugas berikut:
   • Ubah detail aplikasi, termasuk nama, URL callback, atau catatan.
   • Kelola kredensial.
   • Menambahkan atau menghapus atribut khusus. Jumlah maksimum atribut khusus yang dapat Anda adalah 18.
   • Menyetujui atau mencabut aplikasi.
5. Klik Simpan.

Mengelola kredensial

Saat mengedit aplikasi, Anda dapat mengelola kredensialnya di Credentials, seperti ditunjukkan dalam gambar berikut:

Seperti yang disorot dalam gambar sebelumnya, di bagian Credentials, Anda dapat melakukan hal berikut menggunakan UI:

• Melihat kunci dan rahasia API
• Menyetujui atau mencabut kunci API untuk semua API terkait atau untuk satu produk API.
• Mengelola produk API di aplikasi
• Membuat kredensial baru

Agar dapat menggunakan API untuk mengelola kredensial, lihat Mengimpor kunci dan rahasia konsumen yang sudah ada.

Melihat kunci dan rahasia API

Untuk melihat kunci dan rahasia API:

1. Akses halaman Aplikasi.
2. Klik baris aplikasi tempat Anda ingin melihat kunci API dan rahasianya.
3. Di bagian Credentials, klik Show yang terkait dengan kunci API atau rahasia yang yang ingin dilihat.

Menyetujui atau mencabut kunci API

Panggilan API ke proxy API biasanya memerlukan parameter API . Apigee mengizinkan panggilan hanya jika kunci API disetujui, valid, dan memenuhi kondisi yang ditentukan oleh produk API yang berisi API.

Anda dapat mengonfigurasi produk API untuk persetujuan otomatis kunci API, seperti yang dijelaskan di Mengelola produk API. Akan tetapi, jika produk API memerlukan persetujuan manual untuk kunci API, Anda harus menyetujui kunci secara manual.

Anda dapat mencabut kunci API untuk semua atau satu produk API. Dalam hal ini, kunci API dan secret tidak valid dan tidak dapat digunakan untuk API akses dalam produk API terkait. Anda dapat menyetujui kembali kunci API kapan saja.

Untuk menyetujui atau mencabut kunci API:

1. Akses halaman Aplikasi.
2. Klik di baris aplikasi yang ingin Anda lihat dan edit.
3. Klik Edit.
4. Lakukan salah satu dari tugas berikut:
   • Untuk menyetujui atau mencabut kunci API untuk semua produk API yang terkait dengan kunci API, pilih Disetujui atau Dicabut yang terkait dengan kunci API.
   • Untuk menyetujui atau mencabut kunci API bagi produk API tertentu, pilih Disetujui atau Dicabut di kolom Status untuk produk API.
5. Klik Simpan.

Mengelola produk API dalam aplikasi

Kelola produk API di aplikasi Anda dengan melakukan tugas berikut:

• Menambahkan produk API ke aplikasi
• Menghapus produk API dari aplikasi

Menambahkan produk API ke aplikasi

Untuk menambahkan produk API ke aplikasi:

1. Akses halaman Aplikasi.
2. Klik di baris aplikasi yang ingin Anda lihat dan edit.
3. Klik Edit.
4. Lakukan salah satu dari tugas berikut:
   • Untuk menambahkan produk API ke kunci API baru, klik untuk membuat kredensial baru, memilih masa berlaku, dan menambahkan produk API ke kunci API.
   • Untuk menambahkan produk API ke kunci API yang ada, klik di bagian Credential Tambahkan produk dan pilih produk API dari menu drop-down.
5. Klik Simpan.

Menghapus produk API dari aplikasi

Jika Anda ingin membuat kunci API tetap aktif tetapi tidak mengizinkannya untuk digunakan oleh API Anda dapat menghapusnya dari kredensial terkait.

1. Akses halaman Aplikasi.
2. Klik di baris aplikasi yang ingin Anda lihat dan edit.
3. Klik Edit.
4. Klik delete di samping produk API.
5. Klik Simpan.

Anda dapat menambahkan kembali produk yang telah dihapus.

Membuat kredensial baru

Anda dapat membuat kredensial baru untuk aplikasi. Misalnya, jika Anda menggunakan Rotasi kunci API, Anda dapat membuat kunci baru yang masa berlakunya tumpang-tindih dengan kunci yang akan habis dari rotasi saat kedaluwarsa. Anda juga dapat membuat kunci/rahasia baru jika keamanan kunci/rahasia asli disusupi. Jika Anda membuat kunci baru, semua kunci API yang ada akan terus bekerja sampai kedaluwarsa atau Anda secara eksplisit mencabutnya.

Untuk membuat kunci API baru:

1. Akses halaman Aplikasi.
2. Klik di baris aplikasi yang ingin Anda lihat dan edit.
3. Klik Edit.
4. Di bagian Credentials, klik .
5. Tentukan masa berlaku, tambahkan produk API, dan tetapkan statusnya.
6. Jika ingin, cabut kunci API lainnya, sebagaimana tidak diperlukan.
7. Klik Simpan.

Menyetujui atau mencabut aplikasi

Menyetujui atau mencabut aplikasi, seperti yang dijelaskan di bawah. Saat Anda mencabut aplikasi, kunci API yang disetujui tidak lagi dapat digunakan dalam panggilan API ke Apigee. Saat Anda menyetujui kembali aplikasi, semua kunci API yang disetujui dan valid dapat digunakan untuk membuat API panggilan telepon.

Jika aplikasi terdaftar di organisasi lain, Anda harus mencabutnya di setiap organisasi tidak di organisasi lain. Mungkin diperlukan waktu beberapa menit agar perubahan dikenali oleh semua pemroses pesan.

Untuk menyetujui atau mencabut aplikasi:

1. Akses halaman Aplikasi.
2. Klik di baris aplikasi yang ingin Anda lihat dan edit.
3. Klik Edit.
4. Pilih Setujui atau Cabut di kolom Status Aplikasi untuk menyetujui atau mencabut aplikasi tersebut.
5. Klik Simpan.

Menghapus aplikasi

Saat Anda menghapus aplikasi, semua kunci klien yang terkait dengan aplikasi tersebut menjadi tidak valid. Menggunakan kunci yang tidak valid pada permintaan akan menyebabkan permintaan gagal.

Jika Anda merasa mungkin ingin mengaktifkan kembali aplikasi developer pada masa mendatang, sebuah alternatif untuk penghapusan adalah pencabutan aplikasi.

Untuk menghapus aplikasi:

1. Akses halaman Aplikasi.
2. Posisikan kursor di baris aplikasi yang ingin Anda hapus.
3. Klik delete di kolom tindakan.

Mendaftarkan aplikasi dan mengelola kunci API menggunakan API

Untuk mendaftarkan dan mengelola aplikasi menggunakan Apigee API, gunakan API berikut:

• API Aplikasi
• API aplikasi developer
• API kunci aplikasi developer

Lihat juga Impor kunci dan rahasia konsumen yang sudah ada.