بخش 2: یک کلید API را تولید و آزمایش کنید

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

با درخواست کلیدهای API، به منظور ایمن‌سازی یک API، ریفکتور و ریدایرکت شد.

یک توسعه‌دهنده برنامه‌ای می‌سازد که برای دسترسی به سرویس‌های backend شما، درخواست‌هایی را به APIهای شما ارسال می‌کند. برای کنترل دسترسی به APIهای خود، می‌توانید از توسعه‌دهنده بخواهید که در هر درخواست، یک کلید API ارسال کند. اگر کلید مفقود یا نامعتبر باشد، درخواست با شکست مواجه می‌شود.

انتشار، فرآیندی است که طی آن API های شما برای استفاده در اختیار توسعه دهندگان برنامه قرار می‌گیرد. انتشار API ها را می‌توان به طور کلی با وظایف زیر تعریف کرد:

  1. محصولات API را در Apigee Edge ایجاد کنید که API های شما را بسته بندی می کنند.
  2. ثبت نام توسعه دهندگان برنامه در Edge. فقط یک توسعه دهنده برنامه ثبت شده می تواند یک برنامه را ثبت کند.
  3. توسعه‌دهندگان برای دسترسی به محصولات API، برنامه‌ها را در Edge ثبت می‌کنند. در پاسخ، توسعه‌دهنده یک کلید API دریافت می‌کند. اکنون که توسعه‌دهنده یک کلید API دارد، می‌تواند درخواست‌هایی را به APIهای شما ارسال کند.

برای اطلاعات بیشتر، به مقدمه‌ای بر نشر مراجعه کنید.

جدول زیر برخی از اصطلاحات مورد استفاده برای ثبت برنامه‌ها و تولید کلیدها را تعریف می‌کند:

مدت تعریف
محصول API مجموعه‌ای از پروکسی‌های API به همراه یک طرح خدماتی که محدودیت‌هایی را برای دسترسی به آن APIها تعیین می‌کند. محصولات API سازوکار اصلی هستند که Apigee Edge برای مجوزدهی و کنترل دسترسی به APIهای شما از آنها استفاده می‌کند.
توسعه‌دهنده مصرف‌کننده API. توسعه‌دهندگان برنامه‌هایی می‌نویسند که به APIهای شما درخواست ارسال می‌کنند.
برنامه یک برنامه سمت کلاینت که یک توسعه‌دهنده برای دسترسی به یک محصول API ثبت می‌کند. ثبت برنامه با محصول API، کلید API را برای دسترسی به APIهای موجود در آن محصول ایجاد می‌کند.
کلید API رشته‌ای حاوی اطلاعات مجوز که یک برنامه سمت کلاینت برای دسترسی به منابع در معرض محصول API از آن استفاده می‌کند. کلید API زمانی ایجاد می‌شود که یک برنامه ثبت‌شده با یک محصول API مرتبط شود.

پیش‌نیازهای این آموزش

این آموزش فرض می‌کند که شما آموزش اول را که در آن یک پروکسی API برای دسترسی به API آب و هوای یاهو ایجاد می‌کنید، تکمیل کرده‌اید. اگر هنوز آموزش اول را تکمیل نکرده‌اید، به بخش «ایمن‌سازی API با درخواست کلیدهای API» مراجعه کنید.

