Zimun: Appointment Scheduling & Booking Software: Guide API

L’API de Zimun: Appointment Scheduling & Booking Software est conçue pour les équipes qui veulent des réservations fluides dans leurs propres outils. Utilisez‑la pour afficher la disponibilité en temps réel, placer des holds temporaires et confirmer des rendez‑vous sans conflits.

Pour qui est cette API

Si vous gérez une app client, un portail personnel ou un outil interne, l’API vous permet de garder la logique de planification synchronisée avec Zimun: Appointment Scheduling & Booking Software tout en conservant l’expérience.

Considérez‑le comme un moteur de planification que vous pouvez intégrer partout : votre site, votre application mobile ou un outil d’administration interne.

Protocole et format

• HTTPS + réponses JSON (UTF‑8).
• Authentification OAuth2 Client Credentials (RFC 6749 §4.4).
• POST/PATCH idempotents avec Idempotency‑Key pour des reprises sûres.
• Pagination via page_size/page_token avec { items, next_page_token }.
• Horodatages ISO‑8601 avec décalage de fuseau horaire.

Comment fonctionne l’authentification

1. Créez un client API dans Paramètres → API Clients pour obtenir votre client_id et client_secret.
2. Demandez un jeton via /oauth/token en utilisant le grant client credentials.
3. Appelez l’API avec Authorization: Bearer <token>.

Les jetons sont de courte durée et limités à votre organisation.

Scopes en un coup d’œil

• org:read - métadonnées de l’organisation
• availability:read - créneaux et carte des jours fériés
• appointments:read - lister/voir les rendez‑vous
• appointments:write - holds, confirmer, replanifier, annuler, webhooks

URL de base

https://api.zimun.online/api/v1

Flux de réservation classique

1. Afficher la disponibilité pour un service ou un membre de l’équipe.
2. Créez un hold de 10 minutes lorsqu’un utilisateur choisit un créneau.
3. Confirmez le rendez‑vous avec les informations client - ou libérez le hold s’ils annulent.

Ce flux reflète ce que fait la page de réservation publique, vous obtenez donc le même comportement sans conflit.

Exemple rapide (cURL)

Utilisez cet exemple pour récupérer la disponibilité des 7 prochains jours. Remplacez service_id et votre jeton d’accès.

curl -X GET \
  "https://api.zimun.online/api/v1/availability?service_id=s_123&days_ahead=7" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Pour des exemples de bout en bout en Python, Node.js, Go et Rust, voir la page de Référence API.

Cas d’usage typiques

• Réservation intégrée - Utilisez l’API pour alimenter une interface de planification personnalisée dans votre application.
• Synchronisation CRM / POS - Transférez les rendez‑vous confirmés vers vos outils internes ou votre stack analytique.
• Tableau de bord des opérations - Interrogez services, personnel et ressources pour une vue de planning en temps réel.

User stories

• Une application de clinique affiche les thérapeutes disponibles par service, place un hold pendant que le patient remplit un formulaire, puis confirme le rendez‑vous.
• Un studio synchronise les rendez‑vous dans son tableau de bord BI via un extract nocturne.
• Une place de marché SaaS intègre une fenêtre de réservation qui utilise la disponibilité et les règles de conflit de Zimun: Appointment Scheduling & Booking Software.