คุณกำลังดูเอกสารประกอบของ 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 | จำเป็น | ปลายทาง Apigee Edge API โปรดดูรายการปลายทางทั้งหมดที่หัวข้อเอกสารอ้างอิง API ของ Apigee Edge |
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-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
ทั้งหมดด้วย ตัวอย่างเช่น คุณอาจส่งส่วนหัว ระบุกริยา HTTP เพิ่มเนื้อหา และเปิดใช้รายละเอียดโดยใช้ตัวเลือก curl
มาตรฐาน ดังนี้
ตัวเลือก | acurl meaning |
curl meaning |
---|---|---|
- | 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}'
การเรียก acurl
ที่สำเร็จจะแสดงผลลัพธ์ตามปลายทาง Edge API ที่คุณเรียกใช้ นอกจากนี้ acurl
ยังจัดเก็บทั้งโทเค็นเพื่อการเข้าถึงและการรีเฟรชใน ~/.sso-cli
อีกด้วย
คุณยังโทรออกต่อไปได้โดยไม่ต้องป้อนข้อมูลเข้าสู่ระบบ (รหัสผ่านและ MFA ที่ไม่บังคับ หรือรหัสผ่าน) จนกว่าทั้งโทเค็นเพื่อการเข้าถึงและโทเค็นการรีเฟรชจะหมดอายุ ตามที่อธิบายไว้ในโทเค็นหมดอายุ
ย้ายข้อมูลจาก curl
หากคุณใช้ curl
การย้ายข้อมูลไปยังยูทิลิตี acurl
นั้นทำได้ง่ายและไม่ต้องเข้ารหัสข้อมูลเข้าสู่ระบบด้วยตนเอง เมื่อดาวน์โหลดและติดตั้งยูทิลิตีแล้ว คุณจะแทนที่
curl -u username
ด้วย acurl -u username
ได้
ยูทิลิตี acurl
จะเข้ารหัสข้อมูลเข้าสู่ระบบของคุณและบางครั้งจะแสดงข้อความแจ้งขอข้อมูลเข้าสู่ระบบเพิ่มเติมที่จําเป็นเพื่อรับคู่โทเค็นใหม่
นอกจากนี้ ยูทิลิตี acurl
ยังสามารถใช้แทนที่ curl
สำหรับผู้ใช้เครื่องได้ด้วย โปรดดูข้อมูลเพิ่มเติมที่หัวข้อ OAuth2 สำหรับผู้ใช้เครื่องและผู้ใช้เครื่องในโซน SAML
โทรครั้งแรก
ครั้งแรกที่เรียกใช้ API ด้วย 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