Mendaftarkan aplikasi dan mengelola kunci API

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X. info

Daftarkan aplikasi dan kelola kunci API, seperti yang dijelaskan di bagian berikut.

Pengantar

Pendaftaran aplikasi menyediakan mekanisme utama untuk mengontrol siapa yang dapat mengakses API Anda.

Sebagai penyedia API, Anda membuat satu atau beberapa produk API untuk memaketkan API, seperti yang dijelaskan dalam Mengelola produk API. Saat mendaftarkan aplikasi, developer aplikasi memilih produk API yang akan digunakan dan Edge menyediakan satu kunci API yang dapat digunakan developer untuk mengakses produk API tersebut. Developer aplikasi meneruskan 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 membuat portal dan memublikasikan produk API dijelaskan di Membuat portal.

Atau, sebagai penyedia API, Anda mungkin menginginkan kontrol lebih besar atas proses pendaftaran aplikasi dan memilih untuk mendaftarkan aplikasi di Edge, seperti yang dijelaskan di bagian berikut. Misalnya, Anda mungkin ingin mendaftarkan aplikasi untuk tim pengembangan internal atau atas nama developer tanpa akses ke portal Anda.

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

Menjelajahi halaman Aplikasi

Akses dan jelajahi halaman Aplikasi, seperti yang dijelaskan di bawah.

Mendaftarkan aplikasi

Aplikasi dapat didaftarkan menggunakan salah satu metode berikut:

• Developer aplikasi dapat mendaftarkan aplikasi melalui portal Anda, seperti yang dijelaskan dalam Cara developer aplikasi berinteraksi dengan portal Anda.
• Anda dapat mendaftarkan aplikasi di Edge, seperti yang dijelaskan di bawah. Anda dapat menentukan cara memberikan kunci kepada developer aplikasi.

Aplikasi terdaftar ditambahkan ke:

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

Untuk mendaftarkan aplikasi di Edge:

1. Akses halaman Aplikasi.
2. Klik + Aplikasi.
3. Tentukan Detail Aplikasi:

   Kolom	Deskripsi	Wajib?
   Nama	Nama aplikasi. Anda tidak dapat mengubah nama setelah aplikasi dibuat. Nama ini digunakan dalam panggilan API pengelolaan.	Ya
   Nama Tampilan	Nama tampilan untuk aplikasi yang muncul di UI pengelolaan Edge dan portal developer.	Tidak
   Perusahaan/Developer	Catatan: Apigee hybrid tidak mendukung aplikasi perusahaan; kolom ini tidak berlaku. Pilih Perusahaan atau Developer, lalu pilih nama perusahaan atau developer dari drop-down. Catatan: Untuk alasan performa, tidak semua perusahaan atau developer ditampilkan di menu drop-down. Mulai ketik nama perusahaan atau nama developer atau email di kotak penelusuran. Lihat juga Mendaftarkan developer aplikasi.	Ya
   URL Callback	Biasanya menentukan URL aplikasi yang ditetapkan untuk menerima kode otorisasi atas nama aplikasi klien. Nilai ini tidak diperlukan untuk semua produk API.	Tidak
   Catatan	Catatan deskriptif untuk aplikasi.	Tidak

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

   Kolom	Deskripsi
   Kedaluwarsa	Konfigurasikan durasi atau tanggal habis masa berlaku, atau tetapkan 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 untuk menambahkan produk API lainnya.

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

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 untuk developer tertentu, gunakan salah satu metode berikut:

• Lihat semua aplikasi 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

Untuk melihat dan mengedit aplikasi:

1. Akses halaman Aplikasi.
2. Klik di baris aplikasi yang ingin Anda lihat dan edit.
   Detail aplikasi akan ditampilkan.
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 tambahkan adalah 18.
   • Setujui atau cabut aplikasi.
5. Klik Simpan.

Mengelola kredensial

Saat mengedit aplikasi, Anda dapat mengelola kredensialnya di bagian Kredensial, seperti yang ditunjukkan pada gambar berikut:

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

• Melihat kunci dan secret API
• 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 bagian berikut:

• Mengelola kunci konsumen untuk aplikasi
• Mengimpor kunci dan secret konsumen yang ada

Melihat kunci API dan secret

Untuk melihat kunci API dan secret:

1. Akses halaman Aplikasi.
2. Klik di baris aplikasi yang kunci API dan secret-nya ingin Anda lihat.
3. Di bagian Kredensial, klik Tampilkan 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. Edge 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 persetujuan kunci API secara otomatis, seperti yang dijelaskan dalam Mengelola produk API. Namun, jika produk API memerlukan persetujuan kunci API secara manual, Anda harus menyetujui kunci tersebut secara manual.

Anda dapat mencabut kunci API untuk semua atau satu produk API. Dalam hal ini, kunci dan secret API tidak valid dan tidak dapat digunakan untuk mengakses API di produk API terkait. Anda dapat menyetujui ulang 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 tugas berikut:
   • Untuk menyetujui atau mencabut kunci API untuk semua produk API yang terkait dengan kunci API, pilih Disetujui atau Dibatalkan yang terkait dengan kunci API.
   • Untuk menyetujui atau mencabut kunci API untuk produk API tertentu, pilih Disetujui atau Dicabut di kolom Status untuk produk API.
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. Akses halaman 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 untuk membuat kredensial baru, pilih masa berlaku, lalu tambahkan produk API ke kunci API.
   • Untuk menambahkan produk API ke kunci API yang ada, di bagian Kredensial, klik Tambahkan produk dan pilih produk API dari menu drop-down.
5. Klik Simpan.

Menghapus produk API dari aplikasi

Jika ingin tetap mengaktifkan kunci API, tetapi tidak mengizinkannya digunakan oleh produk 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 di samping 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 keluar dari rotasi saat masa berlakunya habis. 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 di baris aplikasi yang ingin Anda lihat dan edit.
3. Klik Edit.
4. Di bagian Credentials, klik .
5. Tentukan tanggal habis masa berlaku, tambahkan produk API, dan tetapkan statusnya.
6. Secara opsional, cabut kunci API lainnya, sesuai kebutuhan.
7. Klik Simpan.

Menyetujui atau mencabut aplikasi

Setujui atau cabut aplikasi, seperti yang dijelaskan di bawah. Saat Anda mencabut aplikasi, kunci API yang disetujui tidak dapat lagi digunakan dalam panggilan API ke Edge. 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. 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.
5. Klik Simpan.

Menghapus aplikasi

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

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

Untuk menghapus aplikasi:

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

Catatan: Dengan Apigee Edge untuk Cloud Publik, 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 secara otomatis.

Mendaftarkan aplikasi dan mengelola kunci API menggunakan API

Untuk mendaftarkan dan mengelola aplikasi menggunakan API, lihat Mendaftarkan aplikasi developer. Lihat juga bagian berikut dalam dokumentasi referensi API:

• Aplikasi
• Aplikasi: Perusahaan
• Aplikasi: Developer
• Kunci Aplikasi Perusahaan
• Kunci Aplikasi Developer

Lihat juga Mengimpor kunci dan secret konsumen yang ada.