API REST · OpenAPI 3

L’API REST
EspaceRendezVous

Intégrez toute la prise de rendez-vous dans votre système d’information, vos fronts et votre CRM. Architecture headless : vous gardez la main sur l’expérience, nous fournissons la logique métier et les données.

Voir la documentation →Demander un accès API

availabilities · 200 OK

// Créneaux disponibles en temps réel
GET /availabilities?proName=galeries-lafayette
Authorization: Bearer eyJhbGciOi…
apiKey: rdv_live_8f2c…

200 OK
{
  "slots": [
    { "start": "2026-07-01T09:00", "with": "Camille D." },
    { "start": "2026-07-01T14:30", "with": "Yanis B." }
  ]
}

familles d’API

endpoints REST

objets de données

OpenAPI 3

REST · JSON

JWT

+ clé API

Pourquoi notre API

Pensée pour vos intégrations grands comptes

Couverture de bout en bout

Référentiels, disponibilités, fiche client et cycle de vie complet du rendez-vous — pas seulement la « prise de RDV ».

Architecture headless

Vous gardez la pleine maîtrise de l’ergonomie et du design de vos fronts ; l’API fournit la logique et les données.

Multimarque par conception

Un seul jeu d’API sert toutes vos marques et enseignes, via le paramètre wlName, sans intégration redondante.

Standards et documentation

REST, OpenAPI 3 et JSON, avec une documentation interactive (Swagger) qui réduit le coût et le risque d’intégration.

Synchronisation incrémentale

Les requêtes par plage de dates et sur la date de modification facilitent les échanges réguliers avec votre CRM et vos outils de pilotage.

Monétisation intégrée

Abonnements, packs, bons cadeaux, codes promo et paiement sont exposés par l’API pour des parcours commerciaux complets.

Catalogue

Les 7 familles d’API

La documentation interactive publique couvre les fonctions cœur ; la documentation détaillée des familles avancées (abonnements, paiement, packs, cadeaux) est disponible sur demande.

Version

Connaître la version courante de l’API exposée.

GET /version

Comptes Pro (marques)

Réseau d’agences et d’implantations : libellés, adresses, géolocalisation GPS, organisation par marque.

GET /proaccounts · /proaccounts/{proName}

Prestations et employés

Motifs, durées, intervenants, offres groupées (bundles, packs) et questionnaires de pré-qualification.

GET /services · /supServices · /bundles · /freePacks · /inquiryQuestionsAndEmployees

Disponibilités

Jours et créneaux réellement disponibles, calculés en temps réel selon le motif et l’intervenant.

GET /availabilities

Fiche client

Rechercher, créer et mettre à jour la fiche client, la retrouver par clé externe (CRM), récupérer la structure des champs.

GET/POST /customers · GET/PUT /customers/{id} · GET /cardfields

Rendez-vous

Cycle de vie complet : création, modification, annulation, restitution, paiement et règles d’annulation.

POST/PUT/DELETE /appointment · GET /appointments · /employees/appointments · /applyPromotionCodes · /gift

Abonnements

Souscriptions récurrentes : inscription, validation, renouvellement, résiliation, contrôle d’éligibilité.

GET/POST/DELETE /subscriptions · /subscriptions/renew · /checkForAvailableSubscription

Flux

Orchestration d’un parcours de prise de rendez-vous

Référentiels

Agences, motifs et intervenants (/proaccounts, /services).

Disponibilités

Créneaux en temps réel (/availabilities).

Fiche client

Identifier ou créer le client, rapprocher votre CRM (/customers).

Création

Enregistrer le RDV et déclencher la confirmation (POST /appointment).

Restitution

Synchroniser et piloter par client, intervenant ou agence.

Confiance

Sécurité & marque blanche

Authentification

Chaque appel est sécurisé par un jeton JWT (en-tête Authorization: Bearer) complété d’une clé API (apiKey). Compatible SSO / OIDC : vos utilisateurs sont authentifiés par votre IAM, le jeton est propagé à l’API.

Marque blanche native

La marque est déterminée par le sous-domaine ou le paramètre wlName, présent sur l’ensemble des méthodes. Les données de chaque marque sont cloisonnées, avec un seul jeu d’API.

Intégrations

Cas d’usage

CRM

Prendre et consulter des rendez-vous directement depuis votre CRM, sans double saisie.

Espace client

Offrir la prise de RDV dans l’espace personnel de vos clients ou collaborateurs.

Application mobile

Brancher vos applications natives sur les mêmes endpoints, en multimarque.

Site web

Composer un parcours de réservation sur mesure aux couleurs de votre marque.

API REST · Gestion des accès

Provisionner vos utilisateurs Back-Office

