Dokos
Documentation
Exemples

Créer une réservation de ressource via l'API avec Postman

Envoyer une requête POST avec Postman pour créer une réservation de ressource (Resource Booking) dans Dokos.

Créer une réservation de ressource via l'API avec Postman

Cet exemple crée une Réservation de ressource (Resource Booking) de l'application Bookings, avec l'API REST. Postman est un client HTTP qui simplifie les appels de test. Toute autre bibliothèque HTTP convient.

Le type de document s'appelait « Item Booking » (réservation d'article) dans les anciennes versions. Il s'appelle maintenant « Resource Booking ». Le champ obligatoire de la ressource est booking_resource.

Prérequis

  • L'application Bookings est installée sur le site.
  • Une Ressource réservable existe, par exemple « Salle de réunion A » (nom fictif).
  • Vous avez la clé et le secret API d'un utilisateur qui peut créer des réservations. Voir Authentification par jeton.

Envoyer la requête

  1. Dans Postman, créez une nouvelle requête.
  2. Choisissez la méthode POST.
  3. Saisissez l'URL : https://<url-du-site>/api/resource/Resource Booking.
  4. Dans l'onglet Headers, ajoutez ces en-têtes :
    CléValeur
    Authorizationtoken <api_key>:<api_secret>
    Content-Typeapplication/json
  5. Dans l'onglet Body, choisissez raw, puis saisissez le document en JSON :
    {
    "booking_resource": "Salle de réunion A",
    "starts_on": "2026-12-01 08:00:00",
    "ends_on": "2026-12-01 18:00:00",
    "user": "jean@example.com"
}
  6. Cliquez sur Send.

La réponse contient le document créé dans la clé data, avec son nom (par exemple STO-BOOK-2026-00001).

Champs

ChampObligatoireRôle
booking_resourceOuiRessource réservée (Ressource réservable)
starts_onOuiDébut, au format AAAA-MM-JJ HH:MM:SS
ends_onOuiFin, au format AAAA-MM-JJ HH:MM:SS
userNonUtilisateur pour qui la réservation est faite
party_type, party_nameNonTiers de la réservation, par exemple Customer et le nom du client
statusNonIn cart, Not confirmed, Confirmed ou Cancelled
all_dayNon1 pour une réservation sur la journée entière

Pour voir tous les champs et leur caractère obligatoire, ouvrez Personnaliser un formulaire sur le type de document Réservation de ressource. Le point d'accès GET /api/v2/doctype/Resource Booking/meta renvoie aussi la liste des champs.

Voir aussi