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 yang dapat mengakses API Anda adalah melalui pendaftaran aplikasi.

Sebagai penyedia API, Anda membuat satu atau beberapa produk API yang memaketkan API Anda ke dalam beberapa tingkat layanan. Produk API memungkinkan Anda membatasi traffic dan tingkat akses pada tingkat yang sangat terperinci. 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. Developer aplikasi meneruskan kunci API di 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 Anda dijelaskan dalam Membangun portal Anda.

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

Anda harus menjadi administrator organisasi atau diberi peran dengan izin yang sesuai untuk mendaftarkan aplikasi dan mengelola kunci API.

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, Anda dapat menggunakan tampilan Apps.

Untuk mengakses tampilan Apps menggunakan UI Apigee:

• Jika Anda menggunakan UI Apigee di Cloud Console: Pilih Distribution > Apps.
• Jika Anda menggunakan UI Apigee klasik: Pilih Publish > Apps.

Tampilan Apps 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

Peringatan: Selalu pastikan aplikasi Anda menyertakan setidaknya satu produk API yang memiliki setidaknya satu proxy dan/atau jalur resource API ditentukan. Jika produk API tidak menyertakan proxy API dan/atau jalur resource, kunci aplikasi dapat digunakan untuk memanggil proxy API apa pun di organisasi Apigee Anda. Biasanya, Anda tidak ingin membuat apa yang disebut kunci kerangka—kunci yang dapat membuka semua pintu di rumah Anda.

Aplikasi dapat didaftarkan dengan cara berikut:

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

Aplikasi yang terdaftar akan ditambahkan ke:

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

Untuk mendaftarkan aplikasi di Apigee:

1. Akses halaman Aplikasi.
• Jika Anda menggunakan UI Apigee di Cloud Console: Pilih Distribution > Apps.
• Jika Anda menggunakan UI Apigee klasik: Pilih Publish > Apps.
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 digunakan dalam panggilan Apigee API.	Diperlukan
   Nama Tampilan	Nama tampilan untuk aplikasi yang muncul di UI Apigee dan portal developer.	Opsional
   Developer	Pilih nama developer dari menu drop-down. Catatan: Karena alasan performa, tidak semua developer ditampilkan di menu drop-down. Mulailah mengetik nama atau email developer di kotak penelusuran, dan nilai drop-down akan secara otomatis disempurnakan agar sesuai dengan teks yang Anda ketik. Lihat juga Mendaftarkan developer aplikasi.	Diperlukan
   URL callback	Biasanya menentukan URL aplikasi yang ditetapkan untuk menerima kode otorisasi atas nama aplikasi klien. Nilai ini tidak diperlukan untuk semua produk API.	Opsional
   Notes	Catatan deskriptif untuk aplikasi.	Opsional

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

   Kolom	Deskripsi
   Kedaluwarsa	Konfigurasi durasi atau tanggal habis masa berlaku, atau setel kunci API agar tidak pernah habis masa berlakunya, lalu klik OK.
   Produk	Kaitkan satu atau beberapa produk API dengan kunci API: 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 tersebut untuk menambahkan lebih banyak produk API.

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

Jika produk API yang Anda kaitkan dengan aplikasi memerlukan persetujuan manual untuk kunci API-nya, setujui kunci API tersebut, seperti yang dijelaskan dalam Menyetujui atau mencabut kunci API.

Melihat aplikasi yang terdaftar untuk developer

Untuk melihat aplikasi yang terdaftar bagi developer tertentu, gunakan salah satu metode berikut:

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

Melihat dan mengedit aplikasi

Catatan: Sebelum mengedit atribut khusus, pastikan tidak ada dependensi sistem pada setelan atribut yang sudah ada.

Apigee menyimpan entity berikut dalam cache selama minimal 180 detik setelah entity diakses.

• Token akses OAuth. Artinya, elemen ExpiresIn pada kebijakan OAuth v2 tidak akan dapat membuat masa berlaku token akses berakhir dalam waktu kurang dari 180 detik.
• Entitas Key Management Service (KMS) (Aplikasi, Developer, Produk API).
• Atribut khusus pada token OAuth dan entitas KMS.

Untuk melihat dan mengedit aplikasi:

1. Akses halaman Aplikasi.
2. Klik di mana saja pada 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:
   • Mengubah detail aplikasi, termasuk nama, URL callback, atau catatan.
   • Kelola kredensial.
   • Tambahkan atau hapus atribut khusus. Jumlah maksimum atribut khusus yang dapat Anda tambahkan adalah 18.
   • Menyetujui atau mencabut aplikasi.
