Баримт бичиг / API лавлах
QR код
QR зураг ба холбоос бүрийн QR тохиргоо.
GET/v1/workspaces/{workspaceId}/links/{linkId}/qr
QR image of one link using its saved style (query parameters override). Same output as the public endpoint, no rate limit, sizes up to 2048 px.
Параметр (17)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|---|---|---|---|
workspaceId | path | string | тийм | |
linkId | path | string | тийм | |
url | query | string | Public endpoint only: the short link to encode. | |
format | query | string | `svg` (default), `png` or `jpg`. | |
size | query | string | 64 to 2048 px (anonymous: at most 1024). Default 600. | |
level | query | string | ||
fgColor | query | string | ||
bgColor | query | string | ||
markerColor | query | string | ||
margin | query | string | ||
dotStyle | query | string | ||
markerCenter | query | string | ||
markerBorder | query | string | ||
logo | query | string | `default`, `none` or (authenticated) a logo file id. | |
trackScans | query | string | ||
style | query | string | `default` ignores the saved settings. | |
download | query | string | `1` sends `Content-Disposition: attachment`. |
GET/v1/workspaces/{workspaceId}/links/{linkId}/qr-logo
The logo a link shows when its mode is default (domain logo, then workspace logo) as PNG; 204 when there is none or the plan has no logo.
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|---|---|---|---|
workspaceId | path | string | тийм | |
linkId | path | string | тийм |
GET/v1/workspaces/{workspaceId}/links/{linkId}/qr-settings
The stored QR settings of a link with effective defaults, the encoded payload, symbol version and warnings.
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|---|---|---|---|
workspaceId | path | string | тийм | |
linkId | path | string | тийм |
PUT/v1/workspaces/{workspaceId}/links/{linkId}/qr-settings
Replace the link's QR settings. The generated code must decode (422 qr_not_decodable) and meet the contrast floor (422 qr_low_contrast).
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|---|---|---|---|
workspaceId | path | string | тийм | |
linkId | path | string | тийм |
Хүсэлтийн бие (PutQrSettings)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|---|---|---|
options | object | тийм | Options object; unknown fields are 422. Omitted fields keep their defaults. `logo` is set with the fields below, not here. |
logo | string | `default` (domain, then workspace logo), `none` or `custom`. | |
logoFileId | string | Required with `logo: "custom"`: an uploaded logo file id. |
DELETE/v1/workspaces/{workspaceId}/links/{linkId}/qr-settings
Reset the link's QR style to the defaults (printed codes keep working: the URL is the same).
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|---|---|---|---|
workspaceId | path | string | тийм | |
linkId | path | string | тийм |
GET/v1/workspaces/{workspaceId}/qr/links
Links the caller can see with their short link and whether a custom QR style exists (the QR page's picker). Links in folders the caller cannot see are not listed.
Параметр (4)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|---|---|---|---|
workspaceId | path | string | тийм | |
search | query | string | ||
page | query | integer (int32) | ||
pageSize | query | integer (int32) |
POST/v1/workspaces/{workspaceId}/qr/logos
Upload a QR logo: the raw PNG, JPEG or WebP bytes as the request body (at most 1 MB, 128 to 2048 px). Stored as a processed PNG; the same image uploaded twice returns the same file. Needs Pro or above.
Параметр (1)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|---|---|---|---|
workspaceId | path | string | тийм |
GET/v1/workspaces/{workspaceId}/qr/logos/{fileId}
An uploaded logo of the workspace as PNG (the editor feeds it to the WebAssembly renderer).
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|---|---|---|---|
workspaceId | path | string | тийм | |
fileId | path | string | тийм |