Centre d’aide

Membres et entrées

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

Les membres sont les personnes qui possèdent un abonnement auprès de votre organisation. Chaque membre est identifié par son identifiant unique dans la base de données, mais peut avoir un membership_no distinct, visible par le client dans le code-barres de sa carte. Vous pouvez toujours effectuer la recherche avec membership_no, dont l’unicité est garantie.

Un membre possède des dates active_at et expired_at. L’abonnement est actif pendant cette période, bornes comprises. Lorsque ces dates sont null, l’abonnement est toujours actif. L’abonnement expire à la fin de la journée indiquée par expired_at.

L’abonnement possède aussi un status. Lorsque celui-ci vaut null, le membre est actif. Lorsque le statut est pending ou suspended, l’accès lié à l’abonnement doit être bloqué.

Un objet membre contient les attributs suivants.

{
  "id": 1234,
  "membership_no": 1234,
  "name": "Harry Potter",
  "first_name": "Harry",
  "last_name": "Potter",
  "email": "harry@hogwartsrec.com",
  "mobile": "555-123-1234",
  "expired_at": "2023-05-19",
  "active_at": "2022-05-19",
  "status": null,
  "image_url": null}

GET /api/v1/organization/{organization}/members

Récupère les membres. Consultez la section Pagination pour récupérer tous les abonnements. Pour obtenir le maximum par page, transmettez par exemple ?per_page=250.

GET /api/v1/organization/{organization}/members/{member}

Récupère un membre à partir de son membership_no ou de son identifiant dans la base de données.

POST /api/v1/organization/{organization}/members/{member}/checkin

Appelez ce point de terminaison lorsqu’une carte de membre est numérisée. Dans l’URL, {member} correspond au membership_no ou à l’identifiant dans la base de données. Dans le corps de la requête, location_id est réservé à une utilisation future et doit valoir null. L’attribut action doit valoir pass ou fail. Utilisez fail en dehors de la période définie par active_at et expired_at, ainsi que lorsque status n’est pas null. En cas de succès, l’appel renvoie le code HTTP 200 et le membre dans le corps de la réponse.

{
  "location_id": null,
  "action": "pass"}