5. Klik Simpan.

Mengelola kredensial

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

Seperti yang disorot pada gambar sebelumnya, di bagian Kredensial, Anda dapat melakukan tugas berikut menggunakan UI:

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

Untuk menggunakan API guna mengelola kredensial, lihat Mengimpor kunci dan rahasia konsumen yang ada.

Catatan: Saat membuat produk API, Anda juga dapat menetapkan tingkat aksesnya ke Khusus internal atau Pribadi. Produk API yang ditandai sebagai Khusus internal atau Pribadi tidak ditampilkan kepada developer di portal developer. Untuk mendapatkan akses ke produk ini, Anda harus menambahkannya secara manual ke aplikasi developer dari Apigee API.

Melihat kunci dan rahasia API

Untuk melihat kunci dan rahasia API:

1. Akses halaman Aplikasi.
2. Klik di baris aplikasi yang ingin Anda lihat kunci dan rahasia API-nya.
3. Di bagian Credentials, klik Show yang terkait dengan kunci atau rahasia API yang ingin Anda lihat.

Menyetujui atau mencabut kunci API

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

Anda dapat mengonfigurasi produk API untuk persetujuan otomatis kunci API, seperti yang dijelaskan dalam Mengelola produk API. Namun, jika produk API memerlukan persetujuan manual untuk kunci API, Anda perlu menyetujui kunci tersebut secara manual.

Anda dapat mencabut kunci API untuk semua atau satu produk API. Dalam hal ini, kunci dan rahasia API tidak valid serta tidak dapat digunakan untuk mengakses API di produk API terkait. Anda dapat menyetujui kembali kunci API kapan saja.

Untuk menyetujui atau mencabut kunci API:

1. Akses halaman Aplikasi.
2. Klik baris aplikasi yang ingin dilihat dan diedit.
3. Klik Edit.
4. Lakukan salah satu 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 untuk produk API tertentu, pilih Approved atau Declared di kolom Status untuk produk API tersebut.
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 baris aplikasi yang ingin dilihat dan diedit.
3. Klik Edit.
4. Lakukan salah satu 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, di bagian Kredensial, klik Add product, lalu pilih produk API dari menu drop-down.
5. Klik Simpan.

Menghapus produk API dari aplikasi

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

1. Akses halaman Aplikasi.
2. Klik baris aplikasi yang ingin dilihat dan diedit.
3. Klik Edit.
4. Klik di sebelah produk API.
5. Klik Simpan.

Anda dapat menambahkan kembali produk yang dihapus.

Membuat kredensial baru

Anda dapat membuat kredensial baru untuk aplikasi. Misalnya, jika menggunakan rotasi kunci API, Anda dapat membuat kunci baru yang masa berlakunya tumpang-tindih dengan kunci, yang akan berada di luar rotasi saat masa berlaku kunci tersebut berakhir. Anda juga dapat membuat kunci/rahasia baru jika keamanan kunci/rahasia asli disusupi. Jika Anda membuat kunci baru, kunci API yang ada akan terus berfungsi hingga masa berlakunya habis atau Anda mencabutnya secara eksplisit.

Untuk membuat kunci API baru:

1. Akses halaman Aplikasi.
2. Klik baris aplikasi yang ingin dilihat dan diedit.
3. Klik Edit.
4. Di bagian Credentials, klik .
5. Tentukan masa berlaku, tambahkan produk API, dan tetapkan statusnya.
6. Jika perlu, revoke kunci API lainnya, jika perlu.
7. Klik Simpan.

Menyetujui atau mencabut aplikasi

Catatan: Anda dapat menyetujui atau mencabut aplikasi yang terkait dengan pengguna tertentu, seperti yang dijelaskan di Mengelola pengguna portal

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

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

Untuk menyetujui atau mencabut aplikasi:

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

Menghapus aplikasi

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

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

Untuk menghapus aplikasi:

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

Catatan: Dengan Apigee, penghapusan aplikasi developer dan artefak terkait terjadi secara asinkron. Aplikasi developer akan langsung dihapus, tetapi resource yang terkait dengan aplikasi developer tersebut, seperti kunci aplikasi atau token akses, dapat dihapus dalam beberapa detik hingga beberapa menit.

Mendaftarkan aplikasi dan mengelola kunci API menggunakan API

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

• API Apps
• API aplikasi developer
• API kunci aplikasi developer

Lihat juga Mengimpor kunci dan rahasia konsumen yang ada.