Acurl का इस्तेमाल किया जा रहा है

यहां Apigee Edge के दस्तावेज़ देखे जा रहे हैं.
पर जाएं Apigee X दस्तावेज़. info

The acurl(1) यूटिलिटी, स्टैंडर्ड curl कमांड के लिए रैपर की सुविधा देती है. acurl:

  • आपके Apigee क्रेडेंशियल को OAuth2 ऐक्सेस टोकन से बदलता है.
  • यह पता लगाता है कि ऐक्सेस टोकन की समयसीमा कब खत्म हुई है. साथ ही, नया ऐक्सेस टोकन पाने के लिए रीफ़्रेश टोकन का इस्तेमाल करता है.
  • एपीआई अनुरोध के Authorization हेडर में वह टोकन पास करता है.

OAuth2 के साथ Edge API एंडपॉइंट को कॉल करने के लिए, ऐक्सेस टोकन का इस्तेमाल किया जाता है. इसमें एलडीएपी और SAML वर्कफ़्लो शामिल हैं.

अगर Edge API को ऐक्सेस करने के लिए OAuth2 का इस्तेमाल किया जाता है, लेकिन acurl का इस्तेमाल नहीं किया जाता, तो आपको खुद ही ऐक्सेस टोकन पाना होगा और उसे एपीआई के अनुरोध के हेडर में जोड़ना होगा. ऐक्सेस टोकन पाने का एक तरीका, get_token यूटिलिटी का इस्तेमाल करना है.

acurl इंस्टॉल करना

acurl का इस्तेमाल करने से पहले, इसे इंस्टॉल करना ज़रूरी है .

acurl सिंटैक्स

acurl यूटिलिटी, इस सिंटैक्स का इस्तेमाल करती है:

acurl API_URL -u USERNAME:PASSWORD [-m MFACODE]

या

acurl API_URL -p PASSCODE

कहां:

विकल्प ज़रूरी है? जानकारी
API_URL ज़रूरी है Apigee Edge API एंडपॉइंट. एंडपॉइंट की पूरी सूची देखने के लिए, Apigee Edge API का रेफ़रंस देखें.
USERNAME ज़रूरी नहीं. उपयोगकर्ता नाम और पासवर्ड का कॉम्बिनेशन या पासकोड ज़रूरी है. आपका Apigee उपयोगकर्ता नाम. यह आम तौर पर, आपके Apigee खाते से जुड़ा ईमेल पता होता है. get_token को पहली बार कॉल करते समय, आपको अपना उपयोगकर्ता नाम या पासकोड पास करना होगा. ऐक्सेस और रीफ़्रेश टोकन की समयसीमा खत्म होने तक, आपको अपना ईमेल पता फिर से पास नहीं करना होगा. अगर एक से ज़्यादा उपयोगकर्ताओं के लिए टोकन कैश किए जा रहे हैं, तो आपको हर कॉल में अपना उपयोगकर्ता नाम बताना होगा.
PASSWORD ज़रूरी नहीं. उपयोगकर्ता नाम और पासवर्ड का कॉम्बिनेशन या पासकोड ज़रूरी है. आपके Apigee खाते का पासवर्ड. अगर पासवर्ड नहीं दिया जाता है, तो आपसे इसे पहली बार acurl का इस्तेमाल करते समय और मान्य रीफ़्रेश टोकन के बिना किए जाने वाले किसी भी कॉल के दौरान डालने के लिए कहा जाएगा. अगर आपको कमांड में सीधे तौर पर अपने पासवर्ड का इस्तेमाल नहीं करना है, तो पासवर्ड के बजाय एक बार इस्तेमाल होने वाला कोड पासकोड इस्तेमाल किया जा सकता है.
MFACODE ज़रूरी नहीं मल्टी-फ़ैक्टर ऑथेंटिकेशन (एमएफ़ए) का छह अंकों वाला अस्थायी कोड. अगर -u का इस्तेमाल किया जाता है और एमएफ़ए की सुविधा चालू है, तो यह कोड ज़रूरी है. अगर यह कोड नहीं दिया जाता है, तो आपसे इसके बारे में पूछा जाएगा. हालांकि, पासकोड मोड में ऐसा नहीं होगा. अगर एमएफ़ए की सुविधा चालू नहीं है या आपके पास स्क्रिप्ट किया गया फ़्लो है, प्रॉम्प्ट से बचने के लिए -m "" बताया जा सकता है.
PASSCODE ज़रूरी नहीं. उपयोगकर्ता नाम और पासवर्ड का कॉम्बिनेशन या पासकोड ज़रूरी है. एक एक बार इस्तेमाल होने वाला पासकोड जिसका इस्तेमाल पासवर्ड की जगह किया जा सकता है. एसएएमएल आईडीपी से पुष्टि करते समय, पासकोड ज़रूरी होता है. साथ ही, एलडीएपी आईडीपी से पुष्टि करने के लिए भी इसका इस्तेमाल किया जा सकता है.

उदाहरण के लिए:

acurl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval
acurl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval -u ahamilton@apigee.com
acurl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval -u ahamilton@apigee.com -p 424242
acurl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval -u ahamilton@apigee.com:mypassw0rd
acurl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval -u ahamilton@apigee.com:mypassw0rd -m 123456

