API Arpelin

Principes

• Requêtes GET, réponses JSON (toujours un tableau), encodage UTF-8.
• Chaque établissement a son propre domaine ; l'API ne renvoie que les données de cet établissement.
• Aucune clé requise pour lister les commandes en cours. Seule l'adresse de livraison est réservée au personnel connecté (voir Authentification).
• Les statistiques, les articles et le stock demandent une clé secrète (voir Clés API).

URL de base

Remplacez votre-domaine.arpelin.fr par le domaine de l'établissement.

Authentification

Les points d'accès sont publics : aucun en-tête ni jeton n'est nécessaire.

Formats & erreurs

• Dates : chaînes AAAA-MM-JJ HH:MM:SS (fuseau du serveur).
• Montants : nombres décimaux en euros, séparateur point.
• etat est renvoyé sous forme de chaîne JSON : comparez avec == ou convertissez en nombre.

En cas d'échec, le code HTTP passe à 500 et le corps devient un objet :

{ "error": "Erreur lors de l'exécution de la requête : ..." }

Point d'accès — Commandes en cours

Le paramètre update sélectionne le mode de réponse :

Mode synthétique — GET /panel/api_gestion

Commandes dont l'horodatage debut est compris entre 12 h avant et 3 h après l'instant courant, avec un état actif (0.5 à 2). Livraisons terminées exclues. Une entrée par commande.

[
  { "prep": 42, "etat": "1",   "debut": "2026-09-09 12:04:11", "retrait": "sur place", "note": null,
    "file_attente": { "position": 0, "message": "C'est bientôt votre tour", "duree_preparation_min": 6, "duree_estimee_min": 6 } },
  { "prep": 43, "etat": "0.6", "debut": "2026-09-09 12:06:52", "retrait": "livraison", "note": "[Nom: Dupont] sans oignon",
    "file_attente": { "position": 0, "message": "Commande prête", "duree_preparation_min": 12, "duree_estimee_min": 0 } }
]

Sans le module Temps de préparation, la réponse est identique mais sans la clé file_attente.

Mode détaillé — GET /panel/api_gestion?update=1

Commandes du jour et de la veille (DATE(debut) ≥ hier) avec un état actif, livraisons terminées exclues. Une entrée par commande, avec le détail des articles.

Objet commandes[]

[
  {
    "panier_id": 10432,
    "heure": "2026-09-09 12:06:52",
    "retrait": "livraison",
    "total": 24.5,
    "commandes": [
      { "nom_article": "Burger maison", "infos_article": "sans oignon", "quantite": 2, "prix_article": 9.5 },
      { "nom_article": "Frites",        "infos_article": null,          "quantite": 1, "prix_article": 3.5 },
      { "nom_article": "Coca 33cl",     "infos_article": null,          "quantite": 1, "prix_article": 2.0 }
    ],
    "note": "[Nom: Dupont] 3e étage",
    "adresse": "••• 75011 Paris",
    "etat": "1",
    "prep": 43,
    "file_attente": {
      "position": 2,
      "message": "2 commandes avant vous",
      "duree_preparation_min": 25,
      "duree_estimee_min": 43
    }
  }
]

Objet file_attente

Ajouté à chaque commande des deux modes quand le module Temps de préparation est actif sur l'établissement (menu Modules → File d'attente du backoffice). Sans ce module, la clé est absente. Elle vaut null pour une commande sans numéro de préparation exploitable.

Codes d'état (etat)

Clés API (v1) : authentification

Les points d'accès /api/v1/stats, /api/v1/articles et /api/v1/stock sont privés : chaque appel doit porter une clé secrète, en lecture seule.

Créer une clé

1. Connectez-vous au backoffice avec un compte administrateur.
2. Ouvrez Paramètres avancés (/panel/config?config=advanced), section API : clés secrètes.
3. Donnez un nom à la clé, cochez les accès voulus (stats, articles, stock) puis cliquez sur Créer une clé.

Envoyer la clé

Dans l'en-tête de chaque requête, jamais dans l'URL :

Authorization: Bearer arp_votre_cle_secrete
# ou
X-API-Key: arp_votre_cle_secrete

Chaque clé ne donne accès qu'aux données de son établissement et aux seuls accès cochés à sa création. Toutes les requêtes sont en GET. Ne placez jamais une clé dans une page web publique ou une application distribuée : appelez l'API depuis un programme dont vous maîtrisez l'hébergement.

Statistiques : GET /api/v1/stats

Accès requis : stats. Renvoie les mêmes chiffres que la page Statistiques du backoffice : chiffre d'affaires, transactions, paiements, ventes par heure et par jour de la semaine, classement des articles, rentabilité et personnel. Les paniers annulés sont exclus.

Paramètres

Réponse

curl "https://votre-domaine.arpelin.fr/api/v1/stats?start_date=2026-09-01&end_date=2026-09-30&include=summary,payments" \
  -H "Authorization: Bearer arp_votre_cle_secrete"

