codes

Create a managed code

Creates one managed QR code / short link. The response contains short_url — the stable printed link encoded in the QR; it never changes when you retarget. Creation is idempotent by external_ref: re-sending the same external_ref returns the existing (non-archived) code without touching its destination.

post/api/v1/codes

Request

  • Base URL: https://app.qrtap.kg
  • URL: https://app.qrtap.kg/api/v1/codes
  • Auth: HTTP bearer

Request body

target_urlstring uri required

Destination URL the code redirects to. http(s) only. Can be changed later without reprinting.

labelstring

Human-readable title shown in the cabinet. Defaults to "Код".

external_refstring

Your identifier for this code (partner id, SKU, event id). Unique per organization among non-archived codes; creation is idempotent by this field.

group'partner' | 'equipment' | 'event_menu' | 'bag_insert' | 'training'

Code type used to slice analytics.

design_template_idstring uuid

Apply a branded design template (must belong to your organization).

Response

Code created (or an existing code returned for a repeated external_ref).

idstring uuid required
labelstring required
target_urlstring nullable required

Current destination URL.

external_refstring nullable required
groupstring nullable required
statestring required

Lifecycle state; API-created codes are deployed.

design_template_idstring uuid nullable required
slugstring required

Short-link slug. The QR encodes short_url = base + / + slug.

short_urlstring uri required

Stable printed link encoded in the QR. Never changes on retarget.

png_urlstring uri required

Artifact URL (PNG). Requires the same Bearer auth.

svg_urlstring uri required

Artifact URL (SVG). Requires the same Bearer auth.

scansinteger

All-time non-bot scan count. Present only when listing with include=stats.

created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.