API documentation

curl --fail-with-body "https://preprod.qrissimo.fr/api/v1/qr-codes/$QR_ID/history" \
  -H "Authorization: Bearer $QRISSIMO_TOKEN" -H 'Accept: application/json'
curl --fail-with-body -X POST "https://preprod.qrissimo.fr/api/v1/qr-codes/$QR_ID/history/$VERSION_ID/restore" \
  -H "Authorization: Bearer $QRISSIMO_TOKEN" \
  -H 'Content-Type: application/json' \
  -d "{\"revision\":\"$REVISION\"}"

curl --fail-with-body 'https://preprod.qrissimo.fr/api/v1/qr-codes/42/png?size=1024&composition=1&transparent=1' \
  -H "Authorization: Bearer $QRISSIMO_TOKEN" -o qr.png
curl --fail-with-body 'https://preprod.qrissimo.fr/api/v1/qr-codes/42/jpeg?size=2048&composition=1' \
  -H "Authorization: Bearer $QRISSIMO_TOKEN" -o qr.jpg

{"destination":"https://example.com/event","composition":true,"template":"plain","caption":"Scan me","arrow":"curve","caption_position":"bottom","caption_offset":50,"caption_scale":120,"caption_align":"center","size":2048}

{"composition":true,"destination":"https://example.com/event","caption":"Scan me","caption_font":"caveat","caption_rotation":-15,"caption_position":"bottom","arrow":"curve","caption_dx":-30,"arrow_dx":40,"composition_layers":"logo-arrow-text","size":2048}

{"destination":"https://example.com/catalogue","color_mode":"linear","foreground":"#182B2A","background":"#FFFFFF","gradient_color":"#164F72","gradient_angle":135,"size":1024}

curl --fail-with-body -X POST 'https://preprod.qrissimo.fr/api/v1/qr-images' \
  -H "Authorization: Bearer $QRISSIMO_TOKEN" -H 'Content-Type: application/json' \
  -d '{"destination":"https://example.com/event","format":"png","size":512,"modules":"rounded","finders":"rounded"}' \
  -o email-qr.png

curl --fail-with-body -X POST 'https://preprod.qrissimo.fr/api/v1/qr-images' \
  -H "Authorization: Bearer $QRISSIMO_TOKEN" -H 'Content-Type: application/json' \
  -d '{"destination":"https://example.com/event","composition":true,"template":"vinyl","caption":"Scan me","arrow":"curve","size":1024,"transparent":true}' \
  -o event-design.png

const response = await fetch(base + '/qr-images', {
  method: 'POST', headers,
  body: JSON.stringify({ destination: 'https://example.com/event', size: 512 }),
});
if (!response.ok) throw new Error('QRissimo ' + response.status + ': ' + await response.text());
const qrImage = Buffer.from(await response.arrayBuffer());
const email = {
  html: '<p>Your event</p><img src="cid:event-qr" width="176" height="176" alt="Event QR">',
  attachments: [{ filename: 'event-qr.png', content: qrImage,
    contentType: 'image/png', cid: 'event-qr' }],
};
// Add this content to your server-side Nodemailer message.

from email.message import EmailMessage

response = session.post(f'{base}/qr-images', timeout=15, json={
    'destination': 'https://example.com/event', 'size': 512,
})
response.raise_for_status()
message = EmailMessage()
message.set_content('Your event: https://example.com/event')
message.add_alternative('<img src="cid:event-qr" width="176" height="176" alt="Event QR">', subtype='html')
message.get_payload()[-1].add_related(response.content,
    maintype='image', subtype='png', cid='<event-qr>')
# Send message through your application's own SMTP configuration.

curl -X POST 'https://preprod.qrissimo.fr/api/v1/qr-codes' \
  -H "Authorization: Bearer $QRISSIMO_TOKEN" \
  -H 'Content-Type: application/json' -H 'Accept: application/json' \
  -H 'Idempotency-Key: guest-wifi-1' \
  -d '{"label":"Guest network","content_type":"wifi","kind":"static","wifi_ssid":"Guest","wifi_security":"nopass"}'

