使用二维码生成器 API,为您的深度链接生成不同格式 (PNG、SVG、EPS) 和样式的二维码。您可以通过深度链接参数定义链接行为,并自定义二维码外观。
操作前须知
在使用二维码生成器 API 之前,您需要了解以下内容。
要求
- 所有深度链接生成器 API 的先决条件均适用于二维码生成器 API。
- 您必须使用链接生成负载协议提供有效负载。
响应标头
每个成功的响应都包含一个标头,指示所生成二维码中经过编码的深度链接。
X-QR-Code-URL: https://example.go.link/fryYl
以 URI 格式生成二维码
使用此终端生成二维码,并以 URI 编码文件的形式接收该二维码。URI 格式的二维码可以直接嵌入 HTML <img>
标签中。推荐使用场景:对即时下载速度要求不高,吞吐量低。
API 协议
终端: https://automate.adjust.com/engage/qr-code/uri
方法: POST
支持格式: SVG
,PNG
, EPS
请求正文:
参数 | 数据类型 |
---|---|
data* | 链接生成负载 |
qr_code_params* | 二维码配置 |
响应 :text/plain
类型的原始字符串响应,包含文件内容
以 SVG 格式生成二维码
使用此终端生成 SVG 格式的二维码,提供适合印刷或网页使用的、可扩展和可编辑的输出。
API 协议
终端: https://automate.adjust.com/engage/qr-code/svg
方法: POST
支持格式: SVG
请求正文:
参数 | 数据类型 |
---|---|
data* | 链接生成负载 |
qr_code_params* | 二维码配置 |
响应 :image/svg+xml
类型的原始字符串响应,包含文件内容
以字节流形式生成二维码
使用此终端,以二进制文件流的形式生成二维码。非常适合注重快速访问的高负载系统,例如需要将文件保存到自有 CDN 或存储控件以优化投放时。
API 协议
终端: https://automate.adjust.com/engage/qr-code/stream
方法: POST
支持格式: SVG
,PNG
, EPS
请求正文:
参数 | 数据类型 |
---|---|
data* | 链接生成负载 |
qr_code_params* | 二维码配置 |
响应: 字节流 (例如二进制 PNG 或 EPS 数据)
示例
curl -o $HOME/Downloads/png_custom_test.png --location https://automate.adjust.com/engage/qr-code/stream \--header 'Authorization: Bearer adjustApiToken' \--header 'Content-Type: application/json' \--data '{ "data": { "link_token": "1k4hnyz7", "redirect": "https://youtu.be/AyOqGRjVtls", "fallback": "https://youtu.be/AyOqGRjVtls", "deeplink_path": "/custom-path" }, "qr_code_params": { "file_type": "png", "error_correction": "quartile", "box_size": 12, "border": 2, "fill_color": "rgba(132, 51, 92, 0.74)", "back_color": "rgba(247, 108, 180, 0.8)", "style": {"name": "gapped", "size_ratio": "0.85"} }}'
结果:
数据模型
二维码参数
在请求正文中使用下列任一结构作为 qr_code_params
。
字段 | 类型 | 描述 |
---|---|---|
file_type * | string | 输出格式。其中任一:png ,eps , svg |
error_correction | string | 二维码纠错级别:low ,medium ,high ,quartile 。默认值medium 。 |
version | int | null | 控制大小 (1 - 40)。使用 null 和 fit: true 进行自动大小调整。 |
fit | boolean | 根据内容自动调整版本。默认为 true 。 |
box_size | int | 每个框的尺寸,以像素为单位。默认为 10 。 |
border | int | 框的边框宽度。默认为 4 。 |
fill_color | string | 二维码颜色,格式为 RGB、十六进制或命名颜色,如rgb(0,0,0) 、#000000 或"black" 。 |
back_color | string | 背景颜色,格式为 RGB、十六进制或命名颜色,如rgb(255,255,255) 、#FFFFFF 或"white" 。 |
style | object | 样式配置 (见下文)。 |
样式参数
名称 | 附加参数 | 支持格式 | 描述 |
---|---|---|---|
default | - | svg ,png , eps | 标准方形模块 |
gapped | size_ratio (默认:0.8 ) | svg ,png , eps | 缩小模块大小以创建间隙 |
circle | size_ratio (默认:0.8 ) | svg ,png , eps | 渲染圆形模块 |
rounded | - | png , eps | 使用圆角 |
vertical_bars | - | png , eps | 垂直条形样式模块 |
horizontal_bars | - | png , eps | 水平条形样式模块 |