Sử dụng acurl

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến Tài liệu về Apigee X.
thông tin

Tiện ích acurl(1) cung cấp một trình bao bọc tiện lợi xung quanh curl tiêu chuẩn . acurl:

  • Trao đổi thông tin đăng nhập Apigee của bạn lấy mã truy cập OAuth2.
  • Phát hiện thời điểm mã truy cập đã hết hạn và sử dụng mã làm mới để nhận mã truy cập mới.
  • Truyền mã thông báo đó vào tiêu đề Authorization của yêu cầu API.

Bạn dùng mã truy cập để gọi các điểm cuối của API Edge bằng OAuth2, bao gồm Quy trình làm việc với giao thức truy cập thư mục hạng nhẹ (LDAP) và SAML.

Nếu sử dụng OAuth2 để truy cập API Edge, nhưng không dùng acurl, thì bạn phải nhận mã truy cập rồi tự thêm mã đó vào tiêu đề của yêu cầu API. Một cách để có được mã truy cập đi kèm với phần mềm tiện ích get_token.

Cài đặt acurl

Trước khi có thể sử dụng acurl, bạn phải cài đặt tiện ích đó.

cú pháp acurl

Tiện ích acurl sử dụng cú pháp sau:

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

hoặc

acurl API_URL -p PASSCODE

Trong trường hợp:

Phương thức Bắt buộc? Mô tả
API_URL Bắt buộc Điểm cuối của API Apigee Edge. Để xem danh sách đầy đủ các điểm cuối, hãy xem Tài liệu tham khảo API Apigee Edge.
USERNAME Không bắt buộc. Bạn phải kết hợp tên người dùng và mật khẩu hoặc mật mã. Tên người dùng Apigee của bạn, thường là địa chỉ email liên kết với tài khoản Apigee của bạn. Bạn phải truyền tên người dùng hoặc mật mã vào lần đầu tiên gọi get_token. Bạn không cần chuyển địa chỉ email cho đến khi mã truy cập và mã làm mới hết hạn. Nếu bạn đang lưu mã thông báo vào bộ nhớ đệm cho nhiều người dùng, bạn phải chỉ định tên người dùng của mình trong mỗi lệnh gọi.
PASSWORD Không bắt buộc. Bạn phải kết hợp tên người dùng và mật khẩu hoặc mật mã. Mật khẩu cho tài khoản Apigee của bạn. Nếu bỏ qua mật khẩu này, bạn sẽ được nhắc nhập mã này vào lần đầu tiên bạn sử dụng acurl và trong bất kỳ lệnh gọi nào tiếp theo mà không có mã làm mới. Nếu không muốn sử dụng mật khẩu của mình ngay trong lệnh, bạn có thể sử dụng mật mã một lần thay cho mật khẩu của bạn.
MFACODE Không bắt buộc Hệ số đa yếu tố tạm thời gồm 6 chữ số xác thực (MFA). Mã này là bắt buộc nếu bạn sử dụng -u và đã bật tính năng xác thực đa yếu tố (MFA). Bạn sẽ được nhắc nếu bỏ qua (trừ phi ở chế độ mật mã). Nếu bạn chưa bật MFA hoặc bạn có quy trình theo tập lệnh, bạn có thể chỉ định -m "" để tránh lời nhắc.
PASSCODE Không bắt buộc. Bạn phải kết hợp tên người dùng và mật khẩu hoặc mật mã. Mật mã một lần bạn có thể sử dụng thay cho mật khẩu. Bạn cần phải nhập mật mã khi xác thực bằng một nhà cung cấp danh tính (IDP) dựa trên SAML. Bạn có thể sử dụng mật mã này để xác thực với IDP LDAP.

Ví dụ:

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

Ngoài các tuỳ chọn nêu trên, acurl chấp nhận tất cả curl . Ví dụ: bạn có thể truyền tiêu đề, chỉ định động từ HTTP, thêm nội dung và bật độ chi tiết bằng các tuỳ chọn curl tiêu chuẩn:

Phương thức acurl meaning curl meaning
-u username username
phút MFA code max time (phải sử dụng biểu mẫu dài --max-time)
–p passcode proxy tunnel (phải sử dụng biểu mẫu dài --proxytunnel)
-v verbose verbose
giờ help help (phải sử dụng biểu mẫu dài --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}'

Lệnh gọi acurl thành công sẽ trả về kết quả dựa trên điểm cuối của API Edge mà bạn có tên. Ngoài ra, acurl lưu trữ cả mã truy cập và mã làm mới trong ~/.sso-cli.

Bạn có thể tiếp tục gọi điện mà không cần nhập thông tin đăng nhập (mật khẩu và tính năng xác thực đa yếu tố (MFA) hoặc mật mã (không bắt buộc)) cho đến khi cả mã truy cập và mã làm mới hết hạn, như mô tả trong phần Thời hạn của mã thông báo.

Di chuyển từ curl

Nếu bạn đang sử dụng curl, việc di chuyển sang tiện ích acurl rất đơn giản và giúp loại bỏ nhu cầu mã hoá thông tin xác thực theo cách thủ công. Sau khi tải xuống và cài đặt tiện ích, bạn có thể thay thế:

curl -u username
bằng:
acurl -u username

Tiện ích acurl sẽ mã hoá thông tin xác thực và đôi khi nhắc bạn cung cấp thông tin đăng nhập bổ sung cần thiết để nhận cặp mã thông báo mới.

Tiện ích acurl cũng có thể được dùng để thay thế curl cho người dùng máy. Để biết thêm thông tin, hãy xem phần OAuth2 cho người dùng máyNgười dùng máy trong vùng SAML.

Gọi acurl lần đầu tiên

Vào lần đầu tiên gọi API bằng acurl, bạn cung cấp thông tin đăng nhập Apigee của mình (mã tên người dùng và mật khẩu của tài khoản Apigee hoặc một mật mã) để acurl có thể đổi những thông tin này lấy mã truy cập và mã làm mới.

Ví dụ sau đây cho thấy lệnh gọi ban đầu với acurl để lấy thông tin chi tiết về một bằng cách sử dụng Get của tổ chức:

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

Tiện ích acurl nhận mã truy cập và chèn mã đó vào lệnh gọi đến Điểm cuối của API Edge:

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

Mã truy cập được lưu trữ cục bộ trong ~/.sso-cli và dùng cho các lệnh gọi tiếp theo.

Sau khi mã truy cập hết hạn, acurl sẽ tự động sử dụng mã làm mới để lấy một mã truy cập mới. Khi mã làm mới hết hạn, acurl sẽ nhắc bạn để biết thông tin đăng nhập Apigee của bạn.

Yêu cầu này nhận được thông tin chi tiết về "ahamilton-eval" tổ chức. Để xem danh sách đầy đủ Các điểm cuối của API Edge, vui lòng xem Tài liệu tham khảo API Apigee Edge.


(1) Bản quyền 2023 Google LLC
Công cụ acurl được cung cấp dưới dạng "Phần mềm" trong thoả thuận chi phối việc bạn sử dụng Google Cloud Platform, bao gồm cả Dịch vụ Điều khoản cụ thể có tại https://cloud.google.com/terms/service-terms.