概述

二维码 API 是 HTTP API,可用于以编程方式创建自定义二维码。每个二维码都将包含一个唯一的 Branch Link,您可以使用该 Branch Link 进行深度链接和追踪分析。

📘

QR Code API

Access to Branch's QR Code API and SDK requires premium product access. Please reach out to your account manager or https://branch.io/pricing/ to activate.

创建二维码

Endpoint

POST /v2/qr-code
Content-Type: application/json

频率限制

  • 每秒 25 个请求
  • 每分钟 100 个请求
  • 每小时 1000 个请求

参数

参数

类型

定义

branch_key(必填

String

The Branch key of the originating app; from your Branch Settings Dashboard

data(可选

JSON

The dictionary to embed link data behind the QR Code. Accessed as session or install parameters from the SDK. Use the data dictionary for all link control parameters that you'll find here.

Branch analytics parameters (Optional)

String

请确保使用分析标签的组织结构标签链接,以使数据在操作后台 (Dashboard)中显示一致且易读。

qr_code_settings

JSON

如果不存在任何键/值对,则我们将使用您的 App 默认设置。有关设置的详细信息,请参见下表。

qr_code_settings

参数

类型

定义

code_color

String

Hex color value of the QR Code itself.

background_color

String

二维码本身背景的十六进制颜色值。

边距

整数(像素)

The number of pixels you want for the margin. Min 1px. Max 20px.

宽度

整数(像素)

Output size of QR Code image. Min 300px. Max 2000px. (Only applicable to JPEG/PNG)

image_format

String

PNG, JPEG, or JPG

center_logo_url

String (HTTP URL)

URL to the image you want as a center logo e.g. “https://cdn.branch.io/branch-assets/1598575682753-og_image.png”

code_pattern

Integer

Instead of the generic/standard QR-Code pattern we’re used to seeing, customers can now use (1) standard, (2) squares, (3) circles, (4) triangles, (5) diamonds, (6) hexagons, and (7) octagons.

finder_pattern

Integer

The finder pattern refers to the shape seen in the top left, top right, and bottom left of a QR-Code. Users can now choose between a square, a rounded square, or a circle. 1 = square, 2 = rounded rectangle, 3 = circle

finder_pattern_color

String

Hex color value of the Finder Pattern as per the https://htmlcolorcodes.com/

background_image_url

String

We can lay the QR-Code on top of a background image. Users can send a background_image_opacity to adjust how visible and prominent the background image is.

background_image_opacity

Integer

The opacity percentage of the background image.

code_pattern_url

String

Direct link to an image to be used as the code-pattern itself on the QR Code.

finder_eye_color

String

Hex color value of the finder eye as per the https://htmlcolorcodes.com/

样品申请

curl --request POST \
     --url https://api2.branch.io/v2/qr-code \
     --header 'accept: image/*' \
     --header 'content-type: application/json' \
     --data '
{
     "qr_code_settings": {
          "code_pattern": 1,
          "finder_pattern": 1,
          "image_format": "png",
          "center_logo_url": "https://cdn.branch.io/branch-assets/1598575682753-og_image.png",
          "width": 300,
          "margin": 1,
          "code_color": "#000000",
          "background_color": "#FFFFFF",
          "finder_pattern_color": "#000000",
          "finder_eye_color": "#000000"
     },
     "branch_key": "key_live_xxxx"
}
'

📘

图像输出

Note that the output of this cURL requests will be saved in the current directory as the file name indicated at the end of the request e.g. qr_code.png

结果

700700