const response = await fetch(base + '/qr-codes', {
  method: 'POST', headers: { ...headers, 'Idempotency-Key': 'contact-1' },
  body: JSON.stringify({ label: 'Contact', content_type: 'vcard',
    contact_first: 'Camille', contact_phone: '+33612345678' }),
});
if (!response.ok) throw new Error('QRissimo ' + response.status + ': ' + await response.text());
const { data } = await response.json();
console.log(data.short_url);

response = session.post(f'{base}/qr-codes', timeout=15,
    headers={'Idempotency-Key': 'sms-1'},
    json={'label': 'Message', 'content_type': 'sms', 'kind': 'static',
          'phone': '+33612345678', 'message': 'Bonjour'})
response.raise_for_status()
print(response.json()['data']['id'])

curl 'https://preprod.qrissimo.fr/api/v1/catalog?locale=fr' \
  -H "Authorization: Bearer $QRISSIMO_TOKEN" -H 'Accept: application/json'

curl -X PATCH 'https://preprod.qrissimo.fr/api/v1/qr-codes/42/appearance' \
  -H "Authorization: Bearer $QRISSIMO_TOKEN" \
  -H 'Content-Type: application/json' -H 'Accept: application/json' \
  -d '{"template":"vinyl","caption":"Scannez-moi !","arrow":"curve","modules":"rounded","finders":"circle","foreground":"#182B2A","background":"#FFFFFF"}'

const response = await fetch(base + '/qr-codes/42/appearance', {
  method: 'PATCH', headers,
  body: JSON.stringify({ template: 'car', arrow: 'curve' }),
});
if (!response.ok) throw new Error('QRissimo ' + response.status + ': ' + await response.text());
const { data } = await response.json();

response = session.patch(f'{base}/qr-codes/42/appearance', timeout=15,
    json={'template': 'vinyl', 'arrow': 'wave'})
response.raise_for_status()
print(response.json()['data']['style'])

• Essential · plain
• Signature · card
• Badge · round
• Seal · seal
• Viewfinder · corners
• Bracket · bracket
• Bubble · bubble
• Tag · tag
• Ticket · ticket
• Band · band
• Snapshot · polaroid
• Heart · heart
• Arch · arch
• Fold · fold
• Capsule · capsule
• Hexagon · hexagon
• Orbit · orbit
• Echo · ripple
• Editorial · editorial
• Rails · rails
• Ribbon · ribbon
• Pennant · pennant
• Markers · grid
• Rosette · rosette

• Car · car
• Van · van
• Bus · bus
• Cargo bike · bicycle
• Rocket · rocket
• Airplane · plane
• Boat · boat
• Train · train

• Cat · cat
• Dog · dog
• Panda · bear
• Fox · fox
• Rabbit · rabbit
• Owl · owl
• Butterfly · butterfly
• Flower · flower
• Leaf · leaf
• Tree · tree

• House · house
• Camera · camera
• Phone · phone
• Laptop · laptop
• Cup · cup
• Book · book
• Light bulb · bulb
• Gift · gift
• Bottle · bottle
• Padlock · lock

• Game controller · gamepad
• Football · football
• Basketball · basketball
• Music notes · music
• Vinyl record · vinyl
• Clapperboard · cinema
• Palette · palette
• Crown · crown

curl -X POST 'https://preprod.qrissimo.fr/api/v1/qr-codes' \
  -H "Authorization: Bearer $QRISSIMO_TOKEN" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: panneau-123' \
  -d '{"label":"Panneau 123","destination":"https://example.com/panneau/123"}'

curl 'https://preprod.qrissimo.fr/api/v1/qr-codes/42/svg' \
  -H "Authorization: Bearer $QRISSIMO_TOKEN" -o panneau.svg

curl -X POST 'https://preprod.qrissimo.fr/api/v1/qr-codes' \
  -H "Authorization: Bearer $QRISSIMO_TOKEN" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: voiture-456' \
  -d '{"label":"Voiture","destination":"https://example.com/auto","template":"car","caption":"Scannez-moi !","arrow":"curve"}'

