Mengontrol akses ke API Anda 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 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 Hanya Publik, Pribadi, atau Internal. Untuk mengetahui 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 ada dalam produk API. Kapan saja, Anda dapat mencabut kunci API aplikasi, 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 membuat portal dan memublikasikan produk API Anda dijelaskan di bagian Buat portal Anda.

Anda dapat memiliki kontrol lebih besar atas proses pendaftaran aplikasi dengan mendaftarkan aplikasi menggunakan UI Apigee di Konsol Cloud 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 melihat dan mendaftarkan aplikasi, serta mengelola kunci API di UI Apigee, Anda menggunakan tampilan Aplikasi.

Buka halaman Distribution > Apps di konsol Apigee di Cloud:

Buka 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 berdasarkan nama, developer, ID aplikasi, kunci API konsumen, atau semua konten

Catatan: Seiring bertambahnya jumlah aplikasi secara keseluruhan, latensi waktu pemuatan pada tampilan Aplikasi akan meningkat. Gunakan filter untuk menyaring daftar aplikasi dan meningkatkan waktu pemuatan.

Mendaftarkan aplikasi

Peringatan: Pastikan aplikasi Anda selalu menyertakan setidaknya satu produk API yang di dalamnya ditentukan setidaknya satu jalur resource dan/atau proxy API. 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. Dalam sebagian besar situasi, Anda tidak ingin membuat apa yang disebut kunci kerangka—kunci yang dapat membuka pintu mana pun 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. Anda berhak menentukan cara memberikan kunci kepada developer aplikasi.

Aplikasi terdaftar ditambahkan ke:

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

Untuk mendaftarkan aplikasi di Apigee:

1. Buka halaman Distribusi > Aplikasi:

   Buka Aplikasi

2. Klik Buat.
3. 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.	Wajib
   Nama Tampilan	Nama tampilan untuk aplikasi yang muncul di UI Apigee dan portal developer.	Opsional
   Developer	Pilih nama developer dari drop-down. Catatan: Untuk alasan performa, tidak semua developer ditampilkan di menu drop-down. Mulai ketik nama atau email developer di kotak penelusuran, dan nilai drop-down akan otomatis disesuaikan agar cocok dengan teks yang Anda ketik. Lihat juga Mendaftarkan developer aplikasi.	Wajib
   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
   Catatan	Catatan deskriptif untuk aplikasi.	Opsional

   Catatan: Detail aplikasi juga mencakup ID Aplikasi yang hanya dapat dilihat dan diedit dari API, bukan UI. Lihat REST Resource: organizations.developers.apps.
4. Tentukan Credentials, termasuk status dan masa berlaku kunci API serta produk API terkait. Di bagian Credentials, klik Add credential, lalu masukkan informasi berikut:

   Kolom	Deskripsi
   Kedaluwarsa	Pilih durasi atau tanggal habis masa berlaku, atau tetapkan kunci API agar tidak pernah habis masa berlakunya.
   Produk	Mengaitkan satu atau beberapa produk API dengan kunci API: Klik Tambahkan produk. Pilih satu atau beberapa produk API dari daftar. Catatan: Setidaknya satu produk API harus dipilih. Klik Oke. Klik Tambahkan.

5. Tetapkan Status ke Disetujui atau Dicabut untuk setiap produk API. Jika Anda menambahkan produk API ke kredensial yang memerlukan persetujuan manual, produk tersebut akan menampilkan Pending approval status. Jika tidak, Approved akan ditampilkan. Pada langkah ini, Anda dapat mengubah status persetujuan.
   1. Dari daftar Produk di bagian Kredensial, pilih satu atau beberapa produk dari daftar.
   2. Klik Setujui atau Batalkan.
6. Tentukan Atribut Kustom:
   1. Di bagian Atribut Khusus, klik Tambahkan atribut.
   2. Masukkan nama dan nilai.
   3. Klik Tambahkan atribut. untuk menambahkan atribut lainnya. Jumlah maksimum atribut kustom yang dapat Anda tambahkan adalah 18.
7. Klik Buat.

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

Melihat aplikasi yang terdaftar untuk developer

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

• Untuk melihat semua aplikasi terdaftar, klik Filter, klik Pemilik aplikasi, lalu masukkan nama developer di kolom penelusuran.
• Melihat semua developer aplikasi terdaftar dan mengklik baris yang terkait dengan developer.

Melihat dan mengedit aplikasi

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

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

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

Untuk melihat dan mengedit aplikasi:

1. Buka halaman Distribusi > Aplikasi:

   Buka Aplikasi