ऊपर दिखाए गए विकल्पों के अलावा, acurl सभी curl विकल्प स्वीकार करता है. उदाहरण के लिए, स्टैंडर्ड curl विकल्पों का इस्तेमाल करके, हेडर पास किए जा सकते हैं, एचटीटीपी वर्ब तय किया जा सकता है, बॉडी जोड़ी जा सकती है, और वर्बोसिटी चालू की जा सकती है:

विकल्प acurl meaning curl meaning
-u username username
-m MFA code max time (लंबे फ़ॉर्म --max-time का इस्तेमाल करना ज़रूरी है)
-p passcode proxy tunnel (लंबे फ़ॉर्म --proxytunnel का इस्तेमाल करना ज़रूरी है)
-v verbose verbose
-h help help (लंबे फ़ॉर्म --help का इस्तेमाल करना ज़रूरी है) 
acurl -v -X POST -H 'Content-Type: application/json' \
    https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval/apiproducts/myproduct/attributes/attr \
    -u ahamilton@apigee.com -d '{"value":42}'

acurl कॉल के पूरा होने पर, नतीजे मिलते हैं. ये नतीजे, इस बात पर निर्भर करते हैं कि आपने Edge API के किस एंडपॉइंट को कॉल किया है. इसके अलावा, acurl ऐक्सेस और रीफ़्रेश, दोनों टोकन को ~/.sso-cli में सेव करता है.

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

curl से माइग्रेट करना

अगर curl का इस्तेमाल किया जा रहा है, तो acurl यूटिलिटी पर माइग्रेट करना आसान है. इससे क्रेडेंशियल को मैन्युअल तरीके से एनकोड करने की ज़रूरत नहीं पड़ती. यूटिलिटी डाउनलोड और इंस्टॉल करने के बाद, इसे बदला जा सकता है: 

curl -u username
 इससे: 
acurl -u username

acurl यूटिलिटी, आपके क्रेडेंशियल को एनकोड करेगी. साथ ही, नए टोकन पेयर पाने के लिए ज़रूरी अतिरिक्त क्रेडेंशियल के बारे में कभी-कभी आपसे पूछेगी.

acurl यूटिलिटी का इस्तेमाल, मशीन उपयोगकर्ताओं के लिए curl की जगह भी किया जा सकता है. ज़्यादा जानकारी के लिए, मशीन उपयोगकर्ताओं के लिए OAuth2 और एसएएमएल ज़ोन में मशीन उपयोगकर्ता लेख देखें.

पहली बार acurl को कॉल करना

acurl की मदद से एपीआई को पहली बार कॉल करते समय, आपको अपने Apigee क्रेडेंशियल (आपके Apigee खाते का उपयोगकर्ता नाम और पासवर्ड या पासकोड) देने होंगे, ताकि acurl उन्हें ऐक्सेस टोकन और रीफ़्रेश टोकन से बदल सके.

यहां acurl की मदद से, संगठन की जानकारी पाने के लिए किए गए शुरुआती कॉल का उदाहरण दिया गया है. इसके लिए, संगठन की जानकारी पाने का एंडपॉइंट इस्तेमाल किया गया है:

acurl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval \
  -u ahamilton@apigee.com
Enter the password for user 'ahamilton@apigee.com':
[hidden input]
Enter the six-digit code (no spaces) if 'ahamilton@apigee.com' is MFA-enabled or press ENTER:
1a2b3c
{
  "createdAt" : 1491854501264,
  "createdBy" : "noreply_iops@apigee.com",
  "displayName" : "ahamilton",
  "environments" : [ "prod", "test" ],
  "lastModifiedAt" : 1491854501264,
  "lastModifiedBy" : "noreply_iops@apigee.com",
  "name" : "ahamilton",
  "properties" : {
    "property" : [ {
      "name" : "features.isSmbOrganization",
      "value" : "false"
    }, {
      "name" : "features.isCpsEnabled",
      "value" : "true"
    } ]
  },
  "type" : "trial"
}

acurl यूटिलिटी, ऐक्सेस टोकन हासिल करती है और उसे Edge API एंडपॉइंट के कॉल में जोड़ती है:

curl -H "Authorization: Bearer oauth2_access_token" ...

ऐक्सेस टोकन को स्थानीय तौर पर ~/.sso-cli में सेव किया जाता है. साथ ही, इसका इस्तेमाल आने वाले समय में किए जाने वाले कॉल के लिए किया जाता है.

ऐक्सेस टोकन की समयसीमा खत्म होने के बाद, acurl अपने-आप रीफ़्रेश टोकन का इस्तेमाल करके नया ऐक्सेस टोकन हासिल करता है. रीफ़्रेश टोकन की समयसीमा खत्म होने पर, acurl आपसे आपके Apigee क्रेडेंशियल के बारे में पूछेगा.

इस अनुरोध से, "ahamilton-eval" संगठन के बारे में जानकारी मिलती है. Edge API एंडपॉइंट की पूरी सूची देखने के लिए, Apigee Edge API का रेफ़रंस देखें.

(1) कॉपीराइट 2023 Google LLC
acurl टूल को "सॉफ़्टवेयर" के तौर पर उपलब्ध कराया गया है. यह टूल, Google Cloud Platform के इस्तेमाल को कंट्रोल करने वाले समझौते के तहत उपलब्ध है. इसमें, https://cloud.google.com/terms/service-terms पर उपलब्ध, सेवा से जुड़ी खास शर्तें भी शामिल हैं.