Documentation / API v1
v1.0
ASSISTANT VOCAL INTELLIGENT

API pour les restaurants

Connectez l'interface de l'assistant vocal aux données et aux services du restaurant : informations générales, carte, livraison, clients et passage de commande.

Commencer l'intégration Voir l'API commande
Exemple HTTP 
GET /v1/?restaurant HTTP/1.1
Host: apiv1.demo-pizza.com
Authorization: Bearer YOUR_TOKEN
X-Restaurant-ID: 123
FORMAT JSON

Réponses structurées et simples à exploiter.

AUTH ID + Token

Une authentification propre à chaque restaurant.

VERSION API v1

Endpoints versionnés pour garantir la stabilité.

DÉMARRAGE

Authentification

Chaque restaurant dispose obligatoirement d'un identifiant unique et d'une clé API ou d'un token permettant d'autoriser les appels vers nos services.

i
Important

Le token doit être stocké côté serveur et ne doit jamais être exposé publiquement.

Attribut
Type
Obligatoire
Description
restaurant_id
integer
Oui
Identifiant unique du restaurant.
key
string
Oui
Clé d'authentification unique.
GET /v1/?restaurant

Informations du restaurant

Retourne les coordonnées, horaires et informations générales du restaurant.

Réponse

Les informations renvoyées peuvent être utilisées par l'assistant pour répondre aux questions du client.

200 OKJSON
{
  "success": true,
  "restaurant": {
    "id_resto": 123,
    "nom": "Restaurant Exemple",
    "telephone": "01 00 00 00 00",
    "adresse": "10 rue Exemple",
    "ville": "Paris",
    "code_postal": "75000",
    "specialite": "pizza",
    "horaires_livr": [],
    "horaires_emport": []
  }
}
GET /v1/delivery-cities

Villes de livraison

Retourne les zones de livraison et leurs conditions.

200 OKJSON
{
  "success": true,
  "delivery_cities": [
    {
      "id": 32,
      "nom": "Ville Exemple 75000",
      "frais_livraison": 0,
      "minimum_commande": 25,
      "delai": "00:45:00"
    }
  ]
}
GET /v1/customer

Informations client

Permet de rechercher les informations client nécessaires au traitement de la commande.

Paramètre
Type
Obligatoire
Description
telephone
string
Selon usage
Numéro de téléphone du client.
email
string
Non
Email du client s'il est disponible.
GET /v1/order-settings

Paramètres de commande

Retourne les modes de commande autorisés, moyens de paiement, règles de livraison et autres paramètres nécessaires au passage d'une commande.

200 OKJSON
{
  "success": true,
  "order_settings": {
    "modes": ["livraison", "emporter", "sur_place"],
    "paiement": ["especes", "carte"],
    "minimum_livraison": 25,
    "commande_ouverte": true
  }
}
POST /v1/orders

Insertion de commande

Permet à l'assistant vocal d'envoyer une commande validée vers le système du restaurant. La commande est ensuite réceptionnée par le logiciel de caisse pour traitement et impression.

Corps de la requête

Request BodyJSON
{
  "restaurant_id": 123,
  "client": {
    "nom": "Jean Dupont",
    "telephone": "0600000000"
  },
  "mode": "livraison",
  "ville_id": 32,
  "produits": [
    {
      "id_produit": 100,
      "quantite": 2,
      "options": []
    }
  ],
  "total": 25.80
}

Réponse

201 CreatedJSON
{
  "success": true,
  "commande": {
    "id_commande": 98765,
    "statut": "enregistree",
    "message": "Commande transmise au restaurant"
  }
}
RÉFÉRENCE

Codes d'erreur

200Succès

Requête traitée avec succès.

400Bad Request

Paramètres manquants ou invalides.

401Unauthorized

Token ou identifiant invalide.

403Forbidden

Accès non autorisé.

404Not Found

Ressource introuvable.

500Server Error

Erreur interne du serveur.

VERSION

Historique

v1.0 Version initiale

Authentification, restaurant, menu, livraison, client, paramètres et insertion de commande.