我的服务模式是什么?
所有 Suite: Team、Growth、Professional、Enterprise 或 Enterprise Plus
Support Team、Professional 或 Enterprise

长期以来,REST API 一直是实现整合的标准,而 GraphQL 则因其灵活性和效率而迅速受到关注。您可以利用整合生成器的功能与 GraphQL API 整合。您可以充分利用 GraphQL 的关键功能,例如仅请求所需的数据,轻松处理复杂的查询。

在本文章中,我们将引导您完成使用整合生成器设置 GraphQL 请求的过程,包括了解 GraphQL 架构、构建查询并将响应整合到对话中。

设置 GraphQL 请求

  1. 找到 GraphQL 端点 URL,通常在 API 文档中提供(例如,https://api.example.com/graphql 或对于Shopify:https://{{storeName}} .myshopify.com/admin/api/2023-04/graphql.json)。
  2. 将其添加到整合生成器界面。
    1. 导航到环境并选择 POST 方法类型(如果您在请求数据)。
    2. 将您的 GraphQL 端点添加到 URL 输入中。
  3. 选择您的身份验证方法(如需要)。
  4. 如果需要,将您的凭证添加到标头。以Shopify整合为例:
  5. 了解 GraphQL 架构以选择您要从服务器返回的数据。
  6. 从 GraphQL 服务器获取架构。

    它定义了可用的查询、更改和类型。使用 Postman、GraphiQL 或 Atlas Explorer 等工具检查架构,并测试和优化查询。

    我们建议从 Postman 获取查询,方法是导航到“代码段”标签,并检查数据,您应在其中看到键为“查询”的对象。复制要在下一步中使用的对象。
  7. 在正文标签中,添加 GraphQL 查询,指定您需要的数据或您要执行的操作(如果提出修改数据的更改请求:创建、更新、删除)。
    必须是 JSON 格式。
    查询示例:
    ```{"query":"{\n __type(name: \"Order\") {\n name,\n fields {\n name\n type {\n name\n kind\n }\n }\n }\n }","variables":{}} ```
  8. 导航到成功场景以添加您的会话参数。
  9. 使用 JSONdata 编写您的查询,以访问和转换(如果需要)响应中的数据。示例如下:

 

翻译免责声明:本文章使用自动翻译软件翻译,以便您了解基本内容。 我们已采取合理措施提供准确翻译,但不保证翻译准确性

如对翻译准确性有任何疑问,请以文章的英语版本为准。

由 Zendesk 提供技术支持