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

আপনি Apigee Edge-এর ডকুমেন্টেশন দেখছেন।
Apigee X ডকুমেন্টেশন .info- তে যান।

কী

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

নমুনা

<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}

এপিআই কী যাচাইকরণ নীতি সম্পর্কে

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

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

এপিআই কী (API key) অথেনটিকেশন টোকেন হিসেবে ব্যবহার করা যায়, অথবা এটি ব্যবহার করে OAuth অ্যাক্সেস টোকেনও পাওয়া যায়। OAuth-এ, এপিআই কী-কে 'ক্লায়েন্ট আইডি' বলা হয়। এই নাম দুটি একে অপরের পরিবর্তে ব্যবহার করা যায়। আরও তথ্যের জন্য OAuth হোম দেখুন।

'Verify API Key' পলিসিটি কার্যকর করার সময় Edge স্বয়ংক্রিয়ভাবে এক সেট ফ্লো ভেরিয়েবল পূরণ করে। আরও তথ্যের জন্য নিচে 'Flow variables' দেখুন।

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

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

<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 key) থাকে। সাধারণত, ক্লায়েন্ট একটি কোয়েরি প্যারামিটার, এইচটিটিপি হেডার বা ফর্ম প্যারামিটারের মাধ্যমে এপিআই কী পাঠিয়ে থাকে। উদাহরণস্বরূপ, যদি 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 কী-এর উপর 'ভেরিফাই এপিআই কী' পলিসি প্রয়োগ করা হয়, তখন Edge এক সেট ফ্লো ভ্যারিয়েবল তৈরি করে। এই ভ্যারিয়েবলগুলো ফ্লো-এর পরবর্তী পর্যায়ে এক্সিকিউট হওয়া পলিসি বা কোডের জন্য উপলব্ধ থাকে এবং প্রায়শই এপিআই কী-এর অ্যাট্রিবিউট, যেমন অ্যাপের নাম, কী-টিকে অথরাইজ করতে ব্যবহৃত এপিআই প্রোডাক্ট, বা এপিআই কী-এর নিজস্ব অ্যাট্রিবিউটের উপর ভিত্তি করে কাস্টম প্রসেসিং করার জন্য ব্যবহৃত হয়।

নীতিমালাটি বিভিন্ন ধরনের প্রবাহ চলক পূরণ করে, যার মধ্যে রয়েছে:

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

প্রতিটি ধরণের ফ্লো ভেরিয়েবলের একটি ভিন্ন প্রিফিক্স থাকে। বিশেষভাবে অ্যারে হিসাবে নির্দেশিত ভেরিয়েবলগুলি ছাড়া বাকি সব ভেরিয়েবলই স্কেলার।

সাধারণ প্রবাহ চলক

নিম্নলিখিত সারণীতে ভেরিফাই এপিআই কী পলিসি দ্বারা পূরণ করা সাধারণ ফ্লো ভেরিয়েবলগুলো তালিকাভুক্ত করা হয়েছে। এই ভেরিয়েবলগুলোর সবগুলোর শুরুতে নিম্নলিখিত উপসর্গটি রয়েছে:

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

উপলব্ধ ভেরিয়েবলগুলো হলো:

কোম্পানির প্রবাহ ভেরিয়েবল

কোম্পানি সম্পর্কিত তথ্য ধারণকারী নিম্নলিখিত ফ্লো ভেরিয়েবলগুলো পলিসি দ্বারা পূরণ করা হয়। এই ভেরিয়েবলগুলোর সবগুলোর শুরুতে একটি উপসর্গ (prefix) যুক্ত থাকে:

verifyapikey.{policy_name}.company

উদাহরণস্বরূপ:

verifyapikey.{policy_name}.company.name

উপলব্ধ ভেরিয়েবলগুলো হলো:

অ্যানালিটিক্স ভেরিয়েবল

যখন একটি বৈধ 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>

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