二维码API：命令“创建二维码”（生成二维码，二维码生成器）

Lijun Zhao October 25, 2023

1.0 一般说明

在此页面上，您可以找到属于我们的二维码 API（“应用程序编程接口”）的创建二维码命令的说明。您可以使用它来创建自己的二维码图像/符号。

您也可以开始嵌入到您自己的 Web 应用程序中，例如 QR 码生成器。我们的页面 goQR.me 也使用此 API。

1.1 服务条款

请参阅服务条款：二维码 API

附加说明：没有请求限制，但我们保留拒绝 API 请求的权利。这尤其适用于我们认为滥用或不适当的请求（即，如果它似乎是 DoS 攻击）。因此，我们记录所有请求的来源（推荐人和IP地址），但不记录QR码的内容（有关更多信息，请参阅我们隐私政策的说明）。为了使我们的工作更轻松，如果您的服务每天经常导致超过 10 000 个请求，或者您的服务被错误地阻止，请告诉我们。

2.0 快速入门指南

向我们的系统发送以下表单的GET请求，以获取PNG图像形式的QR码图形（=生成QR码）：
http（s）://api.qrserver.com/v1/create-qr-code/？data=[URL-encoded-text]&size=[pixels]x[pixels]

通过请求以下 URL 直接在浏览器中对其进行测试：
http://api.qrserver.com/v1/create-qr-code/?data=HelloWorld!&size=100x100

如您所见，使用 标签很容易在您的 （X）HTML 文档中嵌入二维码。 标签
<img src=“https://api.qrserver.com/v1/create-qr-code/?data=HelloWorld&size=100x100” alt=“” title=“” />
生成/显示以下二维码图像：

为避免特殊字符出现问题，建议通过 charset-source 参数提交用于编码数据的字符集。

3.0 参数

该命令支持多种参数来配置 QR 码创建。只需通过向请求添加 &[参数名称]=[参数值] 来使用额外的参数。

所有参数都可以通过HTTP-GET或HTTP-POST提交。您也可以混合使用这两种方法。如果参数是同时使用 POST 和 GET 提交的，则将使用 GET 值，而 POST 值将被忽略。

3.1 data 参数（必填）

要存储在QR码中的文本（URL编码，PHP程序员可以使用urlencode（））。

  • 最小字符数：
    1
  • 最大字符数：
    取决于 ecc 参数（使用的数据冗余越多，QR 码中适合的字符越少）和其他因素，这些因素太复杂，无法在此处简要描述。尽管如此，通常最多 900 个字符应该有效。
  • 最佳实践：
    越短越好。由于许多较旧的手机存在QR码>版本4（即具有33×33个模块的矩阵）的问题，因此您应该使用尽可能少的数据。我们建议使用网址缩短器，例如 bitly 用于非常长的网址。但是，工业扫描仪在复杂的二维码方面应该没有问题。

3.2 size 参数（可选）

指定要生成的 QR 码图像的大小（对于 png、gif 或 jpeg 等光栅图形格式，以 px 为单位）;作为矢量图形（SVG，EPS）的逻辑单元。

  • 格式：
    [整数]x[整数]

  • 最小值：
    10x10

  • 最大值：
    1000x1000（如果格式=png|gif|jpeg|jpg），
    1000000x1000000（如果格式=svg|eps )

  • 有效示例：
    50x50 750x750

  • 无效示例：
    50x60（边缘长度不相等） 90000x90000（大于最大比例） 9x9（小于最小比例）

  • 默认值（如果未设置值或值无效，将使用）：
    200x200

3.3 charset-source 参数（可选）

指定通过 data 参数提交的文本的编码字符集。注意：如果字符集源和字符集目标具有不同的值，则不必关心转换数据，API 会自动完成所有需要的工作。

  • 可能的值：
    ISO-8859-1
    UTF-8

  • 无效示例：
    utf-8（错误的表示法，所有小写而不是大写）iso-8859-1（错误的表示法，所有小写而不是大写）

  • 默认值（如果未设置值或值无效，将使用）：
    UTF-8

3.4 charset-target 参数（可选）

指定用于对通过 data 参数提交的文本进行编码的字符集，然后再将其存储在 QR 码中。注意：如果字符集源和字符集目标具有不同的值，则不必关心转换数据，API 会自动完成所有需要的工作。

  • 可能的值：
    ISO-8859-1
    UTF-8

  • 无效示例：
    utf-8（错误的表示法，所有小写而不是大写）iso-8859-1（错误的表示法，所有小写而不是大写）

  • 默认值（如果未设置值或值无效，将使用）：
    UTF-8

  • 最佳实践：
    遗憾的是，QR 码规范没有提供在 QR 码中存储所用字符集的位置。这意味着 QR 码阅读器必须进行猜测，或者始终假设某个字符集。一些较旧的软件甚至只是忽略非ASCII字符，但是对于传统阅读器，我们通常对ISO-8859-1没有问题。通常（=如果不需要支持非常旧的设备或您想要存储特殊字符），则应在此处使用 UTF-8。如果你想在每种情况下都安全起见，你应该只使用以下字符（=ASCII）：
    ！”#$%&’（）*+,-./0123456789：;<=>?
    @ABCDEFGHIJKLMNOPQRSTUVWXYZ[]^_
    'abcdefghijklmnopqrstuvwxyz{|}~

3.5 ECC 参数（可选）