مرحله ۱: ایجاد یک محصول API

  1. در رابط کاربری مدیریت، روی برگه انتشار و سپس محصولات کلیک کنید.
  2. روی (+) محصول کلیک کنید.
  3. موارد زیر را در فیلدهای گفتگوی افزودن محصول وارد یا انتخاب کنید:
    میدان ارزش
    نام محصول API رایگان
    نام نمایشی محصول API رایگان
    توضیحات محصول API رایگان
    محیط زیست آزمون
    دسترسی فقط داخلی
    نوع تأیید کلید خودکار
    (کلید API پس از تولید به طور خودکار تأیید می‌شود)
    سهمیه ۱۰ درخواست در هر ۱ ساعت
    (تعداد درخواست‌ها به 10 درخواست در ساعت محدود می‌شود)
    محدوده‌های مجاز OAuth خالی بگذارید

    کادر محاوره‌ای تکمیل‌شده باید به شکل زیر باشد:

  4. در بخش منابع، موارد زیر را انتخاب کنید:
    • پروکسی API : weatherapikey
    • ویرایش : ۱
    • مسیر منبع : /forecastrss**

      مسیر منبع ، URI های منبعی را مشخص می‌کند که محصول به یک برنامه اجازه دسترسی به آنها را می‌دهد. در این مثال، یک برنامه فقط می‌تواند از طریق این محصول API به منبع /forecastrss در پروکسی weatherapikey دسترسی داشته باشد. تلاش برای دسترسی به هر منبع دیگری در پروکسی weatherapiproxy یا هر پروکسی دیگری با استفاده از این محصول API ممنوع است.

      کاراکترهای Wildcard برای مسیر منبع مجاز هستند. علامت "/**" نشان می‌دهد که همه زیر-URIها شامل می‌شوند، به این معنی که منبعی به شکل /forecastrss/foo/bar . علامت "/" نشان می‌دهد که فقط URIهای یک سطح پایین‌تر شامل می‌شوند. برای اطلاعات بیشتر به بخش ایجاد محصولات API مراجعه کنید.

      توجه داشته باشید که لیست کشویی Resource Path تمام جریان‌های شرطی تعریف شده روی پروکسی API مشخص شده را نشان می‌دهد. جریان شرطی یک پروکسی API، منطق یا مراحل پردازش مرتبط با یک مسیر منبع را تعریف می‌کند. یک محصول API دسترسی به آن مسیرهای منبع را کنترل می‌کند.
  5. روی وارد کردن منبع کلیک کنید. مسیر منبع اضافه می‌شود و پروکسی API مربوط به weatherapikey به طور خودکار به بخش پروکسی‌های API برای محصول اضافه می‌شود.
  6. روی ذخیره کلیک کنید. محصول جدید شما در صفحه محصولات فهرست شده است.

بیشتر بدانید:

مرحله ۲: ثبت نام توسعه دهنده

برای تولید کلید API، شما یک برنامه را ثبت می‌کنید و آن را به یک محصول API مرتبط می‌کنید. با این حال، نمی‌توانید بدون ثبت نام توسعه‌دهنده برنامه، برنامه‌ای را ثبت کنید.

  1. در رابط کاربری مدیریت، روی برگه انتشار و سپس توسعه‌دهندگان کلیک کنید.
  2. روی (+) توسعه‌دهنده کلیک کنید.
  3. در پنجره‌ی «توسعه‌دهنده‌ی جدید»، مقادیر زیر را وارد کنید:
    • نام : جین
    • نام خانوادگی : معلم
    • آدرس ایمیل : janetutorial@example.com
    • نام کاربری : jtutorial
  4. روی ذخیره کلیک کنید. توسعه‌دهنده جدید در فهرست توسعه‌دهندگان در صفحه توسعه‌دهندگان ظاهر می‌شود.

بیشتر بدانید:

مرحله ۳: ثبت برنامه

