关于使用 API 的提示

  • 5 分钟

以下提示将帮助您成功运用 API。

  • 当您通过 GET 调用终结点时，将获取所有可用 API 的列表。

  • 当您通过 GET 与 $metadata 调用终结点时，将获取具有本元数据的所有可用 API 的列表。

  • 当您通过 GET 与 $filter 调用终结点时，可以使用 OData 筛选表达式。

  • 每个资源都通过 ID 唯一标识。

    {
    "@odata.context": "<endpoint>/$metadata#companies",
    "value": [
        {
            "id": "bb6d48b6-c7b2-4a38-9a93-ad5506407f12",
            "systemVersion": "18453",
            "name": "CRONUS USA, Inc.",
            "displayName": "CRONUS USA, Inc.",
            "businessProfileId": ""
        }
    ]
}

  • 当您尝试读取或修改资源或其任何子项时，必须在 URL 中提供资源 ID。 该 ID 在 API 端点后面的括号 () 中给出。 例如，要获取 CRONUS USA, Inc. 公司的详细信息，您必须使用以下逻辑进行调用：

    <endpoint>/companies(bb6d48b6-c7b2-4a38-9a93-ad5506407f12)/

  • 所有资源都位于上级公司的上下文中，这意味着所有资源的 API 调用都必须在 URL 中提供公司 ID。 例如，要获取 CRONUS USA, Inc. 公司的所有客户，您应使用以下逻辑进行调用：

    <endpoint>/companies(bb6d48b6-c7b2-4a38-9a93-ad5506407f12)/customers

  • 指定 Accept-Language 请求标头来控制响应的语言，例如错误消息，以及日期和时间等值的区域格式。

  • 使用 ReadOnly 值指定 Data-Access-Intent 请求标头，以从数据库的副本读取数据，从而减少主数据库上的负载。 修改请求（如 POST、PATCH 或 DELETE）仅支持 ReadWrite 值。