एपीआई पासकोड की पुष्टि सेट अप की जा रही है

आपको Apigee Edge दस्तावेज़ दिख रहा है.
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है इस पेज पर जाएं Apigee X दस्तावेज़. जानकारी

किसी एपीआई के लिए, एपीआई पासकोड की पुष्टि करने की सुविधा सेट अप की जा सकती है. इसके लिए, 'एपीआई पासकोड की पुष्टि करें' टाइप की नीति अटैच की जा सकती है. कॉन्टेंट बनाने 'एपीआई पासकोड की पुष्टि करें' नीति के लिए सिर्फ़ ज़रूरी सेटिंग, एपीआई पासकोड की अनुमानित जगह क्लाइंट अनुरोध. एपीआई प्रॉक्सी आपकी बताई गई जगह की जांच करेगा और एपीआई पासकोड को एक्सट्रैक्ट करेगा. अगर एपीआई पासकोड अनुमानित जगह पर मौजूद नहीं है, तो एक गड़बड़ी होती है और अनुरोध किया जाता है अस्वीकार कर दिया गया है. एपीआई पासकोड किसी क्वेरी पैरामीटर, फ़ॉर्म पैरामीटर या एचटीटीपी में मौजूद हो सकते हैं हेडर.

उदाहरण के लिए, नीचे दिया गया नीति कॉन्फ़िगरेशन, क्वेरी के तौर पर अनुमानित कुंजी की जगह के बारे में बताता है apikey नाम वाला पैरामीटर. अनुरोध पूरा होने पर, एपीआई पासकोड को क्वेरी के तौर पर दिखाना चाहिए पैरामीटर को अनुरोध में जोड़ा गया है, उदाहरण के लिए,?apikey=Y7yeiuhcbKJHD790.

एपीआई पासकोड की पुष्टि करने के लिए, यह नीति बनाएं:

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

इस नीति को ऐसे किसी भी एपीआई के साथ अटैच किया जा सकता है जिसे आपको सुरक्षित रखना है.

इस तरह की नीति के बारे में पूरी जानकारी वाले दस्तावेज़, नीति के रेफ़रंस वाले विषय में मिल सकते हैं, एपीआई पासकोड की पुष्टि करें नीति पढ़ें.

एपीआई प्रॉक्सी, मौजूद सभी एचटीटीपी हेडर और क्वेरी पैरामीटर को अपने-आप पास कर देते हैं अनुरोध पर. इसलिए, एपीआई पासकोड की पुष्टि होने के बाद, उसे मैसेज भेज सकता है, ताकि एपीआई कुंजी बैकएंड सेवा को वायर के ज़रिए न भेजी जाए. आप ऐसा कर सकते हैं इसका तरीका बताएं:

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

नीति अटैचमेंट

प्रोसेस करने के चरणों के तौर पर, नीतियों को एपीआई प्रॉक्सी फ़्लो से अटैच किया जाना चाहिए. नीति लागू करने का मतलब है PreFlow के अनुरोध के लिए, एपीआई प्रॉक्सी को क्लाइंट ऐप्लिकेशन में मिलेगा. पुष्टि होने के बाद, आउटबाउंड अनुरोध से एपीआई पासकोड को हटा दिया जाता है.

नीचे बताए गए तरीके का इस्तेमाल करके, एपीआई प्रॉक्सी के ProxyEndpoint में नीतियों को अटैच करें:

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

नीति को अटैच करने के बाद, एपीआई प्रॉक्सी को डिप्लॉय करें.

मान्य एपीआई पासकोड के साथ अनुरोध सबमिट करना

अपने संगठन के एडमिन के तौर पर, आपके पास किसी भी ऐप्लिकेशन के एपीआई पासकोड को वापस लाने का विकल्प होता है. इसके लिए, यह तरीका अपनाएं:

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

इस कॉल के लिए जो ऐप्लिकेशन प्रोफ़ाइल दिखती है वह उपभोक्ता कुंजी (एपीआई पासकोड) और सीक्रेट उपलब्ध कराती है. उपभोक्ता कुंजी की वैल्यू वह वैल्यू होती है जिसका इस्तेमाल, एपीआई पासकोड के लिए किया जाता है. एपीआई.

उदाहरण के लिए, अगर किसी अनुरोध में एपीआई पासकोड शामिल नहीं किया जाता है, तो उसके लिए अनुमति ली जा सकती है अपलोड नहीं किया जा सका.

$ 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"

उम्मीद के मुताबिक नतीजा, मौसम की जानकारी देने वाली सेवा से मिला जवाब है.

अनुरोध के नतीजों में, एपीआई पासकोड की वैल्यू में बदलाव करने से अनुमति मिल जाती है विफलता:

$ 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