APIKey নীতি যাচাই করুন

আপনি Apigee Edge ডকুমেন্টেশন দেখছেন।
Apigee X ডকুমেন্টেশনে যান । তথ্য

কি

যাচাই API কী নীতি আপনাকে রানটাইমে 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}

যাচাই API কী নীতি সম্পর্কে

যখন একজন বিকাশকারী এজ-এ একটি অ্যাপ নিবন্ধন করেন, তখন এজ স্বয়ংক্রিয়ভাবে একটি ভোক্তা কী এবং গোপন জোড়া তৈরি করে। আপনি এজ UI-তে অ্যাপের ভোক্তা কী এবং গোপন জুটি দেখতে পারেন বা এজ API থেকে সেগুলি অ্যাক্সেস করতে পারেন।

অ্যাপ রেজিস্ট্রেশনের সময়, ডেভেলপার অ্যাপটির সাথে যুক্ত করার জন্য এক বা একাধিক API পণ্য নির্বাচন করে, যেখানে একটি API পণ্য হল API প্রক্সির মাধ্যমে অ্যাক্সেসযোগ্য সম্পদের একটি সংগ্রহ। বিকাশকারী তারপরে অ্যাপের সাথে যুক্ত একটি API পণ্যে API-কে প্রতিটি অনুরোধের অংশ হিসাবে API কী (ভোক্তা কী) পাস করে। আরো জন্য প্রকাশনা ওভারভিউ দেখুন.

API কীগুলি প্রমাণীকরণ টোকেন হিসাবে ব্যবহার করা যেতে পারে, অথবা সেগুলি OAuth অ্যাক্সেস টোকেনগুলি পেতে ব্যবহার করা যেতে পারে। OAuth-এ, API কীগুলিকে "ক্লায়েন্ট আইডি" হিসাবে উল্লেখ করা হয়। নামগুলি বিনিময়যোগ্যভাবে ব্যবহার করা যেতে পারে। আরও জানতে OAuth হোম দেখুন।

যাচাই API কী নীতি নির্বাহ করার সময় এজ স্বয়ংক্রিয়ভাবে ফ্লো ভেরিয়েবলের একটি সেট তৈরি করে। আরও জন্য নীচে ফ্লো ভেরিয়েবল দেখুন.

উপাদান রেফারেন্স

নিম্নলিখিত উপাদান এবং বৈশিষ্ট্যগুলি আপনি এই নীতিতে কনফিগার করতে পারেন:

<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> উপাদান

ম্যানেজমেন্ট UI প্রক্সি এডিটরে নীতিটিকে একটি ভিন্ন, প্রাকৃতিক-ভাষা নামের সাথে লেবেল করতে name বৈশিষ্ট্য ছাড়াও ব্যবহার করুন।

<DisplayName>Policy Display Name</DisplayName>

<APIKey> উপাদান

এই উপাদানটি ফ্লো ভেরিয়েবল নির্দিষ্ট করে যেটিতে API কী রয়েছে। সাধারণত, ক্লায়েন্ট একটি ক্যোয়ারী প্যারামিটার, HTTP হেডার বা একটি ফর্ম প্যারামিটারে API কী পাঠায়। উদাহরণস্বরূপ, যদি 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>

স্কিমাস

ফ্লো ভেরিয়েবল

যখন একটি যাচাই API কী নীতি একটি বৈধ API কীতে প্রয়োগ করা হয়, তখন এজ ফ্লো ভেরিয়েবলের একটি সেট তৈরি করে। এই ভেরিয়েবলগুলি প্রবাহের পরে কার্যকর করা নীতি বা কোডের জন্য উপলব্ধ, এবং প্রায়শই API কী-এর বৈশিষ্ট্য যেমন অ্যাপের নাম, কী অনুমোদন করতে ব্যবহৃত API পণ্য বা API-এর কাস্টম বৈশিষ্ট্যের উপর ভিত্তি করে কাস্টম প্রক্রিয়াকরণ করতে ব্যবহৃত হয়। চাবি

নীতিটি বিভিন্ন ধরনের ফ্লো ভেরিয়েবলকে অন্তর্ভুক্ত করে, যার মধ্যে রয়েছে:

• সাধারণ
• অ্যাপ
• বিকাশকারী
• কোম্পানি
• বিশ্লেষণ

প্রতিটি ধরনের ফ্লো ভেরিয়েবলের আলাদা উপসর্গ রয়েছে। সমস্ত ভেরিয়েবলই স্কেলার ব্যতীত বিশেষভাবে অ্যারে হিসাবে নির্দেশিত।

সাধারণ প্রবাহ ভেরিয়েবল

নিম্নলিখিত সারণীটি যাচাই API কী নীতি দ্বারা পপুলেট সাধারণ প্রবাহ ভেরিয়েবলের তালিকা করে। এই ভেরিয়েবলগুলি সমস্ত দ্বারা উপসর্গযুক্ত:

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

উপলব্ধ ভেরিয়েবলগুলির মধ্যে রয়েছে:

বিশ্লেষণ ভেরিয়েবল

নিম্নলিখিত ভেরিয়েবলগুলি অ্যানালিটিক্সে স্বয়ংক্রিয়ভাবে জমা হয় যখন একটি বৈধ API কী-এর জন্য একটি যাচাই API কী নীতি প্রয়োগ করা হয়। এই ভেরিয়েবলগুলি শুধুমাত্র যাচাই API কী নীতি এবং OAuth নীতির দ্বারা পপুলেট করা হয়৷

ভেরিয়েবল এবং মানগুলিকে অ্যানালিটিক্স রিপোর্ট তৈরি করার জন্য মাত্রা হিসাবে ব্যবহার করা যেতে পারে যাতে ডেভেলপার এবং অ্যাপগুলির দ্বারা খরচের ধরণগুলিতে দৃশ্যমানতা লাভ করা যায়।

• apiproduct.name
• বিকাশকারী.অ্যাপ.নাম
• ক্লায়েন্ট_আইডি
• বিকাশকারী.আইডি

ত্রুটি উল্লেখ

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>

সম্পর্কিত বিষয়