此页面由 Cloud Translation API 翻译。

使用 acurl

您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档。信息

acurl⁽¹⁾ 实用程序为标准 curl 命令提供了一个便捷的封装容器。acurl:

将您的 Apigee 凭据交换为 OAuth2 访问令牌。
检测访问令牌何时过期，并使用刷新令牌获取新的访问令牌。
在 API 请求的 Authorization 标头中传递该令牌。

您可以使用访问令牌通过 OAuth2 调用 Edge API 端点，包括 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 端点。如需查看完整的端点列表，请参阅 Apigee Edge API 参考文档。
`USERNAME`	可选。必须提供用户名和密码的组合或密码。	您的 Apigee 用户名，通常是与您的 Apigee 帐号关联的电子邮件地址。首次调用 `get_token` 时，您必须传递用户名或密码。在访问令牌和刷新令牌过期之前，您无需再向其中传递电子邮件地址。如果您要为多个用户缓存令牌，则必须在每次调用中指定用户名。
`PASSWORD`	可选。必须提供用户名和密码的组合或密码。	您的 Apigee 帐号的密码。如果您省略密码，则在您首次使用 `acurl` 以及后续任何没有有效刷新令牌的调用时，系统都会提示您输入该密码。如果您不想直接在命令中使用密码，可以使用一次性代码密码，而不是密码。
`MFACODE`	可选	一个临时的六位数多重身份验证 (MFA) 码。如果您使用 `-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 选项。例如，您可以使用标准 curl 选项传递标头、指定 HTTP 动词、添加正文以及启用详细程度：

选项	`acurl meaning`	`curl meaning`
-u	`username`	`username`
-m	`MFA code`	`max time`（必须使用长格式 `--max-time`）
-p	`passcode`	`proxy tunnel`（必须使用长格式 `--proxytunnel`）
-v	`verbose`	`verbose`
-h	`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

首次使用 acurl 调用该 API 时，请提供您的 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 参考文档。