Apigee Edge दस्तावेज़ देखा जा रहा है.
Apigee X दस्तावेज़ पर जाएं. जानकारी
acurl
(1) यूटिलिटी सेवा से, स्टैंडर्ड curl
कमांड के आस-पास एक सुविधा रैपर मिलता है. acurl
:
- यह आपके Apigee क्रेडेंशियल को OAuth2 ऐक्सेस टोकन की जगह इस्तेमाल करता है.
- यह पता लगाता है कि ऐक्सेस टोकन की समयसीमा कब खत्म हुई है. साथ ही, यह नया ऐक्सेस टोकन पाने के लिए रीफ़्रेश टोकन का इस्तेमाल करता है.
- एपीआई अनुरोध के
Authorization
हेडर में उस टोकन को पास करता है.
OAuth2 वाले Edge API एंडपॉइंट को कॉल करने के लिए, ऐक्सेस टोकन का इस्तेमाल किया जाता है. इनमें LDAP और SAML वर्कफ़्लो शामिल हैं.
अगर आपने Edge एपीआई को ऐक्सेस करने के लिए 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 एपीआई एंडपॉइंट. एंडपॉइंट की पूरी सूची देखने के लिए, Apigee Edge API का रेफ़रंस देखें. |
USERNAME | ज़रूरी नहीं. उपयोगकर्ता नाम और पासवर्ड, या पासवर्ड की ज़रूरत होती है. | आपका Apigee उपयोगकर्ता नाम, जो आम तौर पर आपके Apigee खाते से जुड़ा ईमेल पता होता है.
get_token को पहली बार कॉल करते समय आपको अपना उपयोगकर्ता नाम या पासवर्ड पास करना होगा.
आपको तब तक अपना ईमेल पता फिर से भेजने की ज़रूरत नहीं होगी, जब तक ऐक्सेस और रीफ़्रेश टोकन की समयसीमा खत्म नहीं हो जाती. अगर एक से ज़्यादा उपयोगकर्ताओं के लिए
टोकन कैश मेमोरी में सेव किए जा रहे हैं, तो आपको हर कॉल में अपना उपयोगकर्ता नाम बताना होगा. |
PASSWORD | ज़रूरी नहीं. उपयोगकर्ता नाम और पासवर्ड, या पासवर्ड की ज़रूरत होती है. | आपके Apigee खाते का पासवर्ड. अगर आपने पासवर्ड छोड़ दिया, तो पहली बार acurl का इस्तेमाल करते समय
आपको इसे डालने के लिए कहा जाएगा. साथ ही, इसके बाद होने वाले किसी भी कॉल में,
मान्य रीफ़्रेश टोकन के बिना इसे डालने के लिए कहा जाएगा. अगर आपको सीधे कमांड में अपना पासवर्ड इस्तेमाल नहीं करना है, तो पासवर्ड के बजाय एक बार इस्तेमाल होने वाले कोड पासवर्ड का इस्तेमाल किया जा सकता है. |
MFACODE | ज़रूरी नहीं | छह अंकों वाला अस्थायी मल्टी-फ़ैक्टर
ऑथेंटिकेशन (MFA) कोड. अगर आप -u इस्तेमाल करते हैं और MFA चालू है, तो यह कोड ज़रूरी है.
अगर पासवर्ड मोड चालू नहीं है, तो आपको सूचना दी जाएगी. हालांकि, ऐसा तब ही होगा, जब पासवर्ड मोड चालू न हो. अगर आपने MFA चालू नहीं किया है या आपके पास स्क्रिप्ट किया गया फ़्लो है, तो प्रॉम्प्ट से बचने के लिए -m "" तय किया जा सकता है. |
PASSCODE | ज़रूरी नहीं. उपयोगकर्ता नाम और पासवर्ड, या पासवर्ड की ज़रूरत होती है. | पासवर्ड की जगह एक बार इस्तेमाल किया जाने वाला पासवर्ड इस्तेमाल किया जा सकता है. एसएएमएल आईडीपी से पुष्टि करते समय पासवर्ड ज़रूरी है. इसका इस्तेमाल एलडीपी आईडी की मदद से पुष्टि करने के लिए किया जा सकता है. |
उदाहरण के लिए:
acurl https://api.enterprise.apigee.com/v1/organizations/ahamilton-evalacurl 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 |
-मिनट | MFA code |
max time (लंबी अवधि के --max-time का इस्तेमाल करना चाहिए) |
-p | 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}'
आपने जिस Edge एपीआई एंडपॉइंट पर कॉल किया था उसके मुताबिक acurl
कॉल करने पर नतीजे मिलते हैं. इसके अलावा, acurl
, ऐक्सेस और रीफ़्रेश टोकन,
दोनों को ~/.sso-cli
में सेव करता है.
आप क्रेडेंशियल (पासवर्ड और वैकल्पिक MFA या पासवर्ड) डाले बिना भी कॉल करना जारी रख सकते हैं. ऐसा तब तक किया जा सकता है, जब तक ऐक्सेस टोकन और रीफ़्रेश टोकन , दोनों की समयसीमा खत्म नहीं हो जाती, जैसा कि टोकन की समयसीमा खत्म होने की तारीख में बताया गया है.
कर्ल से माइग्रेट करें
अगर 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) Copyright 2023 Google LLC
acurl
टूल, Google Cloud Platform के इस्तेमाल को कंट्रोल करने वाले कानूनी समझौते के तहत "सॉफ़्टवेयर" के तौर पर उपलब्ध कराया गया है. इसमें सेवा की खास शर्तें भी शामिल हैं, जो https://cloud.google.com/terms/service-terms पर उपलब्ध हैं.