定义确定数据冗余程度的纠错码 （ECC）。存在的数据冗余越多，如果 QR 码损坏（即 QR 码贴纸上的划痕或类似的东西），可以恢复的数据就越多。

  • 可能的值：
    L（低，~7%的破坏数据可以校正） M（中间，~15%的破坏数据可以校正） Q（质量，~25%的破坏数据可以校正） H（高，~30%的破坏数据可以校正）

  • 默认值（如果未设置值或值无效，将使用）：
    L

  • 最佳实践：
    L。较高的 ECC 会导致需要保存的数据越多，从而导致具有更多数据像素和更大数据矩阵的 QR 码。由于许多手机阅读器存在二维码问题>版本 4（这意味着 33×33 个模块的矩阵），因此最低的 ECC 是实现共同目的的最佳选择——传统二维码阅读器是比销毁二维码更常见的问题。

3.6 color 参数（可选）

数据模块的颜色为 RGB 值。

  • 格式**：**
    十进制（[0-255]-[0-255]-[0-255]）或短格式的十六进制值（[a-fA-F] 三个字符，例如 fff 表示白色）或长格式（[a-fA-F] 六个字符，例如 ff0000 表示红色）。

  • 有效示例：
    255-0-0（红色）、f00（红色）、FF0000（红色）、0-255-0（绿色）、0f0（绿色）、00ff00（绿色）、0-0-255（蓝色）、

    00f（蓝色）、0000ff （蓝色）、

    556B2F（深橄榄绿）

  • 无效示例：
    300-100-0（RGB 十进制值 >255）、GG00AA（“G”不是有效字符）、ffaab（十六进制值既不是短格式也不是长格式（3 个分别是 6 个字母））、

    255-0（缺少十进制 B 值，仅给出 R 和 G 值）

  • 默认值（如果未设置值或值无效，将使用）：
    0-0-0 （=黑色）

  • 最佳做法：
    0-0-0（黑色）。否则，颜色比背景的颜色深得多，以获得良好的对比度。通过寻找所谓的网页颜色可以找到有用的颜色。

3.7 bgcolor 参数（可选）

背景的颜色为 RGB 值。

  • 格式**：**
    十进制（[0-255]-[0-255]-[0-255]）或短格式的十六进制值（[a-fA-F] 三个字符，例如 fff 表示白色）或长格式（[a-fA-F] 六个字符，例如 ff0000 表示红色）。

  • 有效示例：
    255-0-0（红色）、f00（红色）、FF0000（红色）、0-255-0（绿色）、0f0（绿色）、00ff00（绿色）、0-0-255（蓝色）、

    00f（蓝色）、0000ff （蓝色）、

    556B2F（深橄榄绿）

  • 无效示例：
    300-100-0（RGB 十进制值 >255）、GG00AA（“G”不是有效字符）、ffaab（十六进制值既不是短格式也不是长格式（3 个分别是 6 个字母））、

    255-0（缺少十进制 B 值，仅给出 R 和 G 值）

  • 默认值（如果未设置值或值无效，将使用）：
    0-0-0 （=黑色）

  • 最佳做法：
    255-255-255（白色）。否则，颜色比数据模块的颜色亮得多，以获得良好的对比度。通过寻找所谓的网页颜色可以找到有用的颜色。

3.8 margin 参数（可选）

边距的粗细（以像素为单位）。边距将始终具有与背景相同的颜色（您可以通过 bgcolor 进行配置）。它_不会添加到_按大小设置的图像宽度中，因此它必须小于大小值的至少三分之一。除了最终设置的 qzone 值_之外，还将_提取保证金。如果将 svg 或 eps 用作 QR 码格式，则边距参数将被忽略（=如果 QR 码输出是矢量图形）。

  • 格式：
    [整数]

  • 最小值：
    0（=无基于像素的边距）

  • 最大值：
    50

  • 有效示例：
    1
    19

  • 无效示例：
    -1（小于最小值）1200（大于最大值）a（不是数字）

  • 默认值（如果未设置值或值无效，将使用）：
    1

3.9 qzone 参数（可选）

边距的厚度（=“安静区”，一个没有干扰元素的区域，以帮助读者找到二维码），以模块作为测量单位。这意味着值为 1 会导致 QR 码周围的绘制边距与 QR 码的数据像素/模块一样厚。安静区将始终具有与背景相同的颜色（您可以通过 bgcolor 进行配置）。除了最终设置的边距值_外，还将_绘制安静区。

  • 格式：
    [整数]

  • 最小值：
    0（=无“安静区”）

  • 最大值：
    100

  • 有效示例：
    1
    19

  • 无效示例：
    -1（小于最小值）1200（大于最大值）a（不是数字）

  • 默认值（如果未设置值或设置无效值，将使用）：
    0（=无“安静区”）

  • 最佳实践：
    至少需要 1 个模块宽的安静区域才能获得最佳扫描结果。二维码标准建议“安静区”为 4。

3.10 format 参数（可选）

可以使用不同的文件格式创建二维码图片，可用的是 PNG、GIF、JPEG 以及矢量图形格式 SVG 和 EPS（=您可以根据需要创建二维码矢量图形/二维码 EPS / 二维码 SVG）。

  • 可能的值：
    png
    gif
    jpeg jpg
    svg

    eps

  • 无效示例：
    GIF（错误的表示法，所有内容都是大写而不是小写）Png（错误的表示法，第一个字符是大写而不是小写）

  • 默认值（如果未设置值或设置无效值，将使用）：
    png

  • 最佳做法：对于网站：
    png 或 gif。JPEG是为自然图片开发的，其结果比GIF / PNG的线条图和类似内容差。
    对于专业打印用途：svg 或 eps，因为基于矢量的图形可以按任何数量缩放而不会降低质量。