Centre d’aide Activity Messenger

Ressources et réservations

Consultez l’introduction à l’API pour l’authentification, les conventions, la pagination, les limites de requêtes et les erreurs.

Ces points de terminaison en lecture seule indiquent à un système externe quand les ressources de l’organisation (chambres, salles, équipements, personnel) sont réservées. Un usage typique est l’automatisation du bâtiment : ajuster le thermostat, l’éclairage ou la ventilation d’une chambre avant l’arrivée et après le départ des clients.

Transmettez l’en-tête X-Activity-Messenger-Api-Key à chaque requête. Les réservations faites en ligne par les clients et celles créées par les administrateurs dans le calendrier des réservations sont toutes incluses. Les noms des clients, leurs coordonnées, les notes de réservation, les factures et les paiements ne sont jamais renvoyés.

GET /api/v1/organization/{organization}/locations

Renvoie les ressources de l’organisation dans un tableau JSON, sans pagination, dans le même ordre que l’interface d’administration. Les ressources supprimées ne sont jamais renvoyées; celles qui sont désactivées le sont.

Paramètre de requête :

• type : facultatif. location, staff, equipment ou seat_map. Omettez-le pour renvoyer tous les types.

Un objet ressource contient les champs suivants :

• id : identifiant numérique de la ressource; la clé stable. Utilisez-le pour associer une ressource à un appareil de votre système.
• name, alias : nom affiché et alias facultatif, ou null.
• type : type de ressource.
• disabled : booléen; true lorsque la ressource est actuellement désactivée pour les réservations.
• parent_location_ids : identifiants des ressources qui contiennent celle-ci. Par exemple, une ressource « Aile est complète » peut être le parent de chaque chambre de cette aile. Réserver un parent occupe aussi ses enfants.

GET /api/v1/organization/1234/locations?type=location
[
  {
    "id": 10,
    "name": "Aile est",
    "alias": null,
    "type": "location",
    "disabled": false,
    "parent_location_ids": []
  },
  {
    "id": 11,
    "name": "Chambre 1",
    "alias": "C1",
    "type": "location",
    "disabled": false,
    "parent_location_ids": [10]
  }
]

GET /api/v1/organization/{organization}/bookings

Renvoie les plages réservées qui chevauchent une période. Chaque ligne correspond à une occurrence d’une réservation sur une ressource; une réservation qui couvre plusieurs ressources ou plusieurs dates renvoie une ligne par occurrence.

Paramètres de requête :

• from : premier jour facultatif, AAAA-MM-JJ, dans le fuseau horaire de l’organisation. Par défaut : aujourd’hui.
• to : dernier jour facultatif, inclus, AAAA-MM-JJ. Par défaut : 7 jours après from. Il doit être égal ou postérieur à from, et la période ne peut pas dépasser 93 jours.
• location_ids[] : identifiants de ressources facultatifs, jusqu’à 200. Les réservations de leurs ressources parentes sont incluses automatiquement : la réservation d’une aile complète est donc renvoyée lorsque vous demandez une de ses chambres. Un identifiant qui n’appartient pas à l’organisation renvoie HTTP 404.
• per_page : facultatif, de 1 à 500. Par défaut : 100.
• page : numéro de page facultatif. Par défaut : 1.

Réservations renvoyées :

• Une occurrence est renvoyée si elle chevauche la période, y compris si elle a commencé avant from et est toujours en cours.
• Les réservations annulées, supprimées, refusées ou expirées sont exclues, tout comme celles encore dans le panier d’un client.
• Les réservations non payées et celles en attente d’approbation sont incluses. Utilisez status et approval_status si votre système doit les ignorer.
• Les fermetures (is_closure: true) bloquent une ressource, mais n’indiquent pas que quelqu’un est présent.

Un objet réservation contient les champs suivants :

• event_id : identifiant numérique de l’occurrence; la clé stable. Utilisez-le pour détecter les changements entre deux appels.
• booking_id : identifiant numérique de la réservation. Plusieurs occurrences peuvent le partager.
• location_id, location_name : la ressource réservée. Si vous filtrez avec location_ids[], il peut s’agir d’un parent de la ressource demandée.
• start, end : horodatages ISO 8601 avec le décalage UTC de l’organisation.
• status : statut de la réservation, par exemple paid, not_paid, deposit_paid ou new.
• approval_status : null si aucune approbation n’est requise, sinon pending ou approved.
• is_closure : booléen; true pour une fermeture.
• booking_type_id : identifiant numérique du type de réservation, ou null.

Les résultats sont triés par heure de début et utilisent une pagination simple : il n’y a pas de nombre total. Continuez à demander next_page_url jusqu’à ce qu’il soit null.

GET /api/v1/organization/1234/bookings?from=2026-11-12&to=2026-11-14&location_ids[]=11
{
  "current_page": 1,
  "data": [
    {
      "event_id": 1001,
      "booking_id": 501,
      "location_id": 11,
      "location_name": "Chambre 1",
      "start": "2026-11-12T15:00:00-05:00",
      "end": "2026-11-14T11:00:00-05:00",
      "status": "paid",
      "approval_status": null,
      "is_closure": false,
      "booking_type_id": 7
    }
  ],
  "next_page_url": null,
  "per_page": 100,
  "prev_page_url": null
}

La réponse contient aussi les clés standard de pagination simple first_page_url, from, path et to.

Conseil

Les réservations changent lorsque des clients réservent, déplacent ou annulent. Pour l’automatisation, interrogez les prochains jours toutes les 5 à 15 minutes plutôt que de garder une longue période en cache.