curl 'https://preprod.qrissimo.fr/api/v1/qr-codes/43/svg?composition=1' \
  -H "Authorization: Bearer $QRISSIMO_TOKEN" -o voiture.svg

curl -X PATCH 'https://preprod.qrissimo.fr/api/v1/qr-codes/42' \
  -H "Authorization: Bearer $QRISSIMO_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"destination":"https://example.com/panneau/456"}'

curl -X PATCH 'https://preprod.qrissimo.fr/api/v1/qr-codes/42/state' \
  -H "Authorization: Bearer $QRISSIMO_TOKEN" \
  -H 'Content-Type: application/json' -H 'Accept: application/json' \
  -d '{"disabled":false}'

const base = 'https://preprod.qrissimo.fr/api/v1';
const headers = {
  Authorization: `Bearer ${process.env.QRISSIMO_TOKEN}`,
  Accept: 'application/json',
  'Content-Type': 'application/json',
};
const response = await fetch(`${base}/qr-codes`, {
  method: 'POST',
  headers: { ...headers, 'Idempotency-Key': 'panneau-123' },
  body: JSON.stringify({ label: 'Panneau 123', destination: 'https://example.com/panneau/123' }),
});
if (!response.ok) throw new Error(`QRissimo ${response.status}: ${await response.text()}`);
const { data } = await response.json();
const stats = await fetch(`${base}/qr-codes/${data.id}/statistics`, { headers });
if (!stats.ok) throw new Error(`QRissimo ${stats.status}`);
console.log(await stats.json());

import os
import requests

base = 'https://preprod.qrissimo.fr/api/v1'
session = requests.Session()
session.headers.update({
    'Authorization': f'Bearer {os.environ["QRISSIMO_TOKEN"]}',
    'Accept': 'application/json',
})
response = session.post(f'{base}/qr-codes', timeout=15,
    headers={'Idempotency-Key': 'panneau-123'},
    json={'label': 'Panneau 123', 'destination': 'https://example.com/panneau/123'})
response.raise_for_status()
code = response.json()['data']
svg = session.get(f'{base}/qr-codes/{code["id"]}/svg', timeout=15)
svg.raise_for_status()
with open('panneau.svg', 'wb') as output:
    output.write(svg.content)

curl 'https://preprod.qrissimo.fr/api/v1/statistics?from=2026-10-01&to=2026-10-31&timezone=Europe%2FParis' \
  -H "Authorization: Bearer $QRISSIMO_TOKEN" -H 'Accept: application/json'

curl -X POST 'https://preprod.qrissimo.fr/api/v1/campaigns' \
  -H "Authorization: Bearer $QRISSIMO_TOKEN" -H 'Content-Type: application/json' \
  -d '{"name":"Collection automne"}'

curl -X POST 'https://preprod.qrissimo.fr/api/v1/campaigns/7/codes' \
  -H "Authorization: Bearer $QRISSIMO_TOKEN" -H 'Content-Type: application/json' \
  -d '{"action":"add","codes":[42,43]}'

curl -X PATCH 'https://preprod.qrissimo.fr/api/v1/qr-codes/42' \
  -H "Authorization: Bearer $QRISSIMO_TOKEN" -H 'Content-Type: application/json' \
  -d '{"starts_at":"2026-11-01T09:00","ends_at":"2026-11-30T18:00","timezone":"Europe/Paris","fallback_url":"https://example.com/fin"}'

const params = new URLSearchParams({
  from: '2026-10-01', to: '2026-10-31',
  timezone: 'Europe/Paris', campaign_id: '7',
});
const response = await fetch(base + '/statistics?' + params, { headers });
if (!response.ok) throw new Error('QRissimo ' + response.status + ': ' + await response.text());
const { data } = await response.json();
console.log(data.summary, data.daily);

response = session.get(f'{base}/statistics', timeout=15, params={
    'from': '2026-10-01', 'to': '2026-10-31',
    'timezone': 'Europe/Paris', 'campaign_id': 7,
})
response.raise_for_status()
report = response.json()['data']
print(report['summary'], report['daily'])