{
  "period": { "start": "2026-09-01 00:00:00", "end": "2026-09-30 23:59:59", "granularity": "day" },
  "summary": {
    "revenue": 18420.5, "transactions": 912, "items_sold": 2210,
    "average_basket": 20.2, "average_item_price": 8.33,
    "best_period": { "period": "2026-09-27", "revenue": 1104.0 },
    "change_vs_previous_period_pct": { "revenue": 6.4, "transactions": 3.1, "basket": 3.2, "items": 4.9 }
  },
  "payments": [
    { "method": "Carte bancaire", "amount": 12980.3 },
    { "method": "Espèces", "amount": 5440.2 }
  ]
}

Articles : GET /api/v1/articles

Accès requis : articles. Les articles de la carte, comme dans la page Articles du backoffice, triés dans l'ordre d'affichage, avec pagination.

Objet articles[]

La réponse contient aussi total (nombre d'articles correspondant au filtre), limit et offset. Une catégorie (categories[]) porte id, name, description, enabled, order, subcategory_ids et images. Une personnalisation (customizations[]) porte id, category, type, name, price, enabled, max_quantity, extra_price_threshold, extra_price, cost et images.

curl "https://votre-domaine.arpelin.fr/api/v1/articles?category_id=3&enabled=1&limit=2" \
  -H "Authorization: Bearer arp_votre_cle_secrete"

{
  "total": 14, "limit": 2, "offset": 0,
  "articles": [
    { "id": 21, "name": "Burger maison", "description": "Boeuf, cheddar, salade",
      "category_id": 3, "category": "Burgers", "price": 9.5, "vat_rate": 10.0, "vat_code": null, "cost": 3.2,
      "enabled": true, "order": 1, "allergens": "gluten, lait", "barcode": null, "hide_price": false,
      "loyalty_points_cost": null, "stock": null, "stock_tracked": false,
      "images": ["https://votre-domaine.arpelin.fr/images/articles/burger.webp"],
      "customization_ids": [42, 43] }
  ]
}

Stock : GET /api/v1/stock

Accès requis : stock. Le stock des composants (ingrédients, emballages) tel qu'affiché dans l'onglet Stock du backoffice. Le stock d'un composant est théorique : dernier inventaire, plus les entrées, moins les pertes, la casse, les démarques et la consommation des ventes d'après les compositions.

curl "https://votre-domaine.arpelin.fr/api/v1/stock?include=components&status=rupture" \
  -H "Authorization: Bearer arp_votre_cle_secrete"

{
  "generated_at": "2026-09-09 14:30:02",
  "components": [
    { "id": 7, "name": "Steak haché", "unit": "kg", "theoretical_stock": 1.8, "status": "rupture",
      "unit_cost": 11.5, "stock_value": 20.7, "min_threshold": 3.0, "max_threshold": 12.0,
      "last_inventory_at": "2026-09-08 22:10:00", "last_inventory_gap": -0.4,
      "since_last_inventory": { "entries": 5.0, "losses": 0.3, "consumed_by_sales": 6.1 } }
  ]
}

Erreurs de l'API v1

Le corps d'une erreur est un objet { "error": "...", "message": "..." }.

Exemples

curl

# Mode synthétique
curl https://votre-domaine.arpelin.fr/panel/api_gestion

# Mode détaillé
curl "https://votre-domaine.arpelin.fr/panel/api_gestion?update=1"

# Mode détaillé avec adresse complète (session backoffice)
curl "https://votre-domaine.arpelin.fr/panel/api_gestion?update=1" \
  --cookie "PHPSESSID=VOTRE_ID_DE_SESSION"

JavaScript (navigateur)

async function chargerCommandes() {
  const res = await fetch('https://votre-domaine.arpelin.fr/panel/api_gestion', {
    credentials: 'include' // envoie le cookie de session si connecté au backoffice
  });
  if (!res.ok) throw new Error('HTTP ' + res.status);
  const commandes = await res.json();

  for (const c of commandes) {
    const prete = c.etat == 0.6 || c.etat == 2;
    console.log(`Prép ${c.prep} — ${prete ? 'PRÊTE' : 'en cours'}`);
  }
}

setInterval(chargerCommandes, 5000);
chargerCommandes();

Statistiques, articles et stock avec une clé (curl)

curl "https://votre-domaine.arpelin.fr/api/v1/stats?start_date=2026-09-01&end_date=2026-09-30" \
  -H "Authorization: Bearer arp_votre_cle_secrete"

curl "https://votre-domaine.arpelin.fr/api/v1/articles?include=categories,customizations" \
  -H "Authorization: Bearer arp_votre_cle_secrete"

curl "https://votre-domaine.arpelin.fr/api/v1/stock?include=components,alerts,movements" \
  -H "Authorization: Bearer arp_votre_cle_secrete"

Python

import requests

BASE = "https://votre-domaine.arpelin.fr/api/v1"
HEADERS = {"Authorization": "Bearer arp_votre_cle_secrete"}

stats = requests.get(f"{BASE}/stats", headers=HEADERS,
                     params={"start_date": "2026-09-01", "end_date": "2026-09-30",
                             "include": "summary,top_articles"}, timeout=30)
stats.raise_for_status()
print(stats.json()["summary"]["revenue"])

Extraire le nom du client depuis note

function nomClient(note) {
  if (!note) return null;
  const m = note.match(/\[(?:Nom|Name)[^:]*:\s*([^\]]+)\]/i);
  return m ? m[1].trim() : null;
}