{ "info": { "name": "Meeting Hub — logiciel d’établissement", "description": "L’API, vue par le logiciel d’un établissement.\n\nAVANT DE COMMENCER — posez trois variables de collection :\n · `base` — https://reunion.votre-etablissement.cm\n · `cle` — la clé rendue UNE fois à sa création (mhk_…)\n · `institution` — l’identifiant de l’établissement, rendu par GET /me\n\nPuis lancez GET /me : elle rend le nom de la clé, son établissement et ses\ncapacités. C’est la requête qui confirme le branchement.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{cle}}", "type": "string" } ] }, "variable": [ { "key": "base", "value": "https://reunion.exemple.cm", "type": "string" }, { "key": "cle", "value": "mhk_remplacez_moi", "type": "string" }, { "key": "institution", "value": "", "type": "string" }, { "key": "lessonId", "value": "", "type": "string" }, { "key": "ref", "value": "ENT-12345", "type": "string" } ], "item": [ { "name": "me", "item": [ { "name": "GET /me", "request": { "method": "GET", "header": [ { "key": "Api-Version", "value": "1" } ], "url": { "raw": "{{base}}/api/me", "host": [ "{{base}}" ], "path": [ "api", "me" ] }, "description": "Qui appelle, et où il peut agir.\n\nExige : public" } }, { "name": "PATCH /me", "request": { "method": "PATCH", "header": [ { "key": "Api-Version", "value": "1" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base}}/api/me", "host": [ "{{base}}" ], "path": [ "api", "me" ] }, "description": "Son nom, et l’accord de son rôle (masculine, feminine).\n\nExige : signed-in", "body": { "mode": "raw", "raw": "{\n \"displayName\": \"Awa Ngono\",\n \"agreement\": \"feminine\"\n}" } } }, { "name": "GET /me/tickets", "request": { "method": "GET", "header": [ { "key": "Api-Version", "value": "1" } ], "url": { "raw": "{{base}}/api/me/tickets", "host": [ "{{base}}" ], "path": [ "api", "me", "tickets" ] }, "description": "Mes demandes d’assistance, avec le lien de suivi de chacune.\n\nExige : signed-in" } }, { "name": "POST /me/tickets", "request": { "method": "POST", "header": [ { "key": "Api-Version", "value": "1" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base}}/api/me/tickets", "host": [ "{{base}}" ], "path": [ "api", "me", "tickets" ] }, "description": "Ouvre une demande d’assistance sous son compte. share=true la partage avec l’établissement actif.\n\nExige : signed-in", "body": { "mode": "raw", "raw": "{\n \"category\": \"meeting\",\n \"subject\": \"Pas de son\",\n \"description\": \"Depuis ce matin…\",\n \"share\": true,\n \"lang\": \"fr\"\n}" } } }, { "name": "GET /me/classes", "request": { "method": "GET", "header": [ { "key": "Api-Version", "value": "1" } ], "url": { "raw": "{{base}}/api/me/classes", "host": [ "{{base}}" ], "path": [ "api", "me", "classes" ] }, "description": "Mes classes, dans tous mes établissements, et la salle attitrée de chacune.\n\nExige : signed-in" } }, { "name": "GET /me/lessons", "request": { "method": "GET", "header": [ { "key": "Api-Version", "value": "1" } ], "url": { "raw": "{{base}}/api/me/lessons", "host": [ "{{base}}" ], "path": [ "api", "me", "lessons" ] }, "description": "Mes prochains cours : ceux que j’enseigne, dans tous mes établissements (from, to).\n\nExige : signed-in" } }, { "name": "PUT /me/password", "request": { "method": "PUT", "header": [ { "key": "Api-Version", "value": "1" } ], "url": { "raw": "{{base}}/api/me/password", "host": [ "{{base}}" ], "path": [ "api", "me", "password" ] }, "description": "Change son mot de passe ; l’actuel est demandé.\n\nExige : signed-in" } }, { "name": "PUT /me/identifiers", "request": { "method": "PUT", "header": [ { "key": "Api-Version", "value": "1" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base}}/api/me/identifiers", "host": [ "{{base}}" ], "path": [ "api", "me", "identifiers" ] }, "description": "Change son courriel ou son téléphone ; le mot de passe est demandé.\n\nExige : signed-in", "body": { "mode": "raw", "raw": "{\n \"email\": \"awa@ecole.cm\",\n \"phone\": \"699123456\",\n \"password\": \"…\"\n}" } } }, { "name": "POST /me/email/proof", "request": { "method": "POST", "header": [ { "key": "Api-Version", "value": "1" } ], "url": { "raw": "{{base}}/api/me/email/proof", "host": [ "{{base}}" ], "path": [ "api", "me", "email", "proof" ] }, "description": "Renvoie le lien qui confirme son courriel. Il ne part qu’à l’adresse, et n’est jamais rendu ici.\n\nExige : signed-in" } }, { "name": "GET /me/invitations", "request": { "method": "GET", "header": [ { "key": "Api-Version", "value": "1" } ], "url": { "raw": "{{base}}/api/me/invitations", "host": [ "{{base}}" ], "path": [ "api", "me", "invitations" ] }, "description": "Les établissements qui m’invitent, et que je n’ai pas encore rejoints.\n\nExige : signed-in" } }, { "name": "POST /me/invitations/:orgId", "request": { "method": "POST", "header": [ { "key": "Api-Version", "value": "1" } ], "url": { "raw": "{{base}}/api/me/invitations/{{orgId}}", "host": [ "{{base}}" ], "path": [ "api", "me", "invitations", "{{orgId}}" ] }, "description": "Accepte l’invitation de cet établissement : j’y entre, avec le rôle et les classes prévus.\n\nExige : signed-in" } }, { "name": "DELETE /me/invitations/:orgId", "request": { "method": "DELETE", "header": [ { "key": "Api-Version", "value": "1" } ], "url": { "raw": "{{base}}/api/me/invitations/{{orgId}}", "host": [ "{{base}}" ], "path": [ "api", "me", "invitations", "{{orgId}}" ] }, "description": "Décline l’invitation de cet établissement.\n\nExige : signed-in" } } ] }, { "name": "institutions", "item": [ { "name": "GET /institutions/:institutionId", "request": { "method": "GET", "header": [ { "key": "Api-Version", "value": "1" } ], "url": { "raw": "{{base}}/api/institutions/{{institution}}", "host": [ "{{base}}" ], "path": [ "api", "institutions", "{{institution}}" ] }, "description": "L’établissement, son statut, et ce que l’appelant peut y faire.\n\nExige : institution.view" } }, { "name": "GET /institutions", "request": { "method": "GET", "header": [ { "key": "Api-Version", "value": "1" } ], "url": { "raw": "{{base}}/api/institutions", "host": [ "{{base}}" ], "path": [ "api", "institutions" ] }, "description": "Les établissements que l’appelant atteint : les siens, celui de sa clé, ceux qu’il a ouverts.\n\nExige : signed-in" } } ] }, { "name": "room-kinds", "item": [ { "name": "GET /institutions/:institutionId/room-kinds", "request": { "method": "GET", "header": [ { "key": "Api-Version", "value": "1" } ], "url": { "raw": "{{base}}/api/institutions/{{institution}}/room-kinds", "host": [ "{{base}}" ], "path": [ "api", "institutions", "{{institution}}", "room-kinds" ] }, "description": "Les types de salle et leurs règles, pour composer un formulaire.\n\nExige : institution.view" } } ] }, { "name": "lessons", "item": [ { "name": "GET /institutions/:institutionId/lessons", "request": { "method": "GET", "header": [ { "key": "Api-Version", "value": "1" } ], "url": { "raw": "{{base}}/api/institutions/{{institution}}/lessons", "host": [ "{{base}}" ], "path": [ "api", "institutions", "{{institution}}", "lessons" ] }, "description": "L’emploi du temps sur une fenêtre (from, to), éventuellement pour une classe (groupId).\n\nExige : schedule.read" } }, { "name": "POST /institutions/:institutionId/lessons", "request": { "method": "POST", "header": [ { "key": "Api-Version", "value": "1" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base}}/api/institutions/{{institution}}/lessons", "host": [ "{{base}}" ], "path": [ "api", "institutions", "{{institution}}", "lessons" ] }, "description": "Pose un cours dans une salle, pour une classe et son auditoire.\n\nExige : schedule.write", "body": { "mode": "raw", "raw": "{\n \"room\": \"abc-defg-hij\",\n \"groupId\": \"…\",\n \"title\": \"Mathématiques\",\n \"startsAt\": \"2026-10-14T08:00:00Z\",\n \"durationMinutes\": 120\n}" } } }, { "name": "POST /institutions/:institutionId/lessons/series", "request": { "method": "POST", "header": [ { "key": "Api-Version", "value": "1" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base}}/api/institutions/{{institution}}/lessons/series", "host": [ "{{base}}" ], "path": [ "api", "institutions", "{{institution}}", "lessons", "series" ] }, "description": "Pose un cours chaque semaine jusqu’à une date, avec sa classe et son enseignant.\n\nExige : schedule.write", "body": { "mode": "raw", "raw": "{\n \"room\": \"abc-defg-hij\",\n \"title\": \"Mathématiques\",\n \"startsAt\": \"2026-10-06T08:00:00Z\",\n \"durationMinutes\": 120,\n \"until\": \"2027-06-30T00:00:00Z\",\n \"groupId\": \"…\",\n \"teacherId\": \"…\"\n}" } } }, { "name": "PUT /institutions/:institutionId/lessons", "request": { "method": "PUT", "header": [ { "key": "Api-Version", "value": "1" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base}}/api/institutions/{{institution}}/lessons", "host": [ "{{base}}" ], "path": [ "api", "institutions", "{{institution}}", "lessons" ] }, "description": "Dépose un emploi du temps, cours par cours, chacun sous sa référence : rejouable, il n’efface rien.\n\nExige : schedule.write", "body": { "mode": "raw", "raw": "{\n \"sessions\": [\n {\n \"ref\": \"ENT-12345\",\n \"room\": {\n \"ref\": \"salle-204\",\n \"name\": \"Salle 204\"\n },\n \"group\": {\n \"ref\": \"bts-sio-1\",\n \"name\": \"BTS SIO 1\"\n },\n \"title\": \"Mathématiques\",\n \"startsAt\": \"2026-10-14T08:00:00Z\",\n \"durationMinutes\": 120\n }\n ]\n}" } } }, { "name": "GET /institutions/:institutionId/lessons/conflicts", "request": { "method": "GET", "header": [ { "key": "Api-Version", "value": "1" } ], "url": { "raw": "{{base}}/api/institutions/{{institution}}/lessons/conflicts", "host": [ "{{base}}" ], "path": [ "api", "institutions", "{{institution}}", "lessons", "conflicts" ] }, "description": "Les chevauchements : une salle réservée deux fois, une classe attendue à deux endroits.\n\nExige : schedule.read" } }, { "name": "DELETE /institutions/:institutionId/lessons/by-ref/:ref", "request": { "method": "DELETE", "header": [ { "key": "Api-Version", "value": "1" } ], "url": { "raw": "{{base}}/api/institutions/{{institution}}/lessons/by-ref/{{ref}}", "host": [ "{{base}}" ], "path": [ "api", "institutions", "{{institution}}", "lessons", "by-ref", "{{ref}}" ] }, "description": "Annule un cours déposé, par la référence qu’il porte chez vous.\n\nExige : schedule.write" } }, { "name": "GET /institutions/:institutionId/lessons/:lessonId", "request": { "method": "GET", "header": [ { "key": "Api-Version", "value": "1" } ], "url": { "raw": "{{base}}/api/institutions/{{institution}}/lessons/{{lessonId}}", "host": [ "{{base}}" ], "path": [ "api", "institutions", "{{institution}}", "lessons", "{{lessonId}}" ] }, "description": "Un cours.\n\nExige : schedule.read" } }, { "name": "DELETE /institutions/:institutionId/lessons/:lessonId", "request": { "method": "DELETE", "header": [ { "key": "Api-Version", "value": "1" } ], "url": { "raw": "{{base}}/api/institutions/{{institution}}/lessons/{{lessonId}}", "host": [ "{{base}}" ], "path": [ "api", "institutions", "{{institution}}", "lessons", "{{lessonId}}" ] }, "description": "Annule un cours.\n\nExige : schedule.write" } }, { "name": "PUT /institutions/:institutionId/lessons/:lessonId/audiences", "request": { "method": "PUT", "header": [ { "key": "Api-Version", "value": "1" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base}}/api/institutions/{{institution}}/lessons/{{lessonId}}/audiences", "host": [ "{{base}}" ], "path": [ "api", "institutions", "{{institution}}", "lessons", "{{lessonId}}", "audiences" ] }, "description": "Diffuse un cours à des classes d’autres centres.\n\nExige : schedule.write", "body": { "mode": "raw", "raw": "{\n \"groupIds\": [\n \"…\"\n ]\n}" } } }, { "name": "PUT /institutions/:institutionId/lessons/:lessonId/teacher", "request": { "method": "PUT", "header": [ { "key": "Api-Version", "value": "1" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base}}/api/institutions/{{institution}}/lessons/{{lessonId}}/teacher", "host": [ "{{base}}" ], "path": [ "api", "institutions", "{{institution}}", "lessons", "{{lessonId}}", "teacher" ] }, "description": "Désigne l’enseignant du cours, ou son remplaçant pour ce cours ; nul le retire.\n\nExige : schedule.write", "body": { "mode": "raw", "raw": "{\n \"teacherId\": \"…\"\n}" } } }, { "name": "GET /institutions/:institutionId/lessons/:lessonId/attendance", "request": { "method": "GET", "header": [ { "key": "Api-Version", "value": "1" } ], "url": { "raw": "{{base}}/api/institutions/{{institution}}/lessons/{{lessonId}}/attendance", "host": [ "{{base}}" ], "path": [ "api", "institutions", "{{institution}}", "lessons", "{{lessonId}}", "attendance" ] }, "description": "La feuille de présence d’un cours clos, ligne par ligne.\n\nExige : attendance.read" } }, { "name": "GET /institutions/:institutionId/lessons/:lessonId/attendance.csv", "request": { "method": "GET", "header": [ { "key": "Api-Version", "value": "1" } ], "url": { "raw": "{{base}}/api/institutions/{{institution}}/lessons/{{lessonId}}/attendance.csv", "host": [ "{{base}}" ], "path": [ "api", "institutions", "{{institution}}", "lessons", "{{lessonId}}", "attendance.csv" ] }, "description": "La feuille en CSV, sous le nom de fichier que l’établissement archivera.\n\nExige : attendance.read" } }, { "name": "GET /institutions/:institutionId/lessons/:lessonId/attendance.html", "request": { "method": "GET", "header": [ { "key": "Api-Version", "value": "1" } ], "url": { "raw": "{{base}}/api/institutions/{{institution}}/lessons/{{lessonId}}/attendance.html", "host": [ "{{base}}" ], "path": [ "api", "institutions", "{{institution}}", "lessons", "{{lessonId}}", "attendance.html" ] }, "description": "La feuille à imprimer.\n\nExige : attendance.read" } }, { "name": "POST /institutions/:institutionId/lessons/:lessonId/attendance/close", "request": { "method": "POST", "header": [ { "key": "Api-Version", "value": "1" } ], "url": { "raw": "{{base}}/api/institutions/{{institution}}/lessons/{{lessonId}}/attendance/close", "host": [ "{{base}}" ], "path": [ "api", "institutions", "{{institution}}", "lessons", "{{lessonId}}", "attendance", "close" ] }, "description": "Arrête la feuille sans attendre le balayage ; déjà close, elle est rendue telle quelle.\n\nExige : schedule.write" } } ] }, { "name": "centres", "item": [ { "name": "GET /institutions/:institutionId/centres", "request": { "method": "GET", "header": [ { "key": "Api-Version", "value": "1" } ], "url": { "raw": "{{base}}/api/institutions/{{institution}}/centres", "host": [ "{{base}}" ], "path": [ "api", "institutions", "{{institution}}", "centres" ] }, "description": "Les centres — pour un directeur de centre, les siens.\n\nExige : institution.view" } } ] }, { "name": "classes", "item": [ { "name": "PUT /institutions/:institutionId/classes/by-ref/:ref/roster", "request": { "method": "PUT", "header": [ { "key": "Api-Version", "value": "1" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base}}/api/institutions/{{institution}}/classes/by-ref/{{ref}}/roster", "host": [ "{{base}}" ], "path": [ "api", "institutions", "{{institution}}", "classes", "by-ref", "{{ref}}", "roster" ] }, "description": "Dépose la liste des inscrits d’une classe. À blanc par défaut : écrire ?dryRun=false.\n\nExige : roster.write", "body": { "mode": "raw", "raw": "{\n \"members\": [\n {\n \"email\": \"awa@ecole.cm\",\n \"displayName\": \"Awa Diallo\"\n }\n ]\n}" } } } ] }, { "name": "email", "item": [ { "name": "POST /email/confirm", "request": { "method": "POST", "header": [ { "key": "Api-Version", "value": "1" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base}}/api/email/confirm", "host": [ "{{base}}" ], "path": [ "api", "email", "confirm" ] }, "description": "Consomme le lien reçu par courriel : l’adresse est désormais prouvée. 410 si le lien ne vaut plus.\n\nExige : public", "body": { "mode": "raw", "raw": "{\n \"token\": \"…\"\n}" } } } ] }, { "name": "rooms", "item": [ { "name": "GET /rooms/:code/team", "request": { "method": "GET", "header": [ { "key": "Api-Version", "value": "1" } ], "url": { "raw": "{{base}}/api/rooms/{{code}}/team", "host": [ "{{base}}" ], "path": [ "api", "rooms", "{{code}}", "team" ] }, "description": "Le titulaire de la salle et ses co-animateurs.\n\nExige : signed-in" } }, { "name": "PUT /rooms/:code/team/:accountId", "request": { "method": "PUT", "header": [ { "key": "Api-Version", "value": "1" } ], "url": { "raw": "{{base}}/api/rooms/{{code}}/team/{{accountId}}", "host": [ "{{base}}" ], "path": [ "api", "rooms", "{{code}}", "team", "{{accountId}}" ] }, "description": "Fait d’une personne de l’établissement un co-animateur de la salle.\n\nExige : signed-in" } }, { "name": "POST /rooms/:code/team", "request": { "method": "POST", "header": [ { "key": "Api-Version", "value": "1" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base}}/api/rooms/{{code}}/team", "host": [ "{{base}}" ], "path": [ "api", "rooms", "{{code}}", "team" ] }, "description": "Fait d’une personne de l’établissement un co-animateur, par son courriel ou son téléphone.\n\nExige : signed-in", "body": { "mode": "raw", "raw": "{\n \"identifier\": \"699123456\"\n}" } } }, { "name": "DELETE /rooms/:code/team/:accountId", "request": { "method": "DELETE", "header": [ { "key": "Api-Version", "value": "1" } ], "url": { "raw": "{{base}}/api/rooms/{{code}}/team/{{accountId}}", "host": [ "{{base}}" ], "path": [ "api", "rooms", "{{code}}", "team", "{{accountId}}" ] }, "description": "Retire un co-animateur ; le titulaire, lui, transmet d’abord la salle.\n\nExige : signed-in" } }, { "name": "POST /rooms/:code/owner", "request": { "method": "POST", "header": [ { "key": "Api-Version", "value": "1" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base}}/api/rooms/{{code}}/owner", "host": [ "{{base}}" ], "path": [ "api", "rooms", "{{code}}", "owner" ] }, "description": "Transmet la salle à une personne de l’établissement (identifiant, courriel ou téléphone) ; l’ancien titulaire reste co-animateur.\n\nExige : signed-in", "body": { "mode": "raw", "raw": "{\n \"identifier\": \"collegue@ecole.cm\"\n}" } } } ] } ] }