curl 'https://preprod.qrissimo.fr/api/v1/batches' \
  -H "Authorization: Bearer $QRISSIMO_TOKEN" \
  -H 'Content-Type: application/json' -H 'Accept: application/json' \
  -H 'Idempotency-Key: menus-2026-10' \
  -d '{"kind":"static","template":"vinyl","caption":"Scannez-moi","arrow":"curve","rows":[{"label":"Menu","destination":"https://example.com/menu","reference":"00042"}]}'

curl "https://preprod.qrissimo.fr/api/v1/batches/$BATCH_ID/confirm" \
  -H "Authorization: Bearer $QRISSIMO_TOKEN" \
  -H 'Content-Type: application/json' -H 'Accept: application/json' \
  -d "{\"revision\":\"$REVISION\",\"exclude_invalid\":false}"

curl "https://preprod.qrissimo.fr/api/v1/batches/$BATCH_ID/svg.zip" \
  -H "Authorization: Bearer $QRISSIMO_TOKEN" \
  --fail-with-body -o lot.zip

curl 'https://preprod.qrissimo.fr/api/v1/batches' \
  -H "Authorization: Bearer $QRISSIMO_TOKEN" -H 'Accept: application/json' \
  -H 'Idempotency-Key: fichier-menus-2026-10' -F 'file=@menus.csv'

curl -X PATCH "https://preprod.qrissimo.fr/api/v1/batches/$BATCH_ID/mapping" \
  -H "Authorization: Bearer $QRISSIMO_TOKEN" \
  -H 'Content-Type: application/json' -H 'Accept: application/json' \
  -d '{"revision":null,"mapping":{"label":0,"destination":1,"reference":2},"kind":"static","template":"car"}'

const prepared = await fetch(base + '/batches', {
  method: 'POST', headers: { ...headers, 'Idempotency-Key': 'menus-2026-10' },
  body: JSON.stringify({ kind: 'static', template: 'vinyl', rows: [
    { label: 'Menu', destination: 'https://example.com/menu', reference: '00042' },
  ] }),
});
if (!prepared.ok) throw new Error('QRissimo ' + prepared.status + ': ' + await prepared.text());
const { data: batch } = await prepared.json();
if (batch.summary.invalid) throw new Error('Review invalid rows before confirming');
const confirmed = await fetch(base + '/batches/' + batch.id + '/confirm', {
  method: 'POST', headers, body: JSON.stringify({ revision: batch.revision }),
});
if (!confirmed.ok) throw new Error('QRissimo ' + confirmed.status + ': ' + await confirmed.text());
const result = (await confirmed.json()).data;
console.log(result.summary.created);

prepared = session.post(f'{base}/batches', timeout=30,
    headers={'Idempotency-Key': 'menus-2026-10'}, json={
      'kind': 'static', 'template': 'vinyl', 'rows': [
        {'label': 'Menu', 'destination': 'https://example.com/menu', 'reference': '00042'}]})
prepared.raise_for_status()
batch = prepared.json()['data']
if batch['summary']['invalid']:
    raise ValueError('Review invalid rows before confirming')
confirmed = session.post(f'{base}/batches/{batch["id"]}/confirm', timeout=60,
    json={'revision': batch['revision']})
confirmed.raise_for_status()
print(confirmed.json()['data']['summary'])

curl -X POST 'https://preprod.qrissimo.fr/api/v1/print-sheets' \
  -H "Authorization: Bearer $QRISSIMO_TOKEN" \
  -H 'Content-Type: application/json' -H 'Accept: application/pdf' \
  -d '{"codes":[42,43],"layout":12,"labels":true}' \
  --fail-with-body -o planche.pdf

import { writeFile } from 'node:fs/promises';
const sheet = await fetch(base + '/print-sheets', {
  method: 'POST', headers: { ...headers, Accept: 'application/pdf' },
  body: JSON.stringify({ codes: [42, 43], layout: 12, labels: true }),
});
if (!sheet.ok) throw new Error('QRissimo ' + sheet.status + ': ' + await sheet.text());
await writeFile('planche.pdf', Buffer.from(await sheet.arrayBuffer()));

