TracePass
Passaporti

Renderizzare il QR del passaporto

Restituisce un codice QR appena renderizzato per il passaporto, che codifica il suo `gs1.digitalLinkUri`. Usatelo quando volete il nostro renderer (quiet zone coerente, correzione d'errore, branding facoltativo) invece di codificare voi l'URI. Il default è `image/svg+xml`; `?format=png` restituisce un PNG e `?format=json` un wrapper `{ result: "<svg>" }` da incorporare.

GET/api/v1/passports/{id}/qr
Scarica OpenAPI 3.1
GET/api/v1/passports/{id}/qr

Renderizzare il QR del passaporto

Restituisce un codice QR appena renderizzato per il passaporto, che codifica il suo `gs1.digitalLinkUri`. Usatelo quando volete il nostro renderer (quiet zone coerente, correzione d'errore, branding facoltativo) invece di codificare voi l'URI. Il default è `image/svg+xml`; `?format=png` restituisce un PNG e `?format=json` un wrapper `{ result: "<svg>" }` da incorporare.

Per default il QR è nero su sfondo trasparente. Impostate `?useCompanyBranding=true` per usare il colore del marchio, oppure passate `?color=FF6600` (hex a 6 caratteri, senza `#`) per un primo piano esplicito — un `color` esplicito prevale sul branding. `?backgroundColor=FFFFFF` aggiunge uno sfondo pieno (hex a 8 caratteri = RGBA per trasparenza parziale).

Indirizzamento alternativo: `GET /api/v1/passports/by-serial/{serial}/qr` accetta gli stessi parametri di query e il disambiguatore `?gtin=` quando un seriale non è univoco tra i vostri GTIN. Ogni chiamata conta come una lettura di passaporto sul limite giornaliero.

Parametri di percorso

  • idobbligatorio

    ObjectId

    ID del passaporto.

Parametri di query

  • format

    string

    `svg` (default), `png` o `json`.

    e.g. png

  • useCompanyBranding

    boolean

    Renderizza il QR nel colore del marchio invece del nero.

  • color

    string (hex, no #)

    Primo piano hex esplicito a 6 caratteri — prevale sul branding.

    e.g. FF6600

  • backgroundColor

    string (hex, no #)

    Sfondo pieno, hex a 6 o 8 caratteri (8 = RGBA).

    e.g. FFFFFF

Header

  • Authorizationobbligatorio

    string

    `Bearer <token>` — una chiave API `tp_` (Developer → API Keys; più semplice, per server-to-server) oppure un access token OAuth 2.0 (Developer → OAuth Apps; per app autorizzate dall'utente, scoped e revocabili). La pagina Authentication contiene il flusso OAuth completo e l'elenco degli scopes.

    e.g. Bearer tp_REDACTED_xxxxxxxxxxxx

Richiesta

# 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

Risposta

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