درحال مشاهده اسناد Apigee Edge هستید.
به
اسناد Apigee X بروید. اطلاعات
کلید میانای برنامه‌سازی کاربردی (در Apigee Edge به‌عنوان کلید مصرف‌کننده شناخته می‌شود) مقدار رشته‌ای است که برنامه کارخواه به پراکسی‌های میانای برنامه‌سازی کاربردی شما منتقل می‌کند. این کلید برنامه مشتری را به‌صورت یکتا شناسایی می‌کند.
اعتبارسنجی کلید میانای برنامه‌سازی کاربردی ساده‌ترین شکل امنیت مبتنی بر برنامه است که می‌توانید برای یک میانای برنامه‌سازی کاربردی پیکربندی کنید. برنامه مشتری به‌سادگی کلید API را با درخواست خود ارائه می‌دهد، سپس Apigee Edge بررسی می‌کند که آیا کلید API در وضعیت تأییدشده برای منبع درخواستی قرار دارد یا خیر. درون‌سازمانی، کارگزاران شما از خط‌مشی‌ها برای تأیید اصالت کلید API استفاده می‌کنند.
برای پشتیبانی از این سادگی، باید کمی راه‌اندازی انجام دهید. برای پشتیبانی از کلیدهای میانای برنامه‌سازی کاربردی، باید: این کارها را انجام دهید:
- محصول Apigee Edge API را ایجاد کنید که پراکسی‌های API را که می‌خواهید بااستفاده از کلید API محافظت کنید دسته‌بندی می‌کند.
-
برنامه توسعه‌دهنده Apigee Edge بسازید که نشان‌دهنده توسعه‌دهنده برنامه مشتری باشد
که برنامه او را اصالت‌سنجی خواهید کرد.
هنگام ایجاد برنامه توسعه‌دهنده، محصولات میانای برنامه‌سازی کاربردی را که برنامه توسعه‌دهنده به آن‌ها دسترسی خواهد داشت و برای آن‌ها باید کلید میانای برنامه‌سازی کاربردی ارائه دهد مشخص می‌کنید.
- به پراکسی‌هایتان (پراکسی‌هایی که در محصول میانای برنامه‌سازی کاربردی خودتان گنجانده‌اید)، خط‌مشی‌هایی اضافه کنید تا تأیید کنید که کلید میانای برنامه‌سازی کاربردی ورودی معتبر است.
آموزش گام‌به‌گام ایمن کردن میانای برنامه‌سازی کاربردی با الزامی کردن کلیدهای میانای برنامه‌سازی کاربردی روشی سریع برای یادگیری نحوه کنترل دسترسی به پراکسی میانای برنامه‌سازی کاربردی با کلید میانای برنامه‌سازی کاربردی است.
نحوه عملکرد کلیدهای میانای برنامه‌سازی کاربردی
در Apigee Edge، کلید API به‌عنوان کلید مصرف‌کننده نامیده می‌شود. وقتی برنامه‌های توسعه‌دهنده را ثبت می‌کنید، Apigee Edge کلید و رمز مصرف‌کننده تولید می‌کند. Apigee Edge کلید مصرف‌کننده را برای اعتبارسنجی‌های آتی ذخیره می‌کند. هر کلید مصرف‌کننده در سازمان منحصربه‌فرد است. توسعه‌دهنده برنامه کلید مصرف‌کننده را در برنامه کارخواه جاسازی می‌کند. برنامه کارخواه باید کلید مصرف‌کننده را برای هر درخواست ارائه دهد. «خدمات API» کلید مصرف‌کننده را قبل‌از اجازه دادن به درخواست برنامه درستی‌سنجی می‌کند.
مراحل سطح بالا
مراحل زیر نحوه استفاده Apigee Edge از کلیدهای API را شرح می‌دهد. این مراحل شامل حضور احتمالی امنیت OAuth نیز می‌شود، زیرا اغلب همراه با کلیدهای API استفاده می‌شود.
- محصول میانای برنامه‌سازی کاربردی ایجاد کنید که شامل پراکسی‌های میانای برنامه‌سازی کاربردی باشد که باید با کلید میانای برنامه‌سازی کاربردی محافظت شوند.
- در سازمانتان برنامه توسعه‌دهنده را ثبت می‌کنید. وقتی این کار را انجام می‌دهید، Apigee Edge کلید مصرف‌کننده و رمز مصرف‌کننده تولید می‌کند.
- برنامه توسعه‌دهنده را با حداقل یک محصول API مرتبط کنید. این محصول مسیرهای منبع و پراکسی‌های API را با تأیید کلید مرتبط می‌کند.
- در زمان اجرا، وقتی برنامه کارخواه درخواستی به API شما ارسال می‌کند، برنامه کارخواه هنگام ارسال درخواست کلید مصرف‌کننده را ارسال می‌کند. در عمل، کلید مصرف‌کننده ممکن است
به‌صورت صریح منتقل شود یا ممکن است به‌طور ضمنی ازطریق یک رمز OAuth به آن اشاره شود:
- وقتی API از درستی‌سنجی کلید API استفاده می‌کند -- مثلاً با پیاده‌سازی خط‌مشی VerifyAPIKey -- برنامه کارخواه باید کلید مصرف‌کننده را به‌طور صریح ارسال کند.
- وقتی API از درستی‌سنجی کد OAuth استفاده می‌کند -- مثلاً با پیاده‌سازی خط‌مشی OAuthV2 -- برنامه کارخواه باید کدی را ارسال کند که از کلید مصرف‌کننده مشتق شده است.
- کارگزاری API اعتبارنامه‌های درخواست را ازطریق خط‌مشی VerifyAPIKey یا خط‌مشی OAuthV2 با عملیات VerifyAccessToken اعتبارسنجی می‌کند. اگر خط‌مشی اجرای اطلاعات اعتباری را در «پراکسی میانای برنامه‌سازی کاربردی» خودتان اضافه نکنید، هر تماس‌گیرنده‌ای می‌تواند میاناهای برنامه‌سازی کاربردی شما را باموفقیت فراخوانی کند. برای اطلاعات بیشتر، خط‌مشی «تأیید کلید API» را ببینید.
درحال درستی‌سنجی اطلاعات اعتباری درخواست
این یک نمای کلی است. برای جزئیات و نمونه‌های کد، حتماً راه‌اندازی اعتبارسنجی کلید API را ببینید.
- اگر از درستی‌سنجی کد OAuth استفاده می‌کنید -- خط‌مشی OAuth را برای درستی‌سنجی پیاده‌سازی کرده‌اید
و برنامه کارخواه کد OAuth را ارسال کرده است:
- Apigee Edge بررسی می‌کند که کد منقضی نشده باشد، و سپس کلید مصرف‌کننده را که برای تولید کد استفاده شده است جستجو می‌کند.
- اگر از کلید API استفاده می‌کنید -- خط‌مشی VerifyAPIKey را پیاده‌سازی کرده‌اید و برنامه کارخواه
کلید مصرف‌کننده خود را ارسال کرده است:
- Apigee Edge فهرست «محصولات API» را که کلید مصرف‌کننده با آن‌ها مرتبط شده است بررسی می‌کند.
- Edge هر «محصول میانای برنامه‌سازی کاربردی» را بررسی می‌کند تا ببیند آیا «پراکسی میانای برنامه‌سازی کاربردی» کنونی در «محصول میانای برنامه‌سازی کاربردی» گنجانده شده است یا نه و آیا مسیر منبع کنونی (مسیر نشانی وب) در «محصول میانای برنامه‌سازی کاربردی» فعال است یا نه.
- Edge همچنین بررسی می‌کند که کلید مصرف‌کننده منقضی یا باطل نشده باشد، بررسی می‌کند که برنامه باطل نشده باشد، و بررسی می‌کند که توسعه‌دهنده غیرفعال نباشد.
- اگر همه این موارد درست باشد -- رمز منقضی نشده باشد (درصورت لزوم)، کلید مصرف‌کننده معتبر و تأییدشده باشد، برنامه تأییدشده باشد، توسعه‌دهنده فعال باشد، پراکسی در محصول دردسترس باشد، و منبع در محصول دردسترس باشد -- درستی‌سنجی اطلاعات اعتباری موفقیت‌آمیز خواهد بود.