Developer REST API v1 & Webhooks Suite

Het Developer Platform voor Dynamische QR Codes op Schaal

Maak opgeslagen QR-records, automatiseer beheerde redirects en ontvang scanevents via asynchrone HMAC-ondertekende webhooks met gescopeerde Bearer API-sleutels.

curl -X POST https://www.jeffdash.com/api/v1/qr-codes \
  -H "Authorization: Bearer qrm_live_99e3123f34560647..." \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Summer Campaign Promo",
    "type": "url",
    "deliveryMode": "managed",
    "destination": "https://brand.example/summer-sale",
    "customization": {
      "fgColor": "#0f172a",
      "dotStyle": "dots"
    }
  }'
Voorbeeld · 201 Created
{
  "data": {
    "_id": "jd7abc123def456",
    "slug": "Summer99",
    "title": "Summer Campaign Promo",
    "type": "url",
    "deliveryMode": "managed",
    "destination": "https://brand.example/summer-sale",
    "isActive": true,
    "customization": {
      "fgColor": "#0f172a",
      "dotStyle": "dots"
    },
    "totalScans": 0,
    "password": false
  },
  "meta": {
    "message": "QR-code succesvol aangemaakt via API v1.",
    "isDynamic": true,
    "deliveryMode": "managed",
    "capabilities": {
      "isTrackable": true,
      "canEditWithoutReprint": true,
      "requiresInternet": true,
      "supportsManagedAccess": true,
      "supportsUrlRouting": true
    },
    "qrPayload": "https://www.jeffdash.com/r/Summer99",
    "publicRedirectUrl": "https://www.jeffdash.com/r/Summer99"
  }
}
Browserweergave
Zomercampagne
De REST API retourneert recorddata en de gezaghebbende QR-payload. Exporteer afbeeldingsbestanden vanuit het dashboard.
API-quickstart

Van sleutel naar geverifieerde integratie in 3 stappen

1. Genereer API Sleutel

Haal uw geheime `qrm_live_...` Bearer token op vanuit uw developer dashboard met 1 klik.

2. Maak QR Codes via REST POST

Stuur title, type, destination, een optionele deliveryMode en ondersteunde opmaakvelden; bulkverzoeken accepteren maximaal 500 records.

3. Ontvang Live Scan Webhooks

Ontvang asynchroon ingeplande events met HMAC-SHA256-headers en best-effort apparaat- en grove locatievelden.

Webhook fan-outplanner

Schat uw webhook-aflevervolume

Dit bovengrensscenario gaat ervan uit dat elk geselecteerd event naar elk ingesteld endpoint gaat. Het is een capaciteitsraming, geen uptime- of latencybelofte.

100.000 / mnd
10K250K500K1M+
5 endpoints
15 (standaard)1020+
Maximale kandidaat-afleveringen / maand:500.000
Ingestelde endpoints:5
Beveiliging per aflevering:6 s timeout · 64 KiB payload

Belangrijkste REST API v1 Endpoints

GET/api/v1/qr-codes

Haal de 100 recentste opgeslagen QR-records uit de geauthenticeerde werkruimte op.

POST/api/v1/qr-codes

Maak een native of beheerd QR-record met ondersteunde opmaak en capability-afhankelijke routeringsvelden.

PATCH/api/v1/qr-codes/:id

Werk ondersteunde recordvelden bij. Beheerde payloads wijzigen zonder herdruk; native payloads vereisen een nieuwe export. Geschikte native records kunnen eenmalig worden omgezet.

POST/api/v1/qr-codes/bulk

Maak maximaal 500 opgeslagen QR-records in één verzoek en ontvang per item een geïndexeerd succes- of foutresultaat.

Geïmplementeerde integratiecontroles

Beheerde resolverafhandeling

Managed records gebruiken een beheerde HTTP 302-route of gevalideerde resolveractie. Werkelijke latency hangt af van deployment en netwerkomstandigheden.

HMAC-SHA256 Webhook Beveiliging

Elk scan-event wordt cryptografisch ondertekend met een HMAC-handtekening ter verificatie van de afzender.

Afbeeldingsexport in dashboard

De API retourneert recorddata en een QR-payload. SVG-, PNG- en WEBP-export staat in het dashboard; er is nog geen SVG-assetendpoint.

Eigen Custom CNAME Domeinen

Verifieer eigendom vóór het koppelen van een hostnaam. Providerprovisioning en certificaten vereisen de ingestelde Vercel-integratie.

Privacybewuste scantelemetrie

Sla tijdstip, grove land/regio/stad, browser, OS, apparaatcategorie, referrer en UTM-velden op wanneer beschikbaar—nooit precieze GPS.

Rate limits per sleutel

Sleutels starten op 100 verzoeken per minuut en zijn instelbaar tot de actieve planlimiet. Er is geen publieke uptime-SLA tijdens de bèta.

Veelgestelde Vragen voor Developers

Hoe authenticeer ik API-verzoeken?

Alle verzoeken naar /api/v1/* vereisen een Bearer token in de Authorization header: `Authorization: Bearer qrm_live_...`. U kunt sleutels aanmaken en roteren in het Developer Dashboard.

Hoe zijn de webhooks beveiligd?

Elk webhook-verzoek bevat een `X-QRCodeMaster-Signature` header met een HMAC-SHA256 handtekening berekend met uw geheime sleutel, zodat u de authenticiteit direct kunt valideren.

Wat zijn de rate limits van de API?

Een sleutel start op 100 verzoeken per minuut. Tijdens de bèta zonder facturatie kunnen beheerders tot 10.000 per minuut instellen; het betaalplanbeleid wordt vastgelegd voordat enforcement wordt ingeschakeld.

Kan ik direct vector SVG bestanden genereren?

Nog niet via REST. De API retourneert recorddata en de gezaghebbende QR-payload. Open het opgeslagen record in het dashboard voor SVG-, PNG- of WEBP-export.

Start vandaag met bouwen op de QRCodeMaster API

API-toegang en webhooks zijn ingeschakeld zolang billing-enforcement tijdens de bèta uitstaat. Valideer de integratie in uw eigen omgeving vóór productiegebruik.

Maak Gratis Developer Account