API Modèles de Champs

Endpoints pour la gestion des modèles de champs réutilisables dans vos services multi-service.

SDK: client.multiService.fieldTemplate

Les modèles de champs permettent de créer des champs de formulaire réutilisables pour vos services. Ils définissent la structure et les contraintes de validation des données collectées lors de la création de rendez-vous.

Endpoints

Lister les modèles

Liste tous les modèles de champs de l’application.


POST /app/{appId}/multi-service/fields/list

Requête

Champ	Type	Requis	Description
`apiKey`	string	Oui	Clé API


curl -X POST https://api.applite.ai/app/{appId}/multi-service/fields/list \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "your_api_key"
  }'

Réponse


{
  "success": true,
  "data": [
    {
      "id": "template_123",
      "appId": "app_id",
      "ref": "quantity",
      "label": "Quantité",
      "description": "Nombre d'unités souhaitées",
      "type": "NUMBER",
      "min": 1,
      "max": 100,
      "minLength": null,
      "maxLength": null,
      "regex": null,
      "required": true,
      "multiplier": true,
      "useSelect": false,
      "options": [],
      "createdAt": "2024-01-15T10:00:00.000Z",
      "updatedAt": "2024-01-15T10:00:00.000Z"
    },
    {
      "id": "template_456",
      "appId": "app_id",
      "ref": "service_type",
      "label": "Type de service",
      "description": null,
      "type": "SELECT",
      "min": null,
      "max": null,
      "minLength": null,
      "maxLength": null,
      "regex": null,
      "required": true,
      "multiplier": false,
      "useSelect": true,
      "options": [
        {
          "id": "opt_1",
          "templateId": "template_456",
          "label": "Standard",
          "value": "standard",
          "description": "Service standard",
          "price": 0
        },
        {
          "id": "opt_2",
          "templateId": "template_456",
          "label": "Premium",
          "value": "premium",
          "description": "Service premium avec priorité",
          "price": 5000
        }
      ],
      "createdAt": "2024-01-10T08:00:00.000Z",
      "updatedAt": "2024-01-10T08:00:00.000Z"
    }
  ]
}

Erreurs

Code	Description
`not-authorized`	Clé API invalide
`app-not-found`	Application non trouvée

Créer un modèle

Crée un nouveau modèle de champ.


POST /app/{appId}/multi-service/fields/create

Requête

Champ	Type	Requis	Description
`apiKey`	string	Oui	Clé API
`label`	string	Oui	Libellé du champ
`type`	string	Oui	Type: `TEXT`, `NUMBER`, `SELECT`, `MULTIPLE_SELECT`, `EMAIL`, `PHONE`, `DATE`, `ADDRESS`
`ref`	string	Non	Référence unique pour identifier le champ
`description`	string	Non	Description du champ
`min`	number	Non	Valeur minimale (pour NUMBER)
`max`	number	Non	Valeur maximale (pour NUMBER)
`minLength`	number	Non	Longueur minimale (pour TEXT)
`maxLength`	number	Non	Longueur maximale (pour TEXT)
`regex`	string	Non	Expression régulière de validation
`required`	boolean	Non	Champ obligatoire (défaut: false)
`multiplier`	boolean	Non	Utiliser comme multiplicateur de prix (défaut: false)
`useSelect`	boolean	Non	Afficher comme liste déroulante (défaut: false)
`options`	array	Non	Options pour SELECT/MULTIPLE_SELECT

Structure d’une option :

Champ	Type	Requis	Description
`label`	string	Oui	Libellé de l’option
`value`	string	Oui	Valeur de l’option
`description`	string	Non	Description
`price`	number	Non	Supplément de prix


curl -X POST https://api.applite.ai/app/{appId}/multi-service/fields/create \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "your_api_key",
    "ref": "delivery_zone",
    "label": "Zone de livraison",
    "description": "Sélectionnez votre zone",
    "type": "SELECT",
    "required": true,
    "options": [
      {
        "label": "Zone 1 - Centre",
        "value": "zone_1",
        "price": 1000
      },
      {
        "label": "Zone 2 - Périphérie",
        "value": "zone_2",
        "price": 2000
      }
    ]
  }'

Réponse


