Centre d’aide Activity Messenger

Organisation et réseau

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

Les deux points de terminaison exigent l’en-tête X-Activity-Messenger-Api-Key. La clé de l’organisation indiquée dans l’URL est acceptée, tout comme la clé de toute organisation du même réseau et la clé de compte configurée pour l’organisation. Remplacez {organization} par l’identifiant numérique de l’organisation.

Un objet organisation contient les champs suivants :

• id : identifiant numérique de l’organisation. Utilisez-le comme clé stable et dans le chemin de tous les autres points de terminaison.
• name : nom de l’organisation.
• alias : alias (nom court) de l’organisation, ou null.
• microsite_url : URL publique du microsite de l’organisation.
• iframe_url : URL du microsite dans sa présentation intégrable en iframe.

GET /api/v1/organization/{organization}

Récupère les renseignements de base de l’organisation et l’URL de son microsite. La réponse est un seul objet organisation, et non un tableau.

{
  "id": 1234,
  "name": "Hogwarts Recreation",
  "alias": "hogwartsrec",
  "microsite_url": "https://activitymessenger.com/org/1234",
  "iframe_url": "https://activitymessenger.com/iframe//org/1234"
}

GET /api/v1/organization/{organization}/network

Pour les franchises et fédérations, récupère la liste des organisations faisant partie du réseau. Chaque élément est un objet organisation avec les champs ci-dessus; l’organisation appelante en fait partie.

La réponse est un tableau vide ([]) lorsque l’organisation n’appartient pas à un réseau ou n’est pas autorisée à publier dans son réseau. Considérez le résultat comme un tableau d’au plus 50 organisations. Le traitement accepte page et per_page, mais la pagination de ce point de terminaison n’a pas été vérifiée; ne vous y fiez pas.