Kunci API (dikenal di Apigee sebagai kunci konsumen) adalah nilai string yang diteruskan
oleh aplikasi klien ke proxy API Anda. Kunci mengidentifikasi aplikasi klien secara unik.
Validasi kunci API adalah bentuk keamanan berbasis aplikasi paling sederhana yang dapat Anda konfigurasi untuk
API. Aplikasi klien cukup menyajikan kunci API bersama permintaannya, lalu Apigee memeriksa untuk melihat
apakah kunci API berada dalam status yang disetujui untuk resource yang diminta. Secara internal, proxy Anda menggunakan kebijakan untuk memverifikasi keaslian kunci API.
Untuk mendukung kesederhanaan ini, Anda perlu melakukan sedikit penyiapan. Untuk mendukung kunci API, Anda perlu:
Buat produk API Apigee yang menggabungkan proxy API yang ingin Anda
lindungi menggunakan kunci API.
Buat aplikasi developer Apigee yang mewakili developer aplikasi klien
yang aplikasinya akan Anda autentikasi.
Saat membuat aplikasi developer, Anda menentukan produk API yang akan diakses oleh aplikasi developer -- dan yang akan memerlukan kunci API.
Untuk proxy Anda (yang disertakan dalam produk API), tambahkan kebijakan
untuk memverifikasi bahwa kunci API yang masuk valid.
Di Apigee, kunci API disebut sebagai kunci konsumen. Saat Anda mendaftarkan aplikasi developer,
Apigee akan membuat kunci dan rahasia konsumen. Apigee menyimpan kunci konsumen untuk validasi di masa mendatang. Setiap kunci konsumen bersifat unik dalam organisasi. Developer aplikasi menyematkan
kunci konsumen di aplikasi klien. Aplikasi klien harus memberikan kunci konsumen untuk setiap permintaan.
Layanan API memverifikasi kunci konsumen sebelum mengizinkan permintaan aplikasi.
Langkah-langkah tingkat tinggi
Langkah-langkah berikut menjelaskan cara kunci API digunakan oleh Apigee. Langkah-langkah ini juga mencakup kemungkinan kehadiran keamanan OAuth, karena sering digunakan bersama dengan kunci API.
Buat produk API yang menyertakan proxy API yang harus dilindungi
dengan kunci API.
Anda mendaftarkan aplikasi developer di organisasi Anda. Saat Anda melakukannya, Apigee akan membuat kunci konsumen dan rahasia konsumen.
Kaitkan aplikasi developer dengan setidaknya satu produk API. Produk ini
mengaitkan jalur resource dan proxy API dengan persetujuan kunci.
Saat runtime, ketika aplikasi klien membuat permintaan ke API Anda, aplikasi klien akan mengirimkan
kunci konsumen saat membuat permintaan. Dalam praktiknya, kunci konsumen dapat
diteruskan secara eksplisit atau dirujuk secara implisit melalui token OAuth:
Jika API menggunakan verifikasi kunci API -- seperti dengan menerapkan kebijakan VerifyAPIKey
-- aplikasi klien harus meneruskan kunci konsumen secara eksplisit.
Saat API menggunakan verifikasi token OAuth -- seperti dengan menerapkan kebijakan OAuthV2
-- aplikasi klien harus meneruskan token yang telah diperoleh dari kunci
konsumen.
Proxy API memvalidasi kredensial permintaan melalui
kebijakan VerifyAPIKey atau kebijakan OAuthV2 dengan operasi VerifyAccessToken. Jika Anda tidak
menyertakan kebijakan penerapan kredensial di Proxy API, pemanggil mana pun dapat berhasil memanggil
API Anda. Untuk mengetahui informasi selengkapnya, lihat
Kebijakan Verifikasi Kunci API.
Jika Anda menggunakan verifikasi token OAuth -- Anda telah menerapkan kebijakan OAuth untuk memverifikasi
dan aplikasi klien telah meneruskan token OAuth:
Apigee memverifikasi bahwa token belum habis masa berlakunya, lalu mencari kunci konsumen
yang digunakan untuk membuat token.
Jika Anda menggunakan kunci API -- Anda telah menerapkan kebijakan VerifyAPIKey dan aplikasi klien
telah meneruskan kunci konsumennya:
Apigee memeriksa daftar Produk API yang terkait dengan kunci konsumen.
Apigee memeriksa setiap Produk API untuk melihat apakah Proxy API saat ini disertakan dalam Produk API, dan apakah jalur resource (jalur URL) saat ini diaktifkan di Produk API.
Apigee juga memverifikasi bahwa kunci konsumen belum habis masa berlakunya atau dicabut, memeriksa bahwa aplikasi tidak dicabut, dan memeriksa bahwa developer tidak aktif.
Jika semua hal tersebut benar -- masa berlaku token belum berakhir (jika berlaku), kunci konsumen valid dan disetujui, aplikasi disetujui, developer aktif, proxy
tersedia di produk, dan resource tersedia di produk -- verifikasi kredensial
berhasil.
[[["Mudah dipahami","easyToUnderstand","thumb-up"],["Memecahkan masalah saya","solvedMyProblem","thumb-up"],["Lainnya","otherUp","thumb-up"]],[["Sulit dipahami","hardToUnderstand","thumb-down"],["Informasi atau kode contoh salah","incorrectInformationOrSampleCode","thumb-down"],["Informasi/contoh yang saya butuhkan tidak ada","missingTheInformationSamplesINeed","thumb-down"],["Masalah terjemahan","translationIssue","thumb-down"],["Lainnya","otherDown","thumb-down"]],["Terakhir diperbarui pada 2025-09-05 UTC."],[[["\u003cp\u003eAPI keys, also known as consumer keys, uniquely identify client apps in Apigee and are used for a simple form of app-based security.\u003c/p\u003e\n"],["\u003cp\u003eTo implement API key validation, you must create an API product bundling the desired API proxies and a developer app representing the client app to be authenticated.\u003c/p\u003e\n"],["\u003cp\u003eClient apps present the API key with each request, and Apigee proxies utilize policies to verify the key's authenticity and approved status.\u003c/p\u003e\n"],["\u003cp\u003eAt runtime, requests from client apps include the consumer key, either directly or via an OAuth token derived from the consumer key, which is then validated by the API Proxy.\u003c/p\u003e\n"],["\u003cp\u003eApigee verifies that the API key is associated with an appropriate API Product, not expired or revoked, and that the corresponding app and developer are active, as well as that the requested resource is available.\u003c/p\u003e\n"]]],[],null,["# API keys\n\n*This page\napplies to **Apigee** and **Apigee hybrid**.*\n\n\n*View [Apigee Edge](https://docs.apigee.com/api-platform/get-started/what-apigee-edge) documentation.*\n\nAn *API key* (known in Apigee as a *consumer key*) is a string value passed\nby a client app to your API proxies. The key uniquely identifies the client app.\n\nAPI key validation is the simplest form of app-based security that you can configure for an\nAPI. A client app simply presents an API key with its request, then Apigee checks to see\nthat the API key is in an approved state for the resource being requested. Internally, your\nproxies use policies to verify API key authenticity.\n\nTo support this simplicity, you'll need to do a bit of setup. To support API keys, you'll need\nto:\n\n- **Create an Apigee API product** that bundles the API proxies you want to protect using the API key.\n- **Create an Apigee developer app** that represents the client app developer whose app you'll be authenticating.\n\n In creating the developer app, you specify API products the developer's app will have\n access to -- and for which it will need to provide an API key.\n- To your proxies (the ones you included in your API product), **add policies** to verify that an incoming API key is valid.\n\nThe [Secure an API by\nrequiring API keys](/apigee/docs/api-platform/tutorials/secure-calls-your-api-through-api-key-validation) tutorial is a quick way to learn how to control access to an API proxy\nwith an API key.\n| **Note:** The security associated with API keys is limited. Because API keys can easily be extracted from app code and used to access an API, they work better as unique app identifiers, rather than security tokens. If you're looking for a way to implement security, be sure to see [OAuth home](/apigee/docs/api-platform/security/oauth/oauth-home).\n| **Note:** API keys go by many names. You may see them referred to as app keys, developer app keys, consumer keys, or client IDs.\n| **Sample:** A working sample API proxy that enforces API key validation is available in the [API Platform\n| Samples](https://github.com/apigee/api-platform-samples) available on GitHub. You can use the sample API proxy to secure your own API. Locate the API proxy found under `/sample-proxies/apikey`. Modify the TargetEndpoint configuration to point to your URL. Then deploy.\n\nHow API keys work\n-----------------\n\nIn Apigee, an API key is referred to as a consumer key. When you register developer apps,\nApigee generates a consumer key and secret. Apigee stores the consumer key for future\nvalidation. Each consumer key is unique in the organization. The app developer embeds the\nconsumer key in the client app. The client app must present the consumer key for each request.\nAPI Services verifies the consumer key before permitting the app's request.\n\n### High-level steps\n\nThe following steps describe how API keys are used by Apigee. These steps include the\npossible presence of OAuth security as well, since it is often used in conjunction with API\nkeys.\n\n1. **Create an API product** that includes API proxies that should be protected with the API key.\n2. You **register a developer app** in your organization. When you do Apigee generates a consumer key and a consumer secret.\n3. **Associate the developer app with at least one API product**. It is the product that associates resource paths and API proxies with key approval.\n4. At run time, when the client app makes a request to your API, the **client app sends\n the consumer key when making the request** . In practice, the consumer key might be either passed explicitly or it might be implicitly referred to via an OAuth token:\n - When the API uses API key verification -- such as by implementing a VerifyAPIKey policy -- the client app must pass the consumer key explicitly.\n - When the API uses OAuth token verification -- such as by implementing an OAuthV2 policy -- the client app must pass a token that has been *derived from* the consumer key.\n5. The **API Proxy validates the request** credentials through either a VerifyAPIKey policy or an OAuthV2 policy with a VerifyAccessToken operation. If you do not include a credential enforcement policy in your API Proxy, any caller can successfully invoke your APIs. For more information, see [Verify API Key\n policy](/apigee/docs/api-platform/reference/policies/verify-api-key-policy).\n\n### Verifying request credentials\n\nThis is an overview. Be sure to see\n[Setting up API key\nvalidation](/apigee/docs/api-platform/security/setting-api-key-validation) for\ndetails and code examples.\n\n1. If you're using OAuth token verification -- you've implemented an OAuth policy to verify and the client app has passed an OAuth token:\n - Apigee verifies that the token is not expired, and then looks up the consumer key that was used to generate the token.\n2. If you're using an API key -- you've implemented a VerifyAPIKey policy and the client app has passed its consumer key:\n 1. Apigee checks the list of API Products with which the consumer key has been associated.\n 2. Apigee checks each API Product to see if the current API Proxy is included in the API Product, and if the current resource path (url path) is enabled on the API Product.\n 3. Apigee also verifies that the consumer key is not expired or revoked, checks that the app is not revoked, and checks that the developer is not inactive.\n 4. If all of those things are true -- the token is not expired (if applicable), the consumer key is valid and approved, the app is approved, the developer is active, the proxy is available in the product, and the resource is available on the product -- the credential verification succeeds."]]
