开发者在接入 ImageX 能力时,可以对 API 进行调测。本章节以创意魔方的GetImageStyleResult接口为例,为您介绍通过 Postman 客户端进行 API 调用的步骤。
背景信息
- Postman:Postman 是一个 API 开发协作和测试工具,它可以帮助您开发和测试 API。Postman 可以模拟各类 HTTP 请求,将请求数据发送至服务端,获取对应的结果,来判断请求是否正确。
- 创意魔方:创意魔方是 ImageX 中用于图片合成的附加组件。针对大量的海报、邀请函、图片快报等制作场景,提供快捷高效的批量生产工具。您可以使用图片、文字、二维码、背景等元素,快速合成一张图片,并保存为样式。通过在线调用接口,可生成符合样式要求的图片。
前提条件
- 已参考创意魔方,完成功能开通和样式创建。
- 已下载安装 Postman 客户端。
操作步骤
获取调用参数
- 登录 ImageX 控制台,选择附加组件 > 创意魔方。
![](https://lf3-volc-editor.volccdn.com/obj/volcfe/sop-public/upload_e1ebf0396ddbd96a6e209c361bdd45c2.png)
- 进入我的样式,选择目标样式,单击调用参数按钮。
![](https://lf6-volc-editor.volccdn.com/obj/volcfe/sop-public/upload_31797bfc0abfadd1c5d623d8fc6f7445.png)
- 在页面右侧抽屉栏中,填写密钥信息
AccessKey
和 SecretKey
。
![](https://lf6-volc-editor.volccdn.com/obj/volcfe/sop-public/upload_fecc534747f1cc222280f4d96cbc63bc.png)
- 单击确定按钮,生成调用参数,选择 OpenAPI 参数页签,获取接口参数值。
![](https://lf3-volc-editor.volccdn.com/obj/volcfe/sop-public/upload_9fbc71edef7649e621f72bc5814c38a2.png)
配置调用参数
- 打开 Postman 客户端,创建一个请求。
![alt](https://lf6-volc-editor.volccdn.com/obj/volcfe/sop-public/upload_43796fb605a43e7b4ca0c399bc002db8.png)
- 在新建的请求页签下,选择请求类型为 POST,并输入调用参数抽屉栏中的服务地址。
![alt](https://lf6-volc-editor.volccdn.com/obj/volcfe/sop-public/upload_02c3456179216eecf4706a117d4ae6d4.png)
- 复制获取调用参数步骤中获取的信息,粘贴到 Postman 中。
粘贴 Params 信息。
![alt](https://lf3-volc-editor.volccdn.com/obj/volcfe/sop-public/upload_3510684a3112ace61c32098845d252fc.png)
粘贴 Headers 信息。
![alt](https://lf6-volc-editor.volccdn.com/obj/volcfe/sop-public/upload_e0b9e26b9b765c45b836023aa3bbbba7.png)
粘贴 Body 信息。
![alt](https://lf6-volc-editor.volccdn.com/obj/volcfe/sop-public/upload_ded2b6e9893853b2dd188ddf55a86266.png)
获取响应结果
- 单击 Send 按钮,发送请求。
- 请求成功后可以在 Response 中看到响应结果,并获取
ResUri
信息。
![alt](https://lf3-volc-editor.volccdn.com/obj/volcfe/sop-public/upload_8a0a223991f8e852703f97db2ddbaec7.png)
说明
创意魔方暂不支持通过编辑 Body 中的参数,来修改文字、二维码、图片等元素。
当前签名算法将 Body 中的动态参数也进行了签算,因此 Body 参数变更,会造成签名失效。需要在控制台中编辑样式,并重新生成签名参数。
预览返回的结果图
- 登录 ImageX 控制台,选择服务管理。
- 在搜索栏中输入样式的服务 ID(ServiceId)。样式的 ServiceId 查询方式请参见获取调用参数。
- 复制服务 ID 对应的绑定域名。
![alt](https://lf3-volc-editor.volccdn.com/obj/volcfe/sop-public/upload_bc861629c752114be22ccab78aaa8cb7.png)
- 在浏览器地址栏输入域名与响应结果中获取的 ResUri。格式为:http(s)://{Domain}/{ResUri}。
![alt](https://lf6-volc-editor.volccdn.com/obj/volcfe/sop-public/upload_7ec442e9d562ea981283104f0bfbf0f4.png)