سیاست VerifyAPIKey

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

چی

خط‌مشی Verify API Key به شما امکان می‌دهد تأیید کلیدهای API را در زمان اجرا اجرا کنید و فقط برنامه‌هایی که دارای کلیدهای API تأیید شده هستند به API‌های شما دسترسی داشته باشند. این خط‌مشی تضمین می‌کند که کلیدهای API معتبر هستند، باطل نشده‌اند، و برای مصرف منابع خاص مرتبط با محصولات API شما تأیید شده‌اند.

نمونه ها

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

curl http://myorg-test.apigee.net/mocktarget?apikey=IEYRtW2cb7A5Gs54A1wKElECBL65GVls

<VerifyAPIKey name="APIKeyVerifier">
    <APIKey ref="request.header.x-apikey" />
</VerifyAPIKey>

curl "http://myorg-test.apigee.net/mocktarget" -H "x-apikey:IEYRtW2cb7A5Gs54A1wKElECBL65GVls"

<VerifyAPIKey name="APIKeyVerifier">
    <APIKey ref="requestAPIKey.key"/>
</VerifyAPIKey>

<ExtractVariables async="false" continueOnError="false" enabled="true" name="SetAPIKeyVar">
    <Source>request</Source>
    <QueryParam name="myKey">
        <Pattern ignoreCase="true">{key}</Pattern>
    </QueryParam>
    <VariablePrefix>requestAPIKey</VariablePrefix>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</ExtractVariables>

<AssignMessage async="false" continueOnError="false" enabled="true" name="accessverifyvars">
    <AssignVariable>
        <Name>devFirstName</Name>
        <Ref>verifyapikey.verify-api-key.developer.firstName</Ref>
        <Value>ErrorOnCopy</Value>
    </AssignVariable>
    <AssignVariable>
        <Name>devLastName</Name>
        <Ref>verifyapikey.verify-api-key.developer.lastName</Ref>
        <Value>ErrorOnCopy</Value>
    </AssignVariable>
    <AssignVariable>
        <Name>devEmail</Name>
        <Ref>verifyapikey.verify-api-key.developer.email</Ref>
        <Value>ErrorOnCopy</Value>
    </AssignVariable>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

verifyapikey.{policy_name}

درباره سیاست Verify API Key

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

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

از کلیدهای API می توان به عنوان نشانه های احراز هویت استفاده کرد، یا می توان از آنها برای به دست آوردن نشانه های دسترسی OAuth استفاده کرد. در OAuth از کلیدهای API به عنوان "شناسه مشتری" یاد می شود. نام ها را می توان به جای هم استفاده کرد. برای اطلاعات بیشتر به صفحه اصلی OAuth مراجعه کنید.

Edge به طور خودکار مجموعه ای از متغیرهای جریان را هنگام اجرای سیاست Verify API Key پر می کند. برای اطلاعات بیشتر به متغیرهای جریان زیر مراجعه کنید.

مرجع عنصر

در زیر عناصر و ویژگی هایی وجود دارد که می توانید در این خط مشی پیکربندی کنید:

<VerifyAPIKey async="false" continueOnError="false" enabled="true" name="Verify-API-Key-1">
    <DisplayName>Custom label used in UI</DisplayName>
    <APIKey ref="variable_containing_api_key"/>
</VerifyAPIKey>

ویژگی های <VerifyAPIKey>

مثال زیر ویژگی های تگ <VerifyAPIKey> را نشان می دهد:

<VerifyAPIKey async="false" continueOnError="false" enabled="true" name="Verify-API-Key-1">

جدول زیر ویژگی هایی را توصیف می کند که برای همه عناصر اصلی خط مشی مشترک هستند:

عنصر <DisplayName>

علاوه بر ویژگی name برای برچسب‌گذاری خط‌مشی در ویرایشگر پروکسی رابط کاربری مدیریت با نامی متفاوت و به زبان طبیعی، از آن استفاده کنید.

<DisplayName>Policy Display Name</DisplayName>

عنصر <APIKey>

این عنصر متغیر جریانی را که حاوی کلید API است را مشخص می کند. به طور معمول، کلاینت کلید API را در یک پارامتر پرس و جو، هدر HTTP یا یک پارامتر فرم ارسال می کند. به عنوان مثال، اگر کلید در یک هدر به نام x-apikey ارسال شود، کلید در متغیر: request.header.x-apikey یافت می شود.

صفات

جدول زیر ویژگی های عنصر <APIKey> را شرح می دهد

نمونه ها

