การใช้ Acurl

คุณกำลังดูเอกสารประกอบ Apigee Edge
ไปที่ เอกสารประกอบเกี่ยวกับ Apigee X.
ข้อมูล

ยูทิลิตี acurl(1) มี Wrapper ที่สะดวกสำหรับคำสั่ง curl มาตรฐาน acurl:

  • แลกเปลี่ยนข้อมูลเข้าสู่ระบบ Apigee สำหรับโทเค็นการเข้าถึง OAuth2
  • ตรวจจับเมื่อโทเค็นเพื่อการเข้าถึงหมดอายุ และใช้โทเค็นการรีเฟรชเพื่อรับโทเค็นเพื่อการเข้าถึงใหม่
  • ส่งโทเค็นนั้นในส่วนหัว Authorization ของคำขอ API

คุณใช้โทเค็นเพื่อการเข้าถึงเพื่อเรียกปลายทาง Edge API ด้วย OAuth2 ซึ่งรวมถึง เวิร์กโฟลว์ LDAP และ SAML

หากคุณใช้ OAuth2 เพื่อเข้าถึง Edge API แต่ไม่ได้ใช้ acurl คุณต้องรับโทเค็นการเข้าถึงและเพิ่มลงในส่วนหัวของคําขอ API ด้วยตนเอง วิธีหนึ่งในการรับ โทเค็นเพื่อการเข้าถึงมีในยูทิลิตี get_token

ติดตั้ง acurl

ก่อนที่คุณจะใช้ acurl ได้ คุณต้อง ติดตั้ง

ไวยากรณ์ acurl

ยูทิลิตี acurl ใช้ไวยากรณ์ต่อไปนี้

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

หรือ

acurl API_URL -p PASSCODE

สถานที่:

ตัวเลือก จำเป็นหรือไม่ คำอธิบาย
API_URL จำเป็น ปลายทาง API ของ Apigee Edge ดูรายการปลายทางทั้งหมดได้ที่เอกสารอ้างอิง Apigee Edge API
USERNAME ไม่บังคับ ต้องระบุชื่อผู้ใช้และรหัสผ่านร่วมกันหรือรหัสผ่าน ชื่อผู้ใช้ Apigee ซึ่งมักจะเป็นอีเมลที่เชื่อมโยงกับบัญชี Apigee คุณต้องส่งชื่อผู้ใช้หรือรหัสผ่านเมื่อโทรหา get_token เป็นครั้งแรก คุณไม่จำเป็นต้องส่งอีเมล อีกครั้งจนกว่าโทเค็นเพื่อการเข้าถึงและการรีเฟรชจะหมดอายุ หากคุณกำลังแคชโทเค็น สำหรับผู้ใช้มากกว่า 1 ราย คุณต้องระบุชื่อผู้ใช้ในการโทรแต่ละครั้ง
PASSWORD ไม่บังคับ ต้องระบุชื่อผู้ใช้และรหัสผ่านร่วมกันหรือรหัสผ่าน รหัสผ่านของบัญชี Apigee หากคุณไม่ใส่รหัสผ่าน ระบบจะแจ้งให้ ป้อนรหัสดังกล่าวในครั้งแรกที่คุณใช้ acurl และในการโทรครั้งต่อๆ มาโดยไม่มีหมายเลขที่ถูกต้อง โทเค็นการรีเฟรช หากไม่ต้องการใช้รหัสผ่านในคำสั่งโดยตรง คุณสามารถใช้รหัสผ่านแบบใช้ครั้งเดียวแทนรหัสผ่านได้
MFACODE ไม่บังคับ รหัสการตรวจสอบสิทธิ์แบบหลายปัจจัย (MFA) ชั่วคราว 6 หลัก คุณต้องใช้รหัสนี้หากใช้ -u และเปิดใช้ MFA คุณจะได้รับข้อความแจ้งหากไม่ใส่รหัสผ่าน (ยกเว้นในโหมดรหัสผ่าน) หากไม่ได้ตั้งค่า MFA ไว้หรือคุณมีขั้นตอนที่ใช้สคริปต์ คุณสามารถระบุ -m "" เพื่อหลีกเลี่ยงข้อความแจ้งได้
PASSCODE ไม่บังคับ ต้องระบุชื่อผู้ใช้และรหัสผ่านร่วมกันหรือรหัสผ่าน รหัสผ่านแบบใช้งานครั้งเดียวที่คุณสามารถใช้แทน รหัสผ่าน คุณต้องใช้รหัสผ่านเมื่อตรวจสอบสิทธิ์ด้วย SAML IdP และอาจใช้รหัสผ่านเพื่อตรวจสอบสิทธิ์ด้วย LDAP IdP

เช่น

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 ทั้งหมดด้วย ตัวอย่างเช่น คุณสามารถส่งส่วนหัว ระบุคำกริยา HTTP เพิ่มเนื้อหา และเปิดใช้การแสดงผลรายละเอียดโดยใช้ตัวเลือก curl มาตรฐาน ดังนี้

ตัวเลือก acurl meaning curl meaning
-u username username
-m 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}'

การเรียก acurl ที่สำเร็จจะแสดงผลลัพธ์ตามปลายทาง Edge API ที่คุณเรียกใช้ นอกจากนี้ acurl จะจัดเก็บทั้งโทเค็นการเข้าถึงและโทเค็นการรีเฟรชใน ~/.sso-cli

คุณจะโทรต่อได้โดยไม่ต้องป้อนข้อมูลเข้าสู่ระบบ (รหัสผ่านและ MFA หรือรหัสผ่านที่ไม่บังคับ) จนกว่าทั้งโทเค็นการเข้าถึงและโทเค็นรีเฟรชจะหมดอายุตามที่อธิบายไว้ในการหมดอายุของโทเค็น

ย้ายข้อมูลจาก curl

หากคุณใช้ curl การย้ายข้อมูลไปยังยูทิลิตี acurl จะไม่ซับซ้อนและ ช่วยลดความจำเป็นในการเข้ารหัสข้อมูลเข้าสู่ระบบด้วยตนเอง เมื่อดาวน์โหลดและติดตั้งยูทิลิตีแล้ว คุณสามารถแทนที่สิ่งต่อไปนี้ได้

curl -u username
มี
acurl -u username

ยูทิลิตี acurl จะเข้ารหัสข้อมูลเข้าสู่ระบบและแจ้งให้คุณระบุข้อมูลเข้าสู่ระบบเพิ่มเติมที่จำเป็นในการรับคู่โทเค็นใหม่เป็นครั้งคราว

ยูทิลิตี acurl ยังใช้แทนที่ curl สำหรับผู้ใช้เครื่องได้ด้วย สำหรับข้อมูลเพิ่มเติม โปรดดู OAuth2 สำหรับผู้ใช้เครื่องและผู้ใช้เครื่องในโซน SAML

โทรหา acurl เป็นครั้งแรก

เมื่อเรียก API ด้วย acurl เป็นครั้งแรก คุณต้องระบุข้อมูลเข้าสู่ระบบ Apigee (ชื่อผู้ใช้และรหัสผ่านของบัญชี Apigee หรือรหัสผ่าน) เพื่อให้ acurl แลกข้อมูลเข้าสู่ระบบดังกล่าวเป็นโทเค็นการเข้าถึงและโทเค็นการรีเฟรช

ตัวอย่างต่อไปนี้แสดงการโทรครั้งแรกกับ acurl เพื่อสอบถามรายละเอียดเกี่ยวกับ ขององค์กรโดยใช้ Get องค์กรปลายทาง:

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

ระบบจะจัดเก็บ 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