Services (MultiServiceService)

Le module MultiServiceServiceModule permet de gérer les services (prestations) offerts par les entreprises ou professionnels. Chaque service peut avoir des champs personnalisés pour collecter des informations lors de la prise de rendez-vous.

Accès : client.app.multiService.service

Méthodes

`create`

Crée un nouveau service avec ses champs personnalisés.

Exemple


const response = await client.app.multiService.service.create({
  appId: "app_id",
  apiKey: "user_api_key",
  name: "Coupe Homme",
  description: "Coupe aux ciseaux et tondeuse",
  basePrice: 1500,
  categories: ["coiffure", "homme"],
  fields: [
    {
      label: "Type de coupe",
      type: "SELECT",
      required: true,
      options: [
        { label: "Classique", value: "classique", price: 0 },
        { label: "Dégradé", value: "degrade", price: 500 },
        { label: "Avec barbe", value: "barbe", price: 1000 }
      ]
    },
    {
      label: "Commentaires",
      type: "TEXT",
      required: false,
      maxLength: 500
    }
  ]
});

Paramètres

Paramètres de base :

Champ	Type	Requis	Description
`appId`	string	Oui	ID de l’application
`apiKey`	string	Oui	Clé API de l’utilisateur
`name`	string	Oui	Nom du service (min 1 caractère)
`companyId`	string	Non	ID de l’entreprise (utilise l’entreprise par défaut si non fourni)
`description`	string	Non	Description du service
`icon`	string	Non	URL de l’icône du service
`iconId`	string	Non	ID du fichier icône (pour le suivi)
`basePrice`	integer	Non	Prix de base en plus petite unité monétaire
`categories`	string[]	Non	Tags de catégories
`fields`	ServiceField[]	Non	Champs personnalisés du formulaire

Structure ServiceField :

Champ	Type	Requis	Description
`label`	string	Oui	Libellé du champ (min 1 caractère)
`description`	string	Non	Description/aide pour le champ
`type`	FieldType	Oui	Type de champ (voir ci-dessous)
`required`	boolean	Non	Champ obligatoire (défaut: false)
`min`	integer	Non	Valeur minimale (pour NUMBER)
`max`	integer	Non	Valeur maximale (pour NUMBER)
`minLength`	integer	Non	Longueur minimale (pour TEXT)
`maxLength`	integer	Non	Longueur maximale (pour TEXT)
`regex`	string	Non	Pattern de validation regex
`multiplier`	boolean	Non	Multiplie le prix (défaut: false)
`useSelect`	boolean	Non	Utiliser Select Option dans le UI (défaut: false)
`options`	FieldOption[]	Non	Options pour les champs SELECT

Types de champs (FieldType) :

TEXT : Champ texte libre
NUMBER : Champ numérique
SELECT : Liste déroulante (choix unique)
MULTIPLE_SELECT : Sélection multiple
EMAIL : Adresse email
PHONE : Numéro de téléphone
DATE : Date

Structure FieldOption :

Champ	Type	Requis	Description
`label`	string	Oui	Libellé affiché
`value`	string	Oui	Valeur technique
`description`	string	Non	Description de l’option
`price`	integer	Non	Modificateur de prix

Réponse


{
  "success": true,
  "data": {
    "id": "service_id",
    "appId": "app_id",
    "companyId": "company_id",
    "slug": "coupe-homme",
    "name": "Coupe Homme",
    "description": "Coupe aux ciseaux et tondeuse",
    "icon": null,
    "basePrice": 1500,
    "categories": ["coiffure", "homme"],
    "createdAt": "2024-01-15T10:00:00.000Z",
    "updatedAt": "2024-01-15T10:00:00.000Z",
    "fields": [
      {
        "id": "field_id_1",
        "serviceId": "service_id",
        "label": "Type de coupe",
        "description": null,
        "type": "SELECT",
        "required": true,
        "min": null,
        "max": null,
        "minLength": null,
        "maxLength": null,
        "regex": null,
        "multiplier": false,
        "useSelect": false,
        "options": [
          {
            "id": "option_id_1",
            "fieldId": "field_id_1",
            "label": "Classique",
            "value": "classique",
            "description": null,
            "price": 0
          },
          {
            "id": "option_id_2",
            "fieldId": "field_id_1",
            "label": "Dégradé",
            "value": "degrade",
            "description": null,
            "price": 500
          }
        ]
      }
    ]
  }
}

Le champ slug est généré automatiquement à partir du nom du service et est unique par entreprise.

`list`

Liste les services disponibles.

Exemple


const response = await client.app.multiService.service.list({
  appId: "app_id",
  apiKey: "user_api_key"
});
 
// Parcourir les services
for (const service of response.data) {
  console.log(`${service.name} - ${service.basePrice}€`);
  console.log(`Champs: ${service.fields.length}`);
}

Paramètres

Champ	Type	Requis	Description
`appId`	string	Oui	ID de l’application
`apiKey`	string	Oui	Clé API de l’utilisateur

Actuellement, aucun filtre n’est disponible. Tous les services de l’application sont retournés.

Réponse


{
  "success": true,
  "data": [
    {
      "id": "service_id",
      "appId": "app_id",
      "companyId": "company_id",
      "slug": "coupe-homme",
      "name": "Coupe Homme",
      "description": "...",
      "icon": null,
      "basePrice": 1500,
      "categories": ["coiffure"],
      "createdAt": "2024-01-15T10:00:00.000Z",
      "updatedAt": "2024-01-15T10:00:00.000Z",
      "company": {
        "id": "company_id",
        "name": "Salon Belle Coiffure"
      },
      "fields": [...]
    }
  ]
}

`get`

Récupère les détails d’un service.

Exemple