حالا که یک محصول API و یک توسعه‌دهنده دارید، می‌توانید یک برنامه را با محصول API ثبت کنید. ثبت برنامه، کلید API را برای محصولات API مرتبط با برنامه ایجاد می‌کند. سپس می‌توانید این کلید را بین توسعه‌دهندگان برنامه توزیع کنید تا آنها بتوانند از طریق برنامه به ویژگی‌های محصولات API دسترسی پیدا کنند.

  1. در رابط کاربری پلتفرم API، روی تب Publish و سپس Developer Apps کلیک کنید.
  2. روی (+) برنامه توسعه‌دهنده کلیک کنید.
  3. در پنجره‌ی «افزودن برنامه»، مقادیر زیر را وارد کنید:
    • نام نمایشی : برنامه کلید API آب و هوا
    • توسعه‌دهنده : جین تیچر (janetutorial@example.com)
    • آدرس اینترنتی پاسخ به تماس : خالی بگذارید
  4. مرتبط کردن برنامه با یک محصول:
    1. در بخش محصولات ، روی + محصول کلیک کنید.
    2. محصول API رایگان را انتخاب کنید.
    3. برای پذیرش تغییرات، روی نماد علامت تیک کلیک کنید.
  5. روی ذخیره کلیک کنید. برنامه جدید در لیست برنامه‌ها در صفحه برنامه‌های توسعه‌دهنده ظاهر می‌شود.
  6. در لیست برنامه‌ها، Weather API Key App را انتخاب کنید. این کار صفحه جزئیات برنامه را باز می‌کند.
  7. از آنجا که هنگام ایجاد محصول API، نوع تأیید کلید را خودکار انتخاب کرده‌اید، کلید API به طور خودکار تأیید می‌شود و می‌توانید بلافاصله آن را مشاهده کنید. (اگر نوع تأیید را دستی انتخاب کرده باشید، برای تأیید کلید API باید روی تأیید در ستون اقدامات برای محصول API رایگان کلیک کنید.)
  8. در بخش محصولات، در کنار ورودی محصول API رایگان ، روی نمایش در ستون‌های کلید مصرف‌کننده و راز مصرف‌کننده کلیک کنید تا کلیدهای تولید شده نمایش داده شوند.

    کلید مصرف‌کننده نام دیگری برای کلید API است و تنها کلیدی است که یک برنامه برای دسترسی به منبع پیش‌بینی از طریق پروکسی API شما نیاز دارد. راز مصرف‌کننده (همراه با کلید مصرف‌کننده) برای ایمن‌سازی یک API از طریق OAuth 2.0 مورد نیاز است. برای مثال، به OAuth 2.0: پیکربندی یک پروکسی API جدید مراجعه کنید.

بیشتر بدانید:

مرحله ۴: استفاده از کلید API در یک درخواست

برای اطمینان از عملکرد صحیح سیاست VerifyAPIKey، باید آن را با فراخوانی پروکسی API با یک کلید API معتبر آزمایش کنید. می‌توانید پروکسی API را در یک مرورگر، از صفحه Trace پروکسی API، از کنسول Apigee یا با استفاده از cURL درخواست کنید. URL مورد نظر برای درخواست به شکل زیر است:

http://{org-name}-test.apigee.net/v1/weatherapikey/forecastrss?w=12797282&apikey=IEYRtW2cb7A5Gs54A1wKElECBL65GVls

نام سازمان Apigee خود را به جای {org-name} و مقدار صحیح apikey قرار دهید.

در پاسخ، به دنبال محتوای زیر باشید:

<rss xmlns:yweather="http://xml.weather.yahoo.com/ns/rss/1.0" xmlns:geo="http://www.w3.org/2003/01/geo/wgs84_pos#" version="2.0"> 
<channel> <title>Yahoo! Weather - Palo Alto, CA</title> 
<link>http://us.rd.yahoo.com/dailynews/rss/weather/Palo_Alto__CA/*http://weather.yahoo.com/forecast/USCA1093_f.html</link> 
<description>Yahoo! Weather for Palo Alto, CA</description> <language>en-us</language>

اگر کلید API را از درخواست حذف کنید، یا مقدار کلید نامعتبری را مشخص کنید، یک پاسخ خطا به شکل زیر دریافت خواهید کرد:

{"fault":{"faultstring":"Failed to resolve API Key variable null","detail":{"errorcode":"steps.oauth.v2.FailedToResolveAPIKey"}}}

مرحله ۵: قدم بعدی کجاست؟

حالا که با استفاده از یک پارامتر کوئری، درخواستی به API ارسال کرده‌اید تا کلید API را ارسال کنید، API را طوری تغییر دهید که کلید را به عنوان هدر ارسال کند.

با درخواست کلیدهای API، به ایمن‌سازی API ادامه دهید.