در این مثال‌ها، کلید در پارامترها و هدری به نام x-apikey ارسال می‌شود.

به عنوان پارامتر پرس و جو:

<VerifyAPIKey name="APIKeyVerifier">
    <APIKey ref="request.queryparam.x-apikey"/>
</VerifyAPIKey>

به عنوان هدر HTTP:

<VerifyAPIKey name="APIKeyVerifier">
    <APIKey ref="request.header.x-apikey"/>
</VerifyAPIKey>

به عنوان پارامتر فرم HTTP:

<VerifyAPIKey name="APIKeyVerifier">
    <APIKey ref="request.formparam.x-apikey"/>
</VerifyAPIKey>

طرحواره ها

متغیرهای جریان

وقتی یک خط‌مشی Verify API Key روی یک کلید API معتبر اعمال می‌شود، Edge مجموعه‌ای از متغیرهای جریان را پر می‌کند. این متغیرها برای خط‌مشی‌ها یا کدهایی که بعداً در جریان اجرا می‌شوند در دسترس هستند و اغلب برای انجام پردازش سفارشی بر اساس ویژگی‌های کلید API مانند نام برنامه، محصول API مورد استفاده برای تأیید کلید یا ویژگی‌های سفارشی API استفاده می‌شوند. کلید

این خط مشی انواع مختلفی از متغیرهای جریان را پر می کند، از جمله:

• ژنرال
• برنامه
• توسعه دهنده
• شرکت
• تجزیه و تحلیل

هر نوع متغیر جریان دارای پیشوند متفاوتی است. همه متغیرها اسکالر هستند به جز آنهایی که به طور خاص به عنوان آرایه نشان داده شده اند.

متغیرهای جریان عمومی

جدول زیر متغیرهای جریان عمومی را که توسط سیاست Verify API Key پر شده اند فهرست می کند. این متغیرها همه با پیشوند زیر هستند:

verifyapikey.{policy_name}

به عنوان مثال: verifyapikey.{policy_name}.client_id

متغیرهای موجود عبارتند از:

متغیرهای جریان برنامه

متغیرهای جریان زیر حاوی اطلاعات مربوط به برنامه توسط خط مشی پر شده است. این متغیرها همه با پیشوند زیر هستند:

verifyapikey.{policy_name}.app .

به عنوان مثال:

verifyapikey.{policy_name}.app.name

متغیرهای موجود عبارتند از:

متغیرهای جریان توسعه دهنده

متغیرهای جریان زیر حاوی اطلاعات مربوط به توسعه‌دهنده توسط خط‌مشی پر شده‌اند. این متغیرها همه با پیشوند زیر هستند:

verifyapikey.{policy_name}.developer

به عنوان مثال:

verifyapikey.{policy_name}.developer.id

متغیرهای موجود عبارتند از:

متغیرهای جریان شرکت

متغیرهای جریان زیر که حاوی اطلاعات مربوط به شرکت هستند توسط این خط مشی تکمیل می شوند. این متغیرها همه با پیشوند زیر هستند:

verifyapikey.{policy_name}.company

به عنوان مثال:

verifyapikey.{policy_name}.company.name

متغیرهای موجود عبارتند از:

متغیرهای تجزیه و تحلیل

هنگامی که یک خط‌مشی Verify API Key برای یک کلید API معتبر اجرا می‌شود، متغیرهای زیر به‌طور خودکار در Analytics پر می‌شوند. این متغیرها فقط با خط‌مشی Verify API Key و سیاست‌های OAuth پر می‌شوند.

متغیرها و مقادیر را می‌توان به‌عنوان ابعاد برای ساختن گزارش‌های Analytics استفاده کرد تا الگوهای مصرف توسط توسعه‌دهندگان و برنامه‌ها دیده شود.

• apiproduct.name
• developer.app.name
• client_id
• developer.id

مرجع خطا

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Example error responses

{  
   "fault":{  
      "faultstring":"Invalid ApiKey",
      "detail":{  
         "errorcode":"oauth.v2.InvalidApiKey"
      }
   }
}

{  
   "fault":{  
      "detail":{  
         "errorcode":"keymanagement.service.DeveloperStatusNotActive"
      },
      "faultstring":"Developer Status is not Active"
   }
}

Example fault rule

<FaultRule name="FailedToResolveAPIKey">
    <Step>
        <Name>AM-FailedToResolveAPIKey</Name>
    </Step>
    <Condition>(fault.name Matches "FailedToResolveAPIKey") </Condition>
</FaultRule>

موضوعات مرتبط