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

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

acurl(1) यूटिलिटी स्टैंडर्ड curl के चारों ओर सुविधा रैपर उपलब्ध कराती है आदेश. acurl:

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

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

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

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 ज़रूरी नहीं छह अंकों का कई तरीकों से पुष्टि करने (MFA) का अस्थायी कोड. अगर -u का इस्तेमाल किया जा रहा है और आपने एमएफ़ए (मल्टी-फ़ैक्टर ऑथेंटिकेशन) की सुविधा चालू की है, तो यह कोड डालना ज़रूरी है. अगर पासवर्ड नहीं डाला जाता है, तो आपको पासवर्ड डालने के लिए कहा जाएगा. हालांकि, पासवर्ड मोड में ऐसा नहीं होगा. अगर आपके पास MFA चालू नहीं है या आपका कोई स्क्रिप्टेड फ़्लो है, तो प्रॉम्प्ट से बचने के लिए, -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 का इस्तेमाल करना ज़रूरी है)
-पेज passcode proxy tunnel (लॉन्ग फ़ॉर्म --proxytunnel का इस्तेमाल करना ज़रूरी है)
-v verbose verbose
-घं 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 यूटिलिटी आपके वीडियो को कोड में बदल देगी क्रेडेंशियल इस्तेमाल करती हैं और कभी-कभी नए टोकन पेयर पाने के लिए, आपको ज़रूरी अतिरिक्त क्रेडेंशियल मांगती है.

मशीन इस्तेमाल करने वालों के लिए, curl की जगह acurl यूटिलिटी का भी इस्तेमाल किया जा सकता है. ज़्यादा जानकारी के लिए, मशीन उपयोगकर्ताओं के लिए 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 पर उपलब्ध हैं.