L’API Employés vous permet de créer, consulter, modifier et supprimer les utilisateurs de votre back-office EspaceRendezVous — sur un ou plusieurs comptes à la fois. Idéale pour synchroniser vos accès avec votre SIRH ou votre annuaire (IAM) et automatiser l’arrivée et le départ des collaborateurs.

REST · JSON Base URL https://<votre-instance>/espaceRdvServer/ws 🔒 Clé API + JWT · droits administrateur

Ressource /employee

GET	/employee	Récupérer un employé et la liste des comptes auxquels il appartient
POST	/employee	Créer un employé dans un ou plusieurs comptes
PUT	/employee	Modifier un employé dans un ou plusieurs comptes
DELETE	/employee	Supprimer un employé d’un ou plusieurs comptes

L’objet Employé

Champ	Type	Description
`wlName`	string	Nom de la marque blanche (white-label).
`firstname`	string	Prénom du collaborateur.
`lastname`	string	Nom du collaborateur.
`email`	string	Adresse e-mail (format validé).
`mobilePhoneNumber`	string	Numéro de mobile.
`matricule`	string	Identifiant unique de l’employé (clé de mise à jour / suppression).
`pros`	string	Liste des comptes séparés par des virgules (ex. `agence-paris,agence-lyon`). Vide ou `null` = tous les comptes.

GET/employeeRécupérer un employé

Paramètres de requête

`wlName`requis	string	Nom de la marque blanche.
`matricule`requis	string	Matricule de l’employé recherché.

Requête

GET /espaceRdvServer/ws/employee?wlName=ma-marque&matricule=EMP123
Authorization: Bearer <votre-JWT>

POST/employeeCréer un employé

Corps de la requête · application/json

curl

curl -X POST "https://<votre-instance>/espaceRdvServer/ws/employee" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <votre-JWT>" \
  -d '{
    "wlName": "ma-marque",
    "firstname": "Marie",
    "lastname": "Durand",
    "email": "marie.durand@exemple.com",
    "mobilePhoneNumber": "+33612345678",
    "matricule": "EMP123",
    "pros": "agence-paris,agence-lyon"
  }'

PUT/employeeModifier un employé

Même corps que la création (objet Employé complet). L’employé est identifié par son matricule ; les comptes ciblés sont définis par le champ pros.

DELETE/employeeSupprimer un employé

Paramètres de requête

`wlName`requis	string	Nom de la marque blanche.
`matricule`requis	string	Matricule de l’employé à supprimer.
`pros`optionnel	string	Liste des comptes concernés. Vide = suppression sur tous les comptes.

Requête

DELETE /espaceRdvServer/ws/employee?wlName=ma-marque&matricule=EMP123&pros=agence-lyon

Codes de réponse

200Opération réussie

400Matricule ou compte inexistant, e-mail invalide

500Erreur interne du serveur

✓

Cas d’usage — synchronisation SIRH / IAM.

Provisionnez automatiquement les accès à l’arrivée d’un collaborateur (POST), mettez à jour ses informations (PUT) et révoquez ses accès à son départ (DELETE). Le tout piloté par votre système d’information, sans intervention manuelle dans le back-office.

Authentification requise.

Ces opérations administrent des comptes utilisateurs : elles exigent une clé API valide et un jeton JWT avec les droits administrateur. Réservées aux intégrateurs autorisés, sur canal HTTPS uniquement.

Temps réel · Événements sortants

Webhooks : soyez notifié en temps réel

Plutôt que d’interroger l’API en permanence, laissez EspaceRendezVous vous prévenir. Dès qu’un rendez-vous est créé, modifié ou supprimé, nous envoyons une requête POST à l’URL de votre choix avec toutes les données de l’événement au format JSON.

POST · application/json URL & en-têtes configurés dans le Back-Office 3 événements

Événements déclencheurs

create

Un nouveau rendez-vous est pris.

update

Un rendez-vous est modifié (date, statut, description…).

delete

Un rendez-vous est annulé ou supprimé.

Structure de la notification

Chaque appel contient un enveloppe avec le type d’événement et l’objet rendez-vous complet.

POST vers votre URL · payload JSON

