Sử dụng acurl

Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào tài liệu Apigee X. thông tin

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

• Đổ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 để lấy mã truy cập mới.
• Truyền mã thông báo đó trong tiêu đề Authorization của yêu cầu API.

Bạn sử dụng mã truy cập để gọi các điểm cuối API Edge bằng OAuth2, bao gồm cả quy trình LDAP và SAML.

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

Cài đặt acurl

Để có thể sử dụng acurl, bạn phải cài đặt ứng dụng này.

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:

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 lựa chọn nêu trên, acurl còn chấp nhận tất cả các lựa chọn curl. Ví dụ: bạn có thể truyền tiêu đề, chỉ định động từ HTTP, thêm phần nội dung và bật chế độ chi tiết bằng cách sử dụng các lựa chọn curl tiêu chuẩn:

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 Edge API mà bạn đã gọi. 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 thực hiện các lệnh gọi mà không cần nhập thông tin đăng nhập (mật khẩu và MFA không bắt buộc hoặc mã truy cập) cho đến khi cả mã truy cập và mã làm mới đều hết hạn, như mô tả trong phần Thời gian hết hạn của mã thông báo.

Di chuyển từ curl

Nếu đang sử dụng curl, bạn có thể dễ dàng di chuyển sang tiện ích acurl và không cần mã hoá thông tin đăng nhập theo cách thủ công. Sau khi tải xuống và cài đặt tiện ích này, bạn có thể thay thế:

curl -u username

acurl -u username

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

Bạn cũng có thể dùng tiện ích acurl để thay thế curl cho người dùng thiết bị. Để biết thêm thông tin, hãy xem bài viết OAuth2 cho người dùng máy và Người dùng máy trong các vùng SAML.

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

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

Ví dụ sau đây cho thấy một lệnh gọi ban đầu bằng acurl để lấy thông tin chi tiết về một tổ chức bằng cách sử dụng điểm cuối Lấy 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 sẽ lấy mã truy cập và chèn mã này vào lệnh gọi đến điểm cuối Edge API:

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

Mã truy cập được lưu trữ cục bộ trong ~/.sso-cli và được 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ã truy cập mới. Khi mã làm mới hết hạn, acurl sẽ nhắc bạn cung cấp thông tin đăng nhập Apigee.

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

⁽¹⁾ Bản quyền 2023 Google LLC
Công cụ acurl được cung cấp dưới dạng "Phần mềm" theo thoả thuận chi phối việc bạn sử dụng Google Cloud Platform, bao gồm cả Điều khoản dành riêng cho dịch vụ có tại https://cloud.google.com/terms/service-terms.