TracePass
Започнете
Паспорти

Рендиране на QR на паспорт

Връща прясно рендиран QR код за паспорта, кодиращ неговия `gs1.digitalLinkUri`. Използвайте това, когато искате нашия renderer (консистентна quiet zone, корекция на грешки, по избор брандиране) вместо сами да кодирате URI. По подразбиране връща `image/svg+xml`; `?format=png` връща PNG, а `?format=json` връща обвивка `{ result: "<svg>" }` за вграждане.

GET/api/v1/passports/{id}/qr
Изтегли OpenAPI 3.1
GET/api/v1/passports/{id}/qr

Рендиране на QR на паспорт

Връща прясно рендиран QR код за паспорта, кодиращ неговия `gs1.digitalLinkUri`. Използвайте това, когато искате нашия renderer (консистентна quiet zone, корекция на грешки, по избор брандиране) вместо сами да кодирате URI. По подразбиране връща `image/svg+xml`; `?format=png` връща PNG, а `?format=json` връща обвивка `{ result: "<svg>" }` за вграждане.

По подразбиране QR кодът е черен на прозрачен фон. Задайте `?useCompanyBranding=true` за цвета на марката или подайте `?color=FF6600` (6-знаков hex, без `#`) за явен преден цвят — явният `color` има предимство пред брандирането. `?backgroundColor=FFFFFF` добавя плътен фон (8-знаков hex = RGBA за частична прозрачност).

Алтернативна адресация: `GET /api/v1/passports/by-serial/{serial}/qr` приема същите query параметри и `?gtin=` дисамбигуатор, когато серийният номер не е уникален между GTIN-ите ви. Всяко извикване се брои като едно четене на паспорт към дневния лимит.

Параметри в пътя

  • idзадължително

    ObjectId

    ID на паспорта.

Query параметри

  • format

    string

    `svg` (по подразбиране), `png` или `json`.

    e.g. png

  • useCompanyBranding

    boolean

    Рендира QR в цвета на марката вместо черно.

  • color

    string (hex, no #)

    Явен 6-знаков hex преден цвят — има предимство пред брандирането.

    e.g. FF6600

  • backgroundColor

    string (hex, no #)

    Плътен фон, 6- или 8-знаков hex (8 = RGBA).

    e.g. FFFFFF

Хедъри

  • Authorizationзадължително

    string

    `Bearer <token>` — или `tp_` API ключ (Developer → API Keys; най-просто, за server-to-server), или OAuth 2.0 access token (Developer → OAuth Apps; за приложения, авторизирани от потребител, scoped и отзоваеми). Страницата Authentication съдържа пълния OAuth поток и списъка със scopes.

    e.g. Bearer tp_REDACTED_xxxxxxxxxxxx

Заявка

# SVG (default)
curl -sS https://app.tracepass.eu/api/v1/passports/6650b2c3d4e5f6a7b8c9d0e1/qr \
  -H "Authorization: Bearer tp_REDACTED_xxxxxxxxxxxx" -o passport-qr.svg

# Branded PNG
curl -sS \
  "https://app.tracepass.eu/api/v1/passports/6650b2c3d4e5f6a7b8c9d0e1/qr?format=png&color=FF6600" \
  -H "Authorization: Bearer tp_REDACTED_xxxxxxxxxxxx" -o passport-qr.png

Отговор

<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 29 29">
  <!-- QR modules encoding the GS1 Digital Link URI -->
</svg>

Свързани endpoints