2. Klik di mana saja pada baris aplikasi yang ingin Anda lihat dan edit. Apigee menampilkan detail aplikasi.
   Catatan: Aplikasi yang merupakan bagian dari AppGroups juga ditampilkan dalam daftar hasil. Anda dapat melihat detail aplikasi dan menghapus aplikasi AppGroup, tetapi tidak dapat membuat atau mengeditnya dalam tampilan ini. Untuk mengetahui petunjuk tentang mengelola AppGroup dan aplikasi AppGroup, lihat Menggunakan AppGroup untuk mengatur kepemilikan 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 dan produk terkait.
   • Menambahkan atau menghapus atribut khusus. Jumlah maksimum atribut kustom yang dapat Anda tambahkan adalah 18.
   • Menyetujui atau mencabut aplikasi.
5. Klik Simpan.

Mengelola kredensial

Saat mengedit aplikasi, Anda dapat mengelola kredensialnya di bagian Kredensial, tempat Anda dapat melakukan tugas berikut menggunakan UI:

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

Untuk menggunakan API guna mengelola kredensial, lihat Mengimpor kunci dan secret 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 muncul di portal developer. Untuk mengakses produk ini, Anda harus menambahkannya secara manual ke aplikasi developer dari Apigee API.

Melihat kunci dan secret API

Untuk melihat kunci dan secret API:

1. Buka halaman Distribusi > Aplikasi:

   Buka Aplikasi

2. Klik di baris aplikasi yang ingin Anda lihat kunci dan rahasia API-nya.
3. Di bagian Kredensial, klik yang terkait dengan kunci API atau secret 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 ditentukan oleh produk API yang berisi API.

Anda dapat mengonfigurasi produk API untuk menyetujui kunci API secara otomatis, seperti yang dijelaskan dalam Mengelola produk API. Namun, 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 dan rahasia API tidak valid dan 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. Buka halaman Distribusi > Aplikasi:

   Buka Aplikasi

2. Klik di baris aplikasi yang ingin Anda lihat dan edit.
3. Klik Edit.
4. Untuk menyetujui atau mencabut kunci API, pilih Disetujui atau Dicabut di bagian Status untuk kredensial.
5. Klik Simpan.

Mengelola produk API di 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. Buka halaman Distribusi > Aplikasi:

   Buka Aplikasi

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

Mencabut atau menghapus produk API dari kredensial aplikasi

Jika ingin tetap mengaktifkan kunci API, tetapi tidak mengizinkannya digunakan oleh produk API, Anda dapat mencabut atau menghapusnya dari kredensial terkait.

1. Buka halaman Distribusi > Aplikasi:

   Buka Aplikasi

2. Klik di baris aplikasi yang ingin Anda lihat dan edit.
3. Klik Edit.
4. Pilih produk API (atau produk) yang akan dibatalkan atau dihapus dari kredensial.
5. Klik Batalkan atau Hapus.
6. Klik Simpan.

Anda dapat menyetujui kembali produk API yang dicabut atau menambahkan kembali produk API yang 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 keluar dari rotasi saat masa berlakunya berakhir. Anda juga dapat membuat kunci/rahasia baru jika keamanan kunci/rahasia asli terganggu. Jika Anda membuat kunci baru, kunci API yang ada akan terus berfungsi hingga masa berlakunya berakhir atau Anda mencabutnya secara eksplisit.

Untuk membuat kunci API baru:

1. Buka halaman Distribusi > Aplikasi:

   Buka Aplikasi

2. Klik di baris aplikasi yang ingin Anda lihat dan edit.
3. Klik Edit.
4. Di bagian Kredensial, klik Tambahkan kredensial.
5. Tentukan masa berlaku, tambahkan produk API, dan tetapkan statusnya.
6. Secara opsional, cabut kunci API lainnya, sesuai kebutuhan.
7. Klik Simpan.

Menyetujui atau mencabut aplikasi

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

Menyetujui atau mencabut akses aplikasi, seperti yang dijelaskan di bawah. Saat Anda mencabut aplikasi, kunci API yang disetujui tidak dapat lagi digunakan dalam panggilan API ke Apigee. Saat Anda menyetujui ulang 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 dikenali oleh semua pemroses pesan.

Untuk menyetujui atau mencabut aplikasi:

1. Buka halaman Distribusi > Aplikasi:

   Buka 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.
5. Klik Simpan.

Menghapus aplikasi

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

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

Untuk menghapus aplikasi:

1. Buka halaman Distribusi > Aplikasi:

   Buka Aplikasi

2. Posisikan kursor di baris aplikasi yang akan dihapus.
3. Klik Lainnya Hapus di kolom Tindakan.

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

Mendaftarkan aplikasi dan mengelola kunci API menggunakan API

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

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

Lihat juga Mengimpor kunci dan rahasia konsumen yang ada.