Centre d’aide Activity Messenger
Introduction à l’API
Utilisez l’API Activity Messenger depuis votre serveur pour intégrer les données d’une organisation ou publier du contenu Web. Cette page présente la connexion et les conventions communes. Choisissez ensuite une référence par ressource.
Authentification et URL de base
Envoyez les requêtes à https://activitymessenger.com/api/v1/organization/{organization}. Remplacez {organization} par l’identifiant numérique de l’organisation. Le domaine personnalisé d’un site Web n’est pas l’hôte de l’API.
Obtenez la clé API dans Paramètres d’organisation → Web et intégrations → Clés API / jetons MCP. Transmettez-la dans l’en-tête HTTP X-Activity-Messenger-Api-Key. Conservez-la dans un stockage sécurisé côté serveur; ne l’intégrez pas au JavaScript du navigateur, aux URL ni aux dépôts publics. Envoyez Accept: application/json et, pour un corps JSON, Content-Type: application/json. Les téléversements de fichiers utilisent plutôt un formulaire multipart.
Les nouvelles clés API sont limitées à l’organisation qui les crée par défaut. L’accès au réseau partenaire est facultatif; voir ci-dessous. L’API de site Web exige une clé directement associée à l’organisation indiquée dans l’URL et l’activation des sites Web; elle n’hérite jamais de l’accès partenaire. Une nouvelle clé API donne accès à tous les sites de cette organisation et n’est pas limitée à la lecture. Les identifiants Stripe App migrés n’autorisent pas la publication de sites.
Créer et gérer les clés API
Seuls les propriétaires de compte et d’organisation peuvent créer, afficher ou révoquer des clés API et gérer les jetons MCP. Les autres niveaux de permission, dont RH et Admin, ne peuvent pas les gérer.
- Ouvrez Paramètres d’organisation → Web et intégrations → Clés API / jetons MCP.
- Cliquez sur Ajouter une clé / un jeton pour ouvrir la fenêtre de création. Choisissez Clé API comme Type d’identifiant.
- Indiquez un Nom descriptif, par exemple « Intégration des inscriptions », et une Validité en jours de 1 à 90. La valeur par défaut est 30 jours.
- Laissez Autoriser l’accès aux organisations partenaires décoché, sauf si l’intégration a besoin du réseau partenaire. Cette option exige que l’organisation appartienne à un réseau partenaire.
- Cliquez sur Ajouter une clé / un jeton, puis copiez la clé dans le stockage sécurisé côté serveur de l’intégration.
Utilisez une clé nommée distincte pour chaque intégration. Les clés API permettent les lectures et les modifications prises en charge par leurs points d’accès; elles n’ont pas d’option de lecture seule. Elles appartiennent à l’organisation : retirer l’utilisateur qui les a créées ne les révoque pas.
Pour revoir une clé existante non révoquée, cliquez sur Afficher la clé API dans sa ligne. Une fenêtre permet au propriétaire de consulter et copier la clé conservée de façon chiffrée. Afficher une clé expirée ne la réactive pas. Les jetons MCP ne peuvent pas être affichés de nouveau après la fermeture de leur fenêtre de création.
Recherchez par nom et utilisez État pour retrouver les identifiants actifs, expirés ou révoqués. La liste indique aussi l’utilisateur ayant créé la clé, sa date de création, son expiration et sa dernière utilisation. Pour remplacer une clé, créez-en une nouvelle, mettez l’intégration à jour, vérifiez son fonctionnement, puis cliquez sur Révoquer pour l’ancienne clé et confirmez. La révocation bloque immédiatement toute authentification ultérieure et est irréversible. Créez une nouvelle clé avant l’expiration.
Accès partenaire facultatif
Autoriser l’accès aux organisations partenaires donne accès à l’API de toutes les organisations du même réseau partenaire. Il s’agit d’un réglage de la clé, pas d’un paramètre de requête à transmettre à chaque appel. Continuez à indiquer l’identifiant de l’organisation cible dans l’URL.
Un propriétaire peut changer la portée d’une clé existante avec le bouton de sa colonne Portée organisationnelle : Cette organisation ou Réseau partenaire. Confirmez le changement. Désactiver l’accès partenaire interrompt les intégrations utilisant cette clé pour d’autres organisations. Les changements d’appartenance au réseau modifient les organisations accessibles. La publication de sites reste toujours limitée à l’organisation qui a créé la clé.
Clés existantes
Les clés API existantes des organisations apparaissent dans la même liste, sans changement de valeur ni ajout d’expiration. Elles conservent leur accès antérieur au réseau partenaire. Vous pouvez les afficher, limiter leur portée ou les révoquer avec les mêmes commandes que les nouvelles clés. Révoquer une clé partagée migrée met aussi fin à l’accès partenaire utilisant cette clé.
Les identifiants Stripe App existants sont également affichés et peuvent être révoqués pour l’organisation sélectionnée. Avant de révoquer un identifiant partagé, mettez à jour les intégrations qui l’utilisent encore.
Clés API et jetons Bearer MCP
Utilisez le terme clé API pour les API de l’organisation et de site Web, et jeton MCP pour une connexion MCP manuelle. Ce sont des identifiants différents. « Bearer » décrit la façon de transmettre un jeton MCP : Authorization: Bearer <mcp-token>. Une clé API envoyée dans X-Activity-Messenger-Api-Key ne permet pas de s’authentifier à MCP.
Consultez Connecter un assistant IA avec MCP pour les jetons manuels et les connexions OAuth. La page IFRAME contient les réglages d’intégration et un lien vers la gestion des clés; elle n’affiche plus la clé API.
Première requête
Lisez les informations de l’organisation avec GET /api/v1/organization/{organization} et les en-têtes ci-dessus. Les références indiquent les méthodes HTTP et les chemins; remplacez les paramètres par les identifiants renvoyés par l’API. Les identifiants, clés externes de page, slugs et numéros de membre sont distincts : utilisez celui prévu par le point de terminaison.
Pagination
La pagination dépend du point de terminaison; les collections n’ont pas toutes la même structure de réponse.
- Pagination facultative : utilisateurs, membres, formulaires, étiquettes de formulaire, cours et étiquettes de cours renvoient un tableau d’au plus 50 éléments sans
pageniper_page. Fournissez l’un des paramètres pour obtenirdata,current_page,next_page_urlet les totaux. La valeur par défaut est 50 et le maximum est 250. - Messages et modèles publiés : toujours paginés, avec 10 éléments par page par défaut. Utilisez
per_pageetpageau besoin. - Répondants de formulaire : toujours en pagination simple; 50 par défaut, maximum 250. Aucun
total,last_pagenilast_page_url. - Listes de sites Web : sites, pages et médias utilisent toujours la pagination simple, à 50 éléments par page. Utilisez
page;per_pagene change pas la taille. Aucun total n’est renvoyé. - Autres collections : produits, étiquettes de produit et forfaits de réservation renvoient des tableaux. Les événements du calendrier utilisent des filtres de dates. Consultez la référence avant d’ajouter des paramètres de pagination.
Traitez data et arrêtez lorsque next_page_url vaut null. Conservez les filtres et la taille de page d’origine lors des requêtes suivantes; les liens renvoyés ne répètent pas nécessairement tous les paramètres. Authentifiez chaque requête. Évitez de journaliser la clé ou des données sensibles.
Limites de requêtes et nouvelles tentatives
L’API de l’application est configurée pour 240 requêtes par minute. Les routes de site Web appliquent aussi une limite de 60 requêtes par minute. Ces limites sont partagées, et non des quotas indépendants par point de terminaison ou clé d’organisation. Les requêtes habituelles avec une clé API sont limitées selon l’adresse IP appelante; plusieurs intégrations utilisant la même adresse de sortie peuvent partager cette capacité.
Consultez X-RateLimit-Limit et X-RateLimit-Remaining lorsqu’ils sont présents. Après HTTP 429, attendez au moins le nombre de secondes indiqué dans Retry-After. Réduisez les appels simultanés et limitez les tentatives, avec un délai croissant pour les erreurs temporaires. Ne répétez pas continuellement les erreurs d’authentification ou de validation.
Ne répétez pas aveuglément une écriture après un délai d’attente dépassé : elle peut avoir réussi. La préparation et la publication des révisions Web ont des garanties d’idempotence documentées; les autres modifications ne partagent pas cette garantie. Lisez l’état obtenu avant de répéter une écriture.
Réponses et erreurs
Les appels réussis renvoient du JSON propre au point de terminaison : objet, tableau ou réponse paginée. Vérifiez le statut HTTP avant de traiter le corps. Les erreurs n’ont pas toutes la même structure; certains anciens points de terminaison renvoient une chaîne JSON ou null.
401: clé absente ou invalide. Vérifiez la clé, son expiration, sa révocation, sa portée partenaire et l’organisation cible.404: ressource absente ou inaccessible. Vérifiez les identifiants et la propriété; les sites Web doivent aussi être activés.409: état initial périmé pour une révision Web ou des redirections. Relisez l’état, réconciliez les changements et vérifiez une nouvelle requête.413: requête trop volumineuse. Les documents Web sont limités à 2 Mo; les limites de téléversement sont décrites séparément.422: entrée invalide ou opération non prise en charge. Les erreurs peuvent contenirmessageeterrorspar champ; corrigez la requête avant de réessayer.429: limite atteinte. RespectezRetry-After.
Dates, filtres et mises à jour
Respectez le format de chaque paramètre. Un horodatage terminé par Z est en UTC; une date métier YYYY-MM-DD n’est pas un instant UTC. Suivez les règles du point de terminaison pour le fuseau de l’organisation et les bornes de dates. Les filtres de tableaux utilisent des crochets, comme tags[]=natation. Distinguez les champs omis, null et les tableaux vides, surtout pour le remplacement de contenu ou de présences.
Références de l’API générale
- Organisation et réseau
- Personnel et permissions
- Membres et entrées
- Formulaires et exportation des répondants
- Cours et calendriers
- Présences
- Forfaits de réservation
- Ressources et réservations
- Produits
- Messages et modèles publiés
Références de l’API de site Web
- Publier des pages : découverte, documents complets, vérification, publication et suppression.
- Médias, sections réutilisables et redirections : manifestes d’images, navigation réutilisable et remplacement des redirections.
Index des points de terminaison
Tous les points de terminaison documentés dans ces références. Les chemins de l’API générale sont relatifs à https://activitymessenger.com; les chemins de l’API de site Web sont relatifs à /api/v1/organization/{organization}/websites/{website}, sauf lorsqu’ils sont indiqués en entier.
| Méthode | Chemin | Référence |
|---|---|---|
| GET | /api/v1/organization/{organization} |
Organisation et réseau |
| GET | /api/v1/organization/{organization}/network |
Organisation et réseau |
| GET | /api/v1/organization/{organization}/users |
Personnel et permissions |
| GET | /api/v1/organization/{organization}/users/{user} |
Personnel et permissions |
| POST | /api/v1/organization/{organization}/users |
Personnel et permissions |
| PUT | /api/v1/organization/{organization}/users/{user} |
Personnel et permissions |
| DELETE | /api/v1/organization/{organization}/users/{user} |
Personnel et permissions |
| GET | /api/v1/organization/{organization}/members |
Membres et entrées |
| GET | /api/v1/organization/{organization}/members/{member} |
Membres et entrées |
| POST | /api/v1/organization/{organization}/members/{member}/checkin |
Membres et entrées |
| GET | /api/v1/organization/{organization}/forms |
Formulaires et exportation des répondants |
| GET | /api/v1/organization/{organization}/form_tags |
Formulaires et exportation des répondants |
| GET | /api/v1/organization/{organization}/forms/{form} |
Formulaires et exportation des répondants |
| POST | /api/v1/organization/{organization}/forms/{form}/submit |
Formulaires et exportation des répondants |
| GET | /api/v1/organization/{organization}/forms/{form}/respondents |
Formulaires et exportation des répondants |
| GET | /api/v1/organization/{organization}/forms/{form}/respondents/parameters |
Formulaires et exportation des répondants |
| GET | /api/v1/organization/{organization}/classes |
Cours et calendriers |
| GET | /api/v1/organization/{organization}/classes/{class} |
Cours et calendriers |
| POST | /api/v1/organization/{organization}/classes |
Cours et calendriers |
| PUT | /api/v1/organization/{organization}/classes/{class} |
Cours et calendriers |
| DELETE | /api/v1/organization/{organization}/classes/{class} |
Cours et calendriers |
| GET | /api/v1/organization/{organization}/class_tags |
Cours et calendriers |
| GET | /api/v1/organization/{organization}/class_categories |
Cours et calendriers |
| GET | /api/v1/organization/{organization}/class_events |
Cours et calendriers |
| GET | /api/v1/organization/{organization}/classes/{class}/attendance |
Présences |
| PUT | /api/v1/organization/{organization}/classes/{class}/attendance |
Présences |
| PATCH | /api/v1/organization/{organization}/classes/{class}/attendance |
Présences |
| GET | /api/v1/organization/{organization}/package_categories |
Forfaits de réservation |
| GET | /api/v1/organization/{organization}/packages |
Forfaits de réservation |
| GET | /api/v1/organization/{organization}/package_categories/{package_category}/packages |
Forfaits de réservation |
| GET | /api/v1/organization/{organization}/locations |
Ressources et réservations |
| GET | /api/v1/organization/{organization}/bookings |
Ressources et réservations |
| GET | /api/v1/organization/{organization}/products |
Produits |
| GET | /api/v1/organization/{organization}/product_tags |
Produits |
| GET | /api/v1/organization/{organization}/published_messages |
Messages et modèles publiés |
| GET | /api/v1/organization/{organization}/published_templates |
Messages et modèles publiés |
| GET | /api/v1/organization/{organization}/websites |
Publier des pages |
| GET | / |
Publier des pages |
| GET | /component-schema |
Publier des pages |
| GET | /pages |
Publier des pages |
| POST | /pages |
Publier des pages |
| GET | /pages/{page} |
Publier des pages |
| PUT | /pages/{page}/document |
Publier des pages |
| DELETE | /pages/{page} |
Publier des pages |
| GET | /page-keys |
Publier des pages |
| GET | /page-keys/{key} |
Publier des pages |
| POST | /revisions |
Publier des pages |
| GET | /revisions/{revision} |
Publier des pages |
| POST | /revisions/{revision}/publish |
Publier des pages |
| GET | /assets |
Médias, sections réutilisables et redirections |
| POST | /assets |
Médias, sections réutilisables et redirections |
| GET | /shared-section-keys/{key} |
Médias, sections réutilisables et redirections |
| POST | /shared-sections/revisions |
Médias, sections réutilisables et redirections |
| GET | /redirects |
Médias, sections réutilisables et redirections |
| PUT | /redirects |
Médias, sections réutilisables et redirections |