OAuth 2.0: پیکربندی یک پروکسی API جدید

شما در حال مشاهده مستندات Apigee Edge هستید.
به مستندات Apigee X مراجعه کنید . اطلاعات

اگر از نسخه Apigee Cloud مرورگر Edge استفاده می‌کنید، خواهید دید که یک پروکسی به نام oauth به طور پیش‌فرض در سازمان شما گنجانده شده است. این پروکسی دو نقطه پایانی نمونه برای تولید توکن‌های دسترسی و به‌روزرسانی ارائه می‌دهد. اگر می‌خواهید در مورد نقاط پایانی توکن OAuth بیشتر بدانید، به بخش «درک نقاط پایانی OAuth» مراجعه کنید.

نوع اعطای اعتبارنامه‌ی کلاینت، رویه‌ای را برای صدور توکن‌های دسترسی در ازای اعتبارنامه‌های برنامه تعریف می‌کند. این اعتبارنامه‌های برنامه، جفت کلید مصرف‌کننده و رمز هستند که Apigee Edge برای هر برنامه‌ای که در یک سازمان ثبت شده است، صادر می‌کند. برای جزئیات بیشتر، به پیاده‌سازی نوع اعطای کد مجوز مراجعه کنید.

اضافه کردن OAuth 2.0 به یک پروکسی API جدید

شما می‌توانید به راحتی هنگام ایجاد یک پروکسی API جدید، تأیید OAuth را به یک API اضافه کنید.

لبه

برای افزودن تأیید OAuth به API با استفاده از رابط کاربری Edge:

  1. وارد apigee.com/edge شوید.
  2. در نوار ناوبری سمت چپ، گزینه‌ی Develop > API Proxies را انتخاب کنید.
  3. کلیک + پروکسی
  4. برای ایجاد یک پروکسی معکوس از ویزارد Create Proxy استفاده کنید. به بخش Build a simple API proxy مراجعه کنید.
  5. در صفحه‌ی «خط‌مشی‌های مشترک» در ویزارد، دکمه‌ی رادیویی کنار OAuth v2.0 را انتخاب کنید.

لبه کلاسیک (ابر خصوصی)

برای افزودن تأیید OAuth به API با استفاده از رابط کاربری کلاسیک اج:

  1. وارد آدرس http:// ms-ip :9000 شوید، که در آن ms-ip آدرس IP یا نام DNS گره سرور مدیریت است.
  2. در نوار پیمایش بالا، APIها > API Proxies را انتخاب کنید.
  3. کلیک + پروکسی API
  4. برای ایجاد یک پروکسی معکوس از ویزارد Create Proxy استفاده کنید. به بخش Build a simple API proxy مراجعه کنید.
  5. در صفحه امنیت ویزارد، دکمه رادیویی کنار OAuth v2.0 را انتخاب کنید.

وقتی این گزینه را انتخاب می‌کنید، دو سیاست به پروکسی API تازه ایجاد شده پیوست می‌شوند، یکی برای تأیید توکن‌های دسترسی و دیگری برای حذف توکن دسترسی پس از تأیید آن.

توجه داشته باشید که گزینه انتشار محصول API قابل انتخاب می‌شود و به طور خودکار انتخاب می‌شود. اگر می‌خواهید هنگام ساخت پروکسی API جدید، به طور خودکار محصولی تولید شود، این گزینه را علامت بزنید. محصول تولید شده خودکار با ارتباط با پروکسی API جدید ایجاد می‌شود. اگر محصولی از قبل دارید که می‌خواهید این API جدید را به آن مرتبط کنید، حتماً این گزینه را بردارید تا محصولی غیرضروری ایجاد نکنید. برای اطلاعات بیشتر در مورد محصولات، به «محصول API چیست؟» مراجعه کنید.

کار با پروکسی پیش‌فرض OAuth

پروکسی oauth آدرس URL نقطه پایانی زیر را نمایش می‌دهد:

/oauth/client_credential/accesstoken

این URI را برای توسعه‌دهندگانی که نیاز به دریافت توکن‌های دسترسی دارند منتشر کنید. توسعه‌دهندگان برنامه، برنامه‌های خود را برای فراخوانی این نقطه پایانی پیکربندی می‌کنند و جفت‌های کلید مصرف‌کننده و رمز خود را برای دریافت توکن‌های دسترسی ارائه می‌دهند.

نقطه پایانی توکن اعتبارنامه‌های پیش‌فرض کلاینت از طریق شبکه و در آدرس اینترنتی زیر در معرض نمایش قرار می‌گیرد:

https://{org_name}-{env_name}.apigee.net/oauth/client_credential/accesstoken

برای مثال، اگر نام سازمان شما "apimakers" باشد، آدرس اینترنتی (URL) به صورت زیر خواهد بود:

https://apimakers-test.apigee.net/oauth/client_credential/accesstoken

این URL ای است که توسعه دهندگان برای دریافت توکن های دسترسی فراخوانی می کنند.

فراخوانی API

وقتی توکن دسترسی را دریافت کردید، می‌توانید API را با یک هدر مجوز و توکن حامل، مانند این فراخوانی کنید:

curl -H "Authorization: Bearer <your access token>" http://myorg-myenv.apigee.net/myapi

همچنین به تأیید توکن‌های دسترسی مراجعه کنید.