QRCode Suitefor WordPress
LoginStart free →
Documentation

REST API quickstart

QRCode Suite exposes a versioned REST API under `/wp-json/meliqs/v1/` on the WordPress instance. This walkthrough takes you from minting your first API key to creating a QR and pulling scan data — five HTTP requests total, with curl and Postman examples for each.

  1. 1

    Mint an API key

    In WordPress admin: QR Suite → API Keys → Create. Name the key, pick a scope (`read`, `read-write`, or `admin`), and copy the secret immediately — it is only shown once. The full key format is `qcs_live_<32-hex>`. Store it in your environment as `QCS_API_KEY`.

  2. 2

    Create a dynamic QR

    POST to `/wp-json/meliqs/v1/qrs` with header `Authorization: Bearer $QCS_API_KEY` and body `{"type": "url", "target": "https://example.com/landing", "name": "API test"}`. Returns the QR id, the encoded short URL, and metadata. Save the id; you'll use it for the next two calls.

  3. 3

    Pull scan analytics

    GET `/wp-json/meliqs/v1/qrs/{id}/scans?from=2026-01-01&to=2026-05-01` returns paginated scan events: hashed IP, country, device, referrer, UTM. The default page size is 100 events; pass `page=2&per_page=200` for larger queries up to 1000 events per page.

  4. 4

    Update the QR destination

    PATCH `/wp-json/meliqs/v1/qrs/{id}` with body `{"target": "https://example.com/new-destination"}`. Returns 200 with the updated record. The printed QR immediately resolves to the new URL — no reprint, no cache flush needed.

  5. 5

    Webhooks for real-time scans

    Subscribe a webhook URL to receive each scan event: POST to `/wp-json/meliqs/v1/webhooks` with body `{"url": "https://your-server.example/scan-hook", "events": ["scan.created"]}`. Every scan now triggers an HMAC-signed POST to your endpoint within 200 ms.

Frequently asked questions

What is QRCode Suite?

QRCode Suite is a premium WordPress plugin that generates branded, dynamic QR codes directly inside your WordPress dashboard. Scan data is stored on your own server — not on a third-party SaaS platform — and WooCommerce orders can be attributed to specific QR codes.

Does QRCode Suite require a separate subscription?

The Free plan is available at no cost. Paid plans (Pro, Business, Agency) are licensed per WordPress site and billed monthly or annually. There is no separate per-scan fee.

What QR code types does QRCode Suite support?

QRCode Suite supports 15 QR code types: URL, vCard, Wi-Fi, SMS, Email, WhatsApp, PDF, Coupon, Plain Text, Social profile, WooCommerce Product, WooCommerce Reorder, Link Hub, Phone, and Dynamic URL.

Can I change the destination of a QR code after printing it?

Yes. Dynamic QR codes use a short redirect URL. You can update the destination from your WordPress dashboard at any time without generating or reprinting the code.

Is QRCode Suite GDPR-compliant?

Yes. QRCode Suite hashes IP addresses with SHA-256 before storage so no raw IPs are ever saved. It also filters bot traffic automatically and includes configurable data-retention settings.

Need help getting started?

Download the free plugin or browse all documentation.

Download pluginAll docs