sheet = session.post(f'{base}/print-sheets', timeout=60,
    headers={'Accept': 'application/pdf'},
    json={'codes': [42, 43], 'layout': 12, 'labels': True})
sheet.raise_for_status()
with open('planche.pdf', 'wb') as output:
    output.write(sheet.content)

curl --fail-with-body -X POST 'https://preprod.qrissimo.fr/api/v1/style-kits' \
  -H "Authorization: Bearer $QRISSIMO_TOKEN" -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $REQUEST_UUID" \
  -d '{"name":"Studio","modules":"rounded","finders":"rounded","foreground":"#182B2A","background":"#FFFFFF","template":"card","caption":"Scan","arrow":"curve"}'
curl --fail-with-body 'https://preprod.qrissimo.fr/api/v1/style-kits?archived=1' \
  -H "Authorization: Bearer $QRISSIMO_TOKEN" -H 'Accept: application/json'

curl --fail-with-body -X POST 'https://preprod.qrissimo.fr/api/v1/qr-codes' \
 -H "Authorization: Bearer $QRISSIMO_TOKEN" -H 'Content-Type: application/json' \
 -H 'Idempotency-Key: page-menu-2026-10' \
 -d '{"label":"Menu","kind":"dynamic","content_type":"page","page_type":"menu","modules":"rounded","finders":"rounded","foreground":"#182B2A","background":"#FFFFFF"}'

curl --fail-with-body -X PUT "https://preprod.qrissimo.fr/api/v1/pages/$PAGE_ID" \
 -H "Authorization: Bearer $QRISSIMO_TOKEN" -H 'Content-Type: application/json' \
 --data-binary @draft.json

curl --fail-with-body "https://preprod.qrissimo.fr/api/v1/pages/$PAGE_ID/preview?revision=$REVISION&lang=fr" \
 -H "Authorization: Bearer $QRISSIMO_TOKEN" -o private-preview.html

curl --fail-with-body -X POST "https://preprod.qrissimo.fr/api/v1/pages/$PAGE_ID/publish" \
 -H "Authorization: Bearer $QRISSIMO_TOKEN" -H 'Content-Type: application/json' \
 -d "{\"revision\":\"$REVISION\",\"preview_token\":\"$PREVIEW_TOKEN\",\"confirmed\":true}"

{
 "revision": "CURRENT_REVISION_UUID",
 "locale": "fr", "default_locale": "fr",
 "brand_name": "Le Jardin", "accent": "#182B2A",
 "title": "Notre menu", "intro": "Une cuisine de saison.",
 "blocks": [{"type":"menu_item", "title":"Le plat du jour",
   "body":"Description du restaurant", "price":"Prix fourni par le restaurant",
   "allergens":"Allergènes renseignés par le restaurant"}]
}

const read = await fetch(base + '/pages/' + pageId, { headers });
if (!read.ok) throw new Error('QRissimo ' + read.status);
const current = (await read.json()).data;
const saved = await fetch(base + '/pages/' + pageId, {
 method: 'PUT', headers,
 body: JSON.stringify({ revision: current.revision, locale: 'en',
  default_locale: current.draft.default_locale,
  brand_name: current.draft.brand.name, accent: current.draft.brand.accent,
  title: 'Welcome', intro: 'Your company content.', blocks: [] }),
});
if (!saved.ok) throw new Error('QRissimo ' + saved.status + ': ' + await saved.text());
const next = (await saved.json()).data;
// Explicitly review the saved draft before publishing all variants.
console.log(base + '/pages/' + pageId + '/preview?revision=' + next.revision);

response = session.get(f'{base}/pages/{page_id}', timeout=15)
response.raise_for_status()
current = response.json()['data']
# Review every draft variant before explicit publication.
publication = session.post(f'{base}/pages/{page_id}/publish', timeout=30,
 json={'revision': current['revision'],
       'preview_token': current['preview_token'], 'confirmed': True})