const response = await client.app.multiService.service.get({
  appId: "app_id",
  apiKey: "user_api_key",
  id: "service_id"
});
 
if (response.success) {
  const service = response.data;
  console.log(`Service: ${service.name}`);
  console.log(`Prix de base: ${service.basePrice}`);
  console.log(`Nombre de champs: ${service.fields.length}`);
}

Paramètres

Champ	Type	Requis	Description
`appId`	string	Oui	ID de l’application
`apiKey`	string	Oui	Clé API de l’utilisateur
`id`	string	Oui	ID du service
`companyId`	string	Non	ID de l’entreprise (pour validation)

Réponse


{
  "success": true,
  "data": {
    "id": "service_id",
    "appId": "app_id",
    "companyId": "company_id",
    "slug": "coupe-homme",
    "name": "Coupe Homme",
    "description": "Coupe aux ciseaux et tondeuse",
    "icon": null,
    "basePrice": 1500,
    "categories": ["coiffure", "homme"],
    "createdAt": "2024-01-15T10:00:00.000Z",
    "updatedAt": "2024-01-15T10:00:00.000Z",
    "fields": [
      {
        "id": "field_id",
        "label": "Type de coupe",
        "type": "SELECT",
        "required": true,
        "options": [...]
      }
    ]
  }
}

Erreur possible :


{
  "success": false,
  "error": "service-not-found"
}

`update`

Met à jour un service existant.

Exemple


// Mise à jour simple (prix et description)
const response = await client.app.multiService.service.update({
  appId: "app_id",
  apiKey: "user_api_key",
  id: "service_id",
  companyId: "company_id",
  basePrice: 2000,
  description: "Nouvelle description"
});
 
// Mise à jour complète avec nouveaux champs
const response2 = await client.app.multiService.service.update({
  appId: "app_id",
  apiKey: "user_api_key",
  id: "service_id",
  companyId: "company_id",
  name: "Coupe Homme Premium",
  fields: [
    {
      label: "Type de prestation",
      type: "SELECT",
      required: true,
      options: [
        { label: "Standard", value: "standard", price: 0 },
        { label: "Premium", value: "premium", price: 1000 }
      ]
    }
  ]
});

Paramètres

Champ	Type	Requis	Description
`appId`	string	Oui	ID de l’application
`apiKey`	string	Oui	Clé API de l’utilisateur
`id`	string	Oui	ID du service à modifier
`companyId`	string	Oui	ID de l’entreprise (pour autorisation)

Champs modifiables (tous optionnels) :

name : Nom du service
description : Description
icon : URL de l’icône
iconId : ID du fichier icône
basePrice : Prix de base
categories : Tags de catégories
fields : Champs personnalisés

Si vous fournissez le champ fields, tous les champs existants seront supprimés et remplacés par les nouveaux. C’est un remplacement complet, pas une mise à jour partielle.

Réponse


{
  "success": true,
  "data": {
    "id": "service_id",
    "name": "Coupe Homme Premium",
    "basePrice": 2000,
    "fields": [...]
  }
}

`delete`

Supprime un service.

Exemple


const response = await client.app.multiService.service.delete({
  appId: "app_id",
  apiKey: "user_api_key",
  id: "service_id"
});
 
if (response.success) {
  console.log("Service supprimé avec succès");
}

Paramètres

Champ	Type	Requis	Description
`appId`	string	Oui	ID de l’application
`apiKey`	string	Oui	Clé API de l’utilisateur
`id`	string	Oui	ID du service à supprimer
`companyId`	string	Non	ID de l’entreprise

La suppression d’un service entraîne la suppression en cascade de :

Tous les champs du service
Toutes les options des champs
Tous les rendez-vous associés à ce service

Réponse


{
  "success": true,
  "data": true
}

Erreur possible :


{
  "success": false,
  "error": "service-not-found"
}

Exemples avancés

Service avec calcul de prix dynamique


// Service de nettoyage avec prix basé sur la surface
const cleaningService = await client.app.multiService.service.create({
  appId: "app_id",
  apiKey: "user_api_key",
  name: "Nettoyage à domicile",
  basePrice: 5000, // Prix de base
  fields: [
    {
      label: "Surface (m²)",
      type: "NUMBER",
      required: true,
      min: 10,
      max: 500,
      multiplier: true, // Le prix sera multiplié par cette valeur
    },
    {
      label: "Services additionnels",
      type: "MULTIPLE_SELECT",
      required: false,
      options: [
        { label: "Vitres", value: "vitres", price: 2000 },
        { label: "Repassage", value: "repassage", price: 3000 },
        { label: "Four/Frigo", value: "electromenager", price: 1500 },
      ],
      useSelect: true, // Pour configurer le UI d'une certaine maniere
    },
  ],
});

Service avec validation de champs


// Service médical avec validation stricte
const medicalService = await client.app.multiService.service.create({
  appId: "app_id",
  apiKey: "user_api_key",
  name: "Consultation médicale",
  basePrice: 15000,
  fields: [
    {
      label: "Email de confirmation",
      type: "EMAIL",
      required: true,
    },
    {
      label: "Téléphone",
      type: "PHONE",
      required: true,
    },
    {
      label: "Date de naissance",
      type: "DATE",
      required: true,
    },
    {
      label: "Numéro de sécurité sociale",
      type: "TEXT",
      required: true,
      minLength: 13,
      maxLength: 15,
      regex: "^[0-9]{13,15}$",
    },
  ],
});

Gestion des erreurs

Code erreur	Description
`service-not-found`	Le service n’existe pas ou n’appartient pas à l’entreprise
`not-authorized`	La clé API n’a pas les droits nécessaires
`app-not-found`	L’application n’existe pas