راه‌اندازی اعتبارسنجی کلید میانای برنامه‌سازی کاربردی

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

می‌توانید با پیوست کردن خط‌مشی از نوع «تأیید کلید میانای برنامه‌سازی کاربردی»، اعتبارسنجی کلید میانای برنامه‌سازی کاربردی را برای میانای برنامه‌سازی کاربردی راه‌اندازی کنید. تنها تنظیم الزامی برای خط‌مشی «تأیید کلید میانای برنامه‌سازی کاربردی» مکان موردانتظار کلید میانای برنامه‌سازی کاربردی در درخواست کارخواه است. کارگزار نیابتی میانای برنامه‌سازی کاربردی مکان مشخص‌شده را بررسی می‌کند و کلید میانای برنامه‌سازی کاربردی را استخراج می‌کند. اگر کلید API در مکان موردانتظار وجود نداشته باشد، خطا ایجاد می‌شود و درخواست رد می‌شود. کلیدهای API را می‌توان در پارامتر پُرسمان، پارامتر فرم، یا سرایند HTTP پیدا کرد.

برای مثال، پیکربندی خط‌مشی زیر مکان کلید موردانتظار را به‌عنوان پارامتر پُرسمانی با نام apikey تعریف می‌کند. درخواست موفق باید کلید API را به‌عنوان یک پارامتر پُرسمان که به درخواست پیوست شده است ارائه دهد، برای مثال،?apikey=Y7yeiuhcbKJHD790.

برای درستی‌سنجی کلیدهای میانای API، خط‌مشی زیر را ایجاد کنید:

<VerifyAPIKey name="APIKeyValidation">
  <APIKey ref="request.queryparam.apikey"/>
</VerifyAPIKey>

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

مستندات جامع این نوع خط‌مشی را می‌توانید در موضوع مرجع خط‌مشی، خط‌مشی «تأیید کلید API»پیدا کنید.

پراکسی‌های API به‌طور خودکار همه سرایندهای HTTP و پارامترهای پُرسمان موجود در درخواست را بازارسال می‌کنند. بنابراین، پس‌از تأیید کلید API، بهتر است آن را از پیام جدا کنید تا کلید API ازطریق سیم به سرویس زیرینه ارسال نشود. می‌توانید این کار را بااستفاده از خط‌مشی نوع AssignMessage به‌صورت زیر انجام دهید:

<AssignMessage name="StripApiKey">
    <DisplayName>Remove Query Param</DisplayName>
    <Remove>
        <QueryParams>
            <QueryParam name="apikey"/>
        </QueryParams>
    </Remove>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"></AssignTo>
</AssignMessage>

پیوست خط‌مشی

خط‌مشی‌ها باید به‌عنوان «مراحل» پردازش به «جریان» پراکسی API پیوست شوند. با اعمال خط‌مشی بر درخواست PreFlow، کلیدهای API در هر درخواست دریافتی توسط پراکسی API از یک برنامه کارخواه درستی‌سنجی می‌شوند. پس‌از درستی‌سنجی، کلید API از درخواست خروجی حذف می‌شود.

خط‌مشی‌ها را به ProxyEndpoint میانای برنامه‌سازی کاربردی که باید محافظت شود به‌صورت زیر پیوست کنید:

<ProxyEndpoint name="default">
  <PreFlow>
    <Request>
      <Step><Name>APIKeyValidation</Name></Step>
      <Step><Name>StripApiKey</Name></Step>
    </Request>
  </PreFlow>

پس‌از پیوست کردن خط‌مشی، پراکسی API را مستقر کنید.

ارسال درخواست با کلید API معتبر

به‌عنوان سرپرست در سازمانتان، می‌توانید کلید API هر برنامه‌ای را به این روش بازیابی کنید:

$ curl https://api.enterprise.apigee.com/v1/o/{myorg}/developers/{developer_email}/apps/{app_name} -u email:password 

نمایه برنامه‌ای که برای این تماس برگردانده می‌شود کلید مصرف‌کننده (کلید API) و رمز را ارائه می‌دهد. مقدار کلید مصرف‌کننده مقداری است که برای کلید API در درخواست خود به API محافظت‌شده استفاده می‌کنید.

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

$ curl http://{org_name}-test.apigee.net/weather/forecastrss?w=12797282

پیام خطا نشان می‌دهد که خط‌مشی کلید میانای برنامه‌سازی کاربردی را بررسی کرده است اما کلید معتبری پیدا نکرده است: کلید:

OAuth Failure : Could not resolve the app key with variable request.queryparam.apikey

وقتی کلید مصرف‌کننده برای برنامه به‌عنوان پارامتر پُرسمان اضافه می‌شود، نتیجه موردانتظار این است: مجوز موفقیت‌آمیز:

$ curl http://{org_name}-test.apigee.net/weather/forecastrss?w=12797282&"apikey=PulSCqMnXGchW0pC0s5o9ngHVTWMeLqk"

نتیجه موردانتظار، پاسخ موفقیت‌آمیز از سرویس آب‌وهوا است.

تغییر مقدار کلید API در درخواست منجر به خطای مجوز می‌شود:

$ curl http://{org_name}-test.apigee.net/weather?forecastrss?w=12797282&"apikey=PulSCqMnXGchW0"

نتایج در:

OAuth Failure : Consumer Key is Invalid

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

$ curl https://api.enterprise.apigee.com/v1/o/{myorg}/developers/{developer_email}/apps/{app_name} -u email:password