publication.raise_for_status()

curl --fail-with-body -X POST "https://preprod.qrissimo.fr/api/v1/pages/$PAGE_ID/media" \
 -H "Authorization: Bearer $QRISSIMO_TOKEN" -H 'Accept: application/json' \
 -F 'file=@guide.pdf' -F 'name=Guide' \
 -F "revision=$REVISION" -F "request_id=$REQUEST_UUID"

curl --fail-with-body "https://preprod.qrissimo.fr/api/v1/pages/$PAGE_ID/media/$ASSET_ID" \
 -H "Authorization: Bearer $QRISSIMO_TOKEN" -o guide.pdf

{"type":"document", "asset_id":"ASSET_UUID", "title":"Guide",
 "body":"An accessible summary for this document."}

{"type":"image", "asset_id":"ASSET_UUID", "title":"",
 "alt":"A useful description of the photo.", "body":"Optional caption."}

curl -X PUT "$QRISSIMO_URL/api/v1/restaurants/$PAGE_ID" \
  -H "Authorization: Bearer $QRISSIMO_TOKEN" -H 'Content-Type: application/json' \
  --data @menu-fr.json

curl "$QRISSIMO_URL/api/v1/restaurants/$PAGE_ID/preview?revision=$REVISION" \
  -H "Authorization: Bearer $QRISSIMO_TOKEN"

curl -X POST "$QRISSIMO_URL/api/v1/restaurants/$PAGE_ID/publish" \
  -H "Authorization: Bearer $QRISSIMO_TOKEN" -H 'Content-Type: application/json' \
  --data '{"revision":"REVISION_UUID","preview_token":"TOKEN_FROM_PREVIEW","confirmed":true,"notification_mode":"me"}'

{
    "revision": "CURRENT_REVISION_OR_NULL",
    "locale": "fr",
    "currency": "EUR",
    "timezone": "Europe\/Paris",
    "require_preorder": false,
    "lead_minutes": 60,
    "cancel_hours": 24,
    "max_guests": 8,
    "privacy": "Explain who receives responses, why, and how people can exercise their rights. Registration is not marketing consent.",
    "terms": "The restaurant will confirm your request. Seats and dishes are reserved only after approval.",
    "items": [
        {
            "id": "ITEM_UUID",
            "name": "Dish or set menu",
            "price": "12.50",
            "available": true,
            "max_quantity": 8,
            "stock": 20,
            "options": [
                {
                    "id": "OPTION_UUID",
                    "label": "Option name",
                    "price_cents": 230
                }
            ]
        }
    ],
    "slots": [
        {
            "id": "SLOT_UUID",
            "date": "2026-11-01",
            "time": "19:30",
            "duration_minutes": 120,
            "capacity": 32,
            "enabled": true
        }
    ]
}

const result = await fetch(base + '/restaurant-requests', {
  method: 'POST', headers,
  body: JSON.stringify({
    menu_id: menuId, menu_revision: publishedRevision,
    request_id: crypto.randomUUID(), locale: 'fr',
    selection: [{ id: itemId, quantity: 2, options: [optionId] }],
    slot_id: slotId, guests: 2, name: 'Example', email: 'guest@example.com',
    email_followup: false, confirmed: true,
  }),
});
if (!result.ok) throw new Error(await result.text());
const { data } = await result.json(); // pending; id/status/revision only

response = session.post(base + '/restaurant-requests/' + request_id + '/decision',
    timeout=15, json={
        'revision': current_revision, 'action': 'confirm', 'confirmed': True,
    })
response.raise_for_status()
# 409: reload the request and quote. Never force confirmation or change the revision blindly.
# 422: capacity, stock or another field must be reviewed.

curl --fail-with-body "$QRISSIMO_URL/api/v1/restaurants/$PAGE_ID/preparation.pdf?slot_id=$SLOT_ID" \
  -H "Authorization: Bearer $QRISSIMO_TOKEN" -o restaurant-service.pdf
# Independent scope: restaurants:export. 409 means the preparation changed during rendering.