常见问题及解答

使用 API

我只想使用 API?什么是计划?

计划是 API 资源或者来自一个或多个 API 的资源子集的集合。计划可以包含来自不同 API 的操作类型的混合。计划可对所有资源使用公共速率限制,或者每个资源可具有不同的速率限制。速率限制指定允许某应用程序在指定的时间间隔内发出请求的数目。

使用此 Developer Portal 来浏览可供您使用的各种计划并选择最满足您需求的计划。某些计划具有必须请求访问权才能使用的限制访问权。在您提交请求时,组织便会收到通知,API 管理员将访问您的请求并与您联系以获取更多详细信息。其他计划可直接使用。

如何查看我的 API 使用情况?

应用程序页面上显示了应用程序针对不同 API 发出的请求数量。

单击主菜单中的“应用程序”,然后单击您的应用程序。在“产品预订”表中,您将看到应用程序预订的所有计划。

对于此计划中包含的每个 API,您可以查看与计划的速率限制相比较的使用情况。

如何测试 API?

可以从此 Developer Portal 测试 API。

在查看 API 的详细信息时,您将看到 API 中包含的操作的列表。这将显示用于该操作的动词和路径。

如果单击操作,您将看到有关该操作的更多信息、该操作可能采用的参数、返回的结果、可能使用的返回码及其含义。

REST API 上还有一个“试用”按钮,可用于直接从 Developer Portal 中试用该操作。

如果 API 需要使用客户机标识或客户机私钥进行识别,那么可以在“试用”部分的顶部使用应用程序凭证进行指定。

应用程序

如何注册应用程序?

在添加应用程序时,会向您提供该应用程序的 API 密钥和私钥。在调用要求您进行应用程序认证的 API 时,您必须提供这些凭证。

要注册应用程序,请单击主菜单中的“应用程序”,然后单击“创建新应用程序”链接。在提供应用程序名称和描述等信息后,将向您显示应用程序 API 密钥和私钥。

请记录您的 API 私钥,因为它只显示一次。

如何重置应用程序 API 私钥?

您的 API 私钥以加密形式存储,因此如果您忘记该私钥,我们无法检索未加密的版本以告诉您该值。

您可以重置,这将更新存储的值并将新值返回给您。

要执行此操作,请单击主菜单中的“应用程序”,单击所讨论的应用程序,然后您可以单击“API 私钥”部分中的“重置”链接。

新私钥将显示在页面顶部。