{
  "success": true,
  "data": {
    "id": "template_789",
    "appId": "app_id",
    "ref": "delivery_zone",
    "label": "Zone de livraison",
    "description": "Sélectionnez votre zone",
    "type": "SELECT",
    "min": null,
    "max": null,
    "minLength": null,
    "maxLength": null,
    "regex": null,
    "required": true,
    "multiplier": false,
    "useSelect": false,
    "options": [
      {
        "id": "opt_new_1",
        "templateId": "template_789",
        "label": "Zone 1 - Centre",
        "value": "zone_1",
        "description": null,
        "price": 1000
      },
      {
        "id": "opt_new_2",
        "templateId": "template_789",
        "label": "Zone 2 - Périphérie",
        "value": "zone_2",
        "description": null,
        "price": 2000
      }
    ],
    "createdAt": "2024-01-20T14:30:00.000Z",
    "updatedAt": "2024-01-20T14:30:00.000Z"
  }
}

Erreurs

Code	Description
`not-authorized`	Clé API invalide
`invalid-request`	Paramètres manquants ou invalides

Mettre à jour un modèle

Met à jour un modèle de champ existant.


POST /app/{appId}/multi-service/fields/{id}/edit

Requête

Champ	Type	Requis	Description
`apiKey`	string	Oui	Clé API
`label`	string	Non	Nouveau libellé
`type`	string	Non	Nouveau type
`ref`	string	Non	Nouvelle référence
`description`	string	Non	Nouvelle description
`min`	number	Non	Nouvelle valeur min
`max`	number	Non	Nouvelle valeur max
`minLength`	number	Non	Nouvelle longueur min
`maxLength`	number	Non	Nouvelle longueur max
`regex`	string	Non	Nouvelle regex
`required`	boolean	Non	Nouveau statut obligatoire
`multiplier`	boolean	Non	Nouveau statut multiplicateur
`useSelect`	boolean	Non	Nouveau mode sélection
`options`	array	Non	Nouvelles options (remplace les existantes)


curl -X POST https://api.applite.ai/app/{appId}/multi-service/fields/{templateId}/edit \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "your_api_key",
    "label": "Zone de livraison (mise à jour)",
    "options": [
      {
        "label": "Zone 1 - Centre-ville",
        "value": "zone_1",
        "price": 1500
      },
      {
        "label": "Zone 2 - Banlieue",
        "value": "zone_2",
        "price": 2500
      },
      {
        "label": "Zone 3 - Éloignée",
        "value": "zone_3",
        "price": 4000
      }
    ]
  }'

Réponse


{
  "success": true,
  "data": {
    "id": "template_789",
    "appId": "app_id",
    "ref": "delivery_zone",
    "label": "Zone de livraison (mise à jour)",
    "type": "SELECT",
    "required": true,
    "options": [
      {
        "id": "opt_upd_1",
        "templateId": "template_789",
        "label": "Zone 1 - Centre-ville",
        "value": "zone_1",
        "price": 1500
      },
      {
        "id": "opt_upd_2",
        "templateId": "template_789",
        "label": "Zone 2 - Banlieue",
        "value": "zone_2",
        "price": 2500
      },
      {
        "id": "opt_upd_3",
        "templateId": "template_789",
        "label": "Zone 3 - Éloignée",
        "value": "zone_3",
        "price": 4000
      }
    ],
    "updatedAt": "2024-01-21T09:00:00.000Z"
  }
}

Erreurs

Code	Description
`not-authorized`	Clé API invalide
`template-not-found`	Modèle non trouvé

Supprimer un modèle

Supprime un modèle de champ.


POST /app/{appId}/multi-service/fields/{id}/delete

Requête

Champ	Type	Requis	Description
`apiKey`	string	Oui	Clé API


curl -X POST https://api.applite.ai/app/{appId}/multi-service/fields/{templateId}/delete \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "your_api_key"
  }'

Réponse


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

Erreurs

Code	Description
`not-authorized`	Clé API invalide
`template-not-found`	Modèle non trouvé

La suppression d’un modèle ne supprime pas les champs des services qui l’utilisent. Les services conserveront une copie des champs.

Types de champs

Type	Description	Options de validation
`TEXT`	Texte libre	`minLength`, `maxLength`, `regex`
`NUMBER`	Valeur numérique	`min`, `max`
`SELECT`	Liste à choix unique	`options`
`MULTIPLE_SELECT`	Liste à choix multiples	`options`
`EMAIL`	Adresse email	Validation email intégrée
`PHONE`	Numéro de téléphone	Validation téléphone intégrée
`DATE`	Date	-
`ADDRESS`	Adresse postale	-

Multiplicateur de prix

Lorsque multiplier: true, la valeur du champ multiplie le prix de base du service :


Prix total = Prix de base × Valeur du champ multiplicateur + Somme des suppléments d'options