Metadata

Title

API REST Yoplanning

Description

Documentation API pour intégrations et développements sur mesure

Version_Actuelle

v3.2

Derniere_Mise_A_Jour

2025-01-07

Url_Base

https://api.yoplanning.com/v3

Documentation

https://fr.yoplanning.support/developpeur/documentation-api-yoplanning

Format

OpenAPI 3.0

Caracteristiques

Architecture

REST

Format

JSON

Protocole

HTTPS uniquement

Pagination

Offset + cursor-based

Rate_Limiting

1000 req/h par défaut

Environnements

• Production
• Sandbox
• Test

Authentification

Api_Key

Header

Authorization: Bearer YOUR_API_KEY

Generation

Interface Yoplanning > Paramètres > API

Expiration

Jamais (révocation manuelle)

Ideal_Pour

Intégrations serveur simples

Oauth2

Flows

• Authorization Code
• Client Credentials

Scopes

• read:activities
• write:activities
• read:bookings
• write:bookings
• read:customers
• write:customers
• read:payments
• write:payments
• admin:all

Token_Lifetime

3600 secondes

Ideal_Pour

Applications tierces

Securite

Https_Obligatoire

True

Rate_Limiting

Par clé API + IP

Audit_Logs

Toutes requêtes loggées

Webhook_Signature

HMAC-SHA256

Endpoints_Principaux

Activites

Base_Url

/activities

Methodes

Get

Description

Liste activités

Params

• category_id
• status
• limit
• offset

Exemple_Reponse

Id

123

Name

Cours de ski débutant

Duration

120

Max_Participants

8

Price

45.0

Status

active

Post

Description

Créer activité

Required

• name
• category_id
• duration
• max_participants
• price

Put

Modifier activité

Delete

Supprimer (si pas de réservations)

Reservations

Base_Url

/bookings

Methodes

Get

Description

Liste réservations

Params

• activity_id
• customer_id
• status
• date_from
• date_to

Statuts

• confirmed
• pending
• cancelled

Post

Description

Créer réservation

Required

• activity_id
• customer_id
• scheduled_date
• scheduled_time
• participants

Validation

• Disponibilité
• Capacité
• Contraintes planning

Codes

201

Créée

409

Conflit

422

Invalide

Clients

Base_Url

/customers

Rgpd_Compliance

True

Methodes

Get

Params

• search
• created_since
• tags

Post

Obligatoires

• first_name
• last_name
• email

Optionnels

• phone
• address
• date_of_birth
• tags

Planning

Base_Url

/planning

Algorithmes_Ia

True

Methodes

Get /Availability

Description

Vérifier disponibilités

Required

• activity_id
• date_from
• date_to

Exemple_Reponse

Available_Slots

• Date

  2025-02-15

  Time

  14:00:00

  Available_Spots

  6

  Price

  45.0

Get /Schedule

Planning complet période

Post /Block

Bloquer créneaux

Paiements

Base_Url

/payments

Operateurs

• Stripe
• Payline

Methodes

Get

Params

• booking_id
• status
• amount_min
• amount_max

Statuts

• pending
• completed
• failed
• refunded

Post /Charge

Description

Initier paiement

Securite

PCI-DSS via Stripe

Required

• booking_id
• amount
• currency

Post /{Id}/Refund

Rembourser paiement

Statistiques

Base_Url

/stats

Temps_Reel

True

Methodes

Get /Revenue

Params

• period
• date_from
• date_to
• group_by

Periods

• day
• week
• month
• year

Get /Occupancy

Taux d'occupation activités

Get /Customers

Statistiques clients

Webhooks

Description

Notifications temps réel

Signature

HMAC-SHA256

Retry

3 tentatives max

Timeout

30 secondes

Evenements

Booking.Created

Nouvelle réservation

Booking.Updated

Réservation modifiée

Booking.Cancelled

Réservation annulée

Payment.Completed

Paiement finalisé

Payment.Failed

Échec paiement

Activity.Updated

Activité modifiée

Planning.Changed

Planning modifié

Exemple_Payload

Event

booking.created

Timestamp

2025-01-07T10:30:00Z

Data

Booking_Id

789

Activity_Id

123

Status

confirmed

Gestion_Erreurs

Format

Error

Code

string

Message

string

Timestamp

datetime

Request_Id

string

Codes_Frequents

400

Bad Request - Paramètres invalides

401

Unauthorized - API key invalide

403

Forbidden - Permissions insuffisantes

404

Not Found - Ressource inexistante

409

Conflict - Conflit disponibilité

422

Unprocessable - Validation échouée

429

Too Many Requests - Rate limit

500

Internal Error - Contacter support

Exemples_Integration

Synchronisation_Crm

Endpoints

• /customers
• /bookings
• webhooks

Flux

• Récupération clients
• Sync bidirectionnelle
• Webhooks temps réel

Widget_Personnalise

Endpoints

• /activities
• /planning/availability
• /bookings

Fonctions

• Affichage dispo
• Sélection créneaux
• Paiement

App_Mobile_Equipes

Endpoints

• /planning/schedule
• /bookings
• /customers

Features

• Planning personnel
• Validation billets
• Indisponibilités

Sdk_Officiels

Php

Nom

yoplanning-php

Version

2.1.0

Install

composer require yoplanning/php-sdk

Javascript

Nom

yoplanning-js

Version

1.8.0

Install

npm install @yoplanning/sdk

Python

Nom

yoplanning-python

Version

1.5.0

Install

pip install yoplanning

Rate_Limiting_Par_Plan

Decouverte

Req_Heure

100

Req_Jour

1000

Burst

20

Solo

Req_Heure

500

Req_Jour

5000

Burst

50

Micro

Req_Heure

1000

Req_Jour

15000

Burst

100

Entreprise

Req_Heure

5000

Req_Jour

50000

Burst

200

Personnalise

Sur demande

Environnements

Production

Url

https://api.yoplanning.com/v3

Uptime

99.9%

Support

24h/24

Sandbox

Url

https://sandbox-api.yoplanning.com/v3

Description

Test avec données fictives

Reset

Données réinitialisées/semaine

Conformite_Securite

Certifications

• ISO 27001 (en cours)
• RGPD
• PCI-DSS
• SOC 2 (prévu 2025)

Chiffrement

Transit

TLS 1.3

Repos

AES-256

Rgpd

Droit_Oubli

/customers/{id}/gdpr-delete

Export_Donnees

/customers/{id}/export

Support_Developpeurs

Documentation

https://fr.yoplanning.support/developpeur/

Playground

Tests directs dans documentation

Email

api@yoplanning.com

Response_Time

< 4h ouvrées

Communaute

Forum

developers.yoplanning.com

Github

github.com/yoplanning

Roadmap

V3_3_Q2_2025

• GraphQL endpoint
• Webhook filters
• Batch operations

V4_2026

• Architecture microservices
• gRPC support
• AI/ML endpoints

Deprecations

V2

Support jusqu'à décembre 2025