Gérer les membres de l'équipe

Ce que tu peux faire

Les membres de l'équipe sont les utilisateurs vendeurs de ton compte. L'API te permet de les gérer de bout en bout et de contrôler les dossiers auxquels chaque membre est limité (un membre ne voit que les flipbooks situés dans les dossiers qui lui sont attribués). Les mots de passe ne sont jamais renvoyés par aucun de ces endpoints.

• Lister les membres de l'équipe de ton compte, filtrés par statut d'activité.
• Consulter un membre par son ID de membre, y compris les dossiers qui lui sont attribués.
• Créer ou modifier un membre, en définissant son nom, son e-mail, son mot de passe, son image de profil et son périmètre de dossiers.
• Activer ou désactiver un membre, pour contrôler s'il peut se connecter.
• Supprimer (suppression douce) un membre, ce qui le désactive tout en conservant son historique intact.

Avant de commencer

• Une clé d'API — envoyée dans l'en-tête X-Api-Key, ou sous la forme Authorization: Bearer YOUR_API_KEY, à chaque requête.
• Toutes les requêtes sont adressées à l'URL de base https://go.fliplink.me.
• Plusieurs endpoints prennent un paramètre de chemin {memberId} — c'est l'ID de membre d'équipe issu de List Team Members, pas un ID de flipbook. Passer un ID inconnu renvoie une erreur dont le message dépend de l'endpoint : Get Team Member renvoie "Team member not found", tandis que Set Team Member Active et Delete Team Member renvoient "Item not found".
• Les endpoints d'écriture (set-team-member et set-team-member-active) attendent un corps form-urlencoded (pas JSON).

Lister les membres de l'équipe

GET /api/list-team-members liste les membres de l'équipe de ton compte avec leurs détails d'accès, y compris les dossiers attribués à chaque membre. Filtre par IsActive (1 = actif, par défaut ; 0 = inactif).

curl -X GET 'https://go.fliplink.me/api/list-team-members?IsActive=1' \
  -H 'X-Api-Key: YOUR_API_KEY'

Réponse :

{
  "Result": "OK",
  "Items": [
    {
      "ID": 45452,
      "Name": "Jane Doe",
      "Email": "member@example.com",
      "IsActive": "True",
      "PhotoIMG": "",
      "Total": 0
    }
  ]
}

Consulter un membre de l'équipe

GET /api/get-team-member/{memberId} renvoie un membre par son ID de membre — nom, e-mail, statut de vérification de l'e-mail (IsEmailVerified) et dossiers qui lui sont attribués. Le membre est renvoyé enveloppé dans un objet Item, et Folders est une liste de dossiers séparés par des virgules auxquels il peut accéder (vide = aucune restriction de dossier). Le memberId est l'ID de membre d'équipe issu de List Team Members — pas un ID de flipbook.

curl -X GET 'https://go.fliplink.me/api/get-team-member/96216' \
  -H 'X-Api-Key: YOUR_API_KEY'

Réponse :

{
  "Result": "OK",
  "Item": {
    "ID": 45452,
    "Email": "member@example.com",
    "Name": "Jane Doe",
    "Phone": "",
    "PhotoIMG": "",
    "IsEmailVerified": false,
    "Folders": "Marketing,Sales"
  }
}

Créer ou modifier un membre de l'équipe

POST /api/set-team-member crée un nouveau membre d'équipe ou met à jour un membre existant, en contrôlant qui peut accéder à ton compte et, via le champ Folders, à quels dossiers il est limité. Omets ID ou envoie -1 pour créer ; envoie un ID supérieur à 0 pour mettre à jour. En cas de succès, une entrée est écrite dans le journal d'audit. Le corps est form-urlencoded.

Quelques remarques tirées de la spécification :

• Le nom du membre est un champ Name unique — il n'y a pas de FirstName/LastName.
• Folders est une liste de noms de dossiers séparés par des virgules (par ex. Marketing,Sales) ; laisse-le vide pour n'imposer aucune restriction de dossier. Le membre ne peut accéder qu'aux flipbooks situés dans ces dossiers.
• Password est en clair et chiffré côté serveur ; le laisser vide lors d'une mise à jour conserve le mot de passe existant.
• L'e-mail ne doit pas déjà appartenir à un utilisateur FlipLink, et les e-mails avec alias + sont rejetés.

curl -X POST 'https://go.fliplink.me/api/set-team-member' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Name=Jane' \
  --data-urlencode 'Email=jane@example.com' \
  --data-urlencode 'ID=-1' \
  --data-urlencode 'Password=' \
  --data-urlencode 'ProfileImage=' \
  --data-urlencode 'Folders='

Réponse (création) :

{
  "Result": "OK",
  "Message": "Team member created"
}

Lorsqu'un ID est fourni (le cas de la mise à jour), le message est "Updated successfully" à la place.

Activer ou désactiver un membre de l'équipe

PUT /api/set-team-member-active/{memberId} active ou désactive un membre, pour contrôler s'il peut se connecter et accéder au compte. Le corps est form-urlencoded avec un unique champ IsActive.

curl -X PUT 'https://go.fliplink.me/api/set-team-member-active/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsActive=true'

Réponse :

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Supprimer un membre de l'équipe

DELETE /api/delete-team-member/{memberId} est une suppression douce (désactivation) — les membres de l'équipe ne sont jamais supprimés définitivement. Elle désactive le membre (un alias REST de set-team-member-active avec IsActive=false). Son historique de paiement et ses références d'audit restent intacts, et il peut être réactivé plus tard via PUT /api/set-team-member-active (IsActive=true).

curl -X DELETE 'https://go.fliplink.me/api/delete-team-member/96216' \
  -H 'X-Api-Key: YOUR_API_KEY'

Réponse :

{
  "Result": "OK",
  "Message": "Team member deactivated"
}

Erreurs possibles

• Clé d'API manquante ou invalide → HTTP 401. Renvoie une simple page HTML « Unauthorized » — sans corps JSON. Vérifie que l'en-tête X-Api-Key (ou Authorization: Bearer) est présent et correct. Cela s'applique aux cinq endpoints.
• Aucun membre d'équipe avec cet ID sur Get Team Member (par exemple, tu as passé un ID de flipbook) → HTTP 200 avec le message Team member not found.
• ID d'élément introuvable ou non rattaché à ta clé sur Set Team Member Active et Delete Team Member → HTTP 200 avec le message Item not found.
• Champ de corps inconnu ou mal orthographié sur Set Team Member et Set Team Member Active → HTTP 200 avec le message Unknown field(s) '…'. Expected: ….

Remarques

• Le paramètre de chemin {memberId} est toujours l'ID de membre d'équipe issu de List Team Members — jamais un ID de flipbook.
• Les mots de passe ne sont jamais renvoyés par aucun de ces endpoints.
• Folders limite un membre à des dossiers précis ; une valeur vide signifie aucune restriction de dossier.