{
  "event": "create",
  "data": {
    "id": 123,
    "startDate": "15-11-2024 10:00",
    "endDate": "15-11-2024 11:00",
    "creationDate": "14-11-2024 09:30",
    "description": "Consultation avec le client",
    "note": "Apporter les documents nécessaires",
    "reference": "REF123456",
    "status": "CONFIRMATION_NEEDED",
    "duration": 60,
    "price": 120.50,
    "proId": 789,
    "proName": "Dr Martin",
    "proFullName": "Dr Martin Dupuis",
    "proAdress": "123 Rue Principale, Paris",
    "proPhone": "+33123456789",
    "customer": {
      "id": 456,
      "firstName": "Jean",
      "lastName": "Dupont",
      "email": "jean.dupont@exemple.com",
      "phone": "+33198765432"
    },
    "employee": {
      "id": 987,
      "firstName": "Marie",
      "lastName": "Durand",
      "email": "marie.durand@exemple.com",
      "phone": "+33111223344",
      "matricule": "EMP123"
    },
    "service": {
      "templateName": "Consultation Générale",
      "templateId": 321,
      "templatExternalId": "EXT123",
      "serviceName": "Consultation",
      "serviceId": 654,
      "serviceExternalId": "SER456"
    }
  }
}

Principaux champs de data

Champ	Type	Description
`id`	int	Identifiant du rendez-vous.
`startDate` / `endDate`	string	Début et fin, format `JJ-MM-AAAA HH:mm`.
`creationDate`	string	Date de création du rendez-vous.
`status`	string	Statut du RDV (ex. `CONFIRMATION_NEEDED`).
`duration`	int	Durée en minutes.
`price`	number	Montant associé au rendez-vous.
`reference`	string	Référence métier du rendez-vous.
`proId` · `proName` · `proFullName` · `proAdress` · `proPhone`	—	Informations sur le professionnel / l’agence.
`customer`	object	Client : `id`, `firstName`, `lastName`, `email`, `phone`.
`employee`	object	Collaborateur : `id`, `firstName`, `lastName`, `email`, `phone`, `matricule`.
`service`	object	Prestation : `templateName/Id`, `serviceName/Id` et identifiants externes (`…ExternalId`) pour le mapping avec votre SI.

✓

Cas d’usage.

Synchronisez un CRM ou un agenda, déclenchez des rappels ou des e-mails transactionnels, alimentez votre entrepôt de données — sans jamais interroger l’API en boucle. Les identifiants externes (templatExternalId, serviceExternalId) facilitent le rapprochement avec vos référentiels.

Bonnes pratiques de réception.

Exposez un endpoint HTTPS, répondez rapidement en 2xx puis traitez en asynchrone, et gérez l’idempotence via le couple id + event. Vous pouvez ajouter un en-tête secret partagé (configurable dans le Back-Office) pour authentifier l’origine des appels.

Prêt à intégrer la prise de rendez-vous ?

Accédez à la documentation interactive ou parlez-nous de votre projet : nos équipes vous accompagnent dans l’intégration.

Voir la documentation →Demander la documentation détaillée

EspaceRendezVous · +33 (0)1 76 34 11 27 · contact@espacerendezvous.com

Développeurs

Editeur du site

Immatriculation

Directeur de la publication

Hébergement

L’API REST
EspaceRendezVous

Pensée pour vos intégrations grands comptes

Couverture de bout en bout

Architecture headless

Multimarque par conception

Standards et documentation

Synchronisation incrémentale

Monétisation intégrée

Les 7 familles d’API

Version

Comptes Pro (marques)

Prestations et employés

Disponibilités

Fiche client

Rendez-vous

Abonnements

Orchestration d’un parcours de prise de rendez-vous

Référentiels

Disponibilités

Fiche client

Création

Restitution

Sécurité & marque blanche

Authentification

Marque blanche native

Cas d’usage

CRM

Espace client

Application mobile

Site web

Provisionner vos utilisateurs Back-Office

Webhooks : soyez notifié en temps réel

Prêt à intégrer la prise de rendez-vous ?

Envie d'essayer

Espace Rendez-Vous ?

Développeurs

Editeur du site

Immatriculation

Directeur de la publication

Hébergement

L’API RESTEspaceRendezVous

Pensée pour vos intégrations grands comptes

Couverture de bout en bout

Architecture headless

Multimarque par conception

Standards et documentation

Synchronisation incrémentale

Monétisation intégrée

Les 7 familles d’API

Version

Comptes Pro (marques)

Prestations et employés

Disponibilités

Fiche client

Rendez-vous

Abonnements

Orchestration d’un parcours de prise de rendez-vous

Référentiels

Disponibilités

Fiche client

Création

Restitution

Sécurité & marque blanche

Authentification

Marque blanche native

Cas d’usage

CRM

Espace client

Application mobile

Site web

Provisionner vos utilisateurs Back-Office

Webhooks : soyez notifié en temps réel

Prêt à intégrer la prise de rendez-vous ?

Envie d'essayer Espace Rendez-Vous ?

L’API REST
EspaceRendezVous

Envie d'essayer

Espace Rendez-Vous ?