Gestionar los miembros del equipo

Qué puedes hacer

Los miembros del equipo son los usuarios vendor de tu cuenta. La API te permite gestionarlos de principio a fin y controlar a qué carpetas queda limitado cada miembro (un miembro solo ve los flipbooks dentro de sus carpetas asignadas). Las contraseñas nunca se devuelven en ninguno de estos endpoints.

• Lista los miembros del equipo de tu cuenta, filtrados por estado activo.
• Consulta un solo miembro por su ID de miembro, incluidas las carpetas que tiene asignadas.
• Crea o actualiza un miembro, definiendo su nombre, correo, contraseña, imagen de perfil y ámbito de carpetas.
• Activa o desactiva un miembro, controlando si puede iniciar sesión.
• Elimina (eliminación lógica) un miembro, lo que lo desactiva sin perder su historial.

Antes de empezar

• Una clave de API — enviada como el encabezado X-Api-Key, o como Authorization: Bearer YOUR_API_KEY, en cada solicitud.
• Todas las solicitudes van a la URL base https://go.fliplink.me.
• Varios endpoints reciben un parámetro de ruta {memberId} — este es el ID del miembro del equipo de List Team Members, no un ID de flipbook. Pasar un ID desconocido devuelve un error cuyo mensaje depende del endpoint: Get Team Member devuelve "Team member not found", mientras que Set Team Member Active y Delete Team Member devuelven "Item not found".
• Los endpoints de escritura (set-team-member y set-team-member-active) reciben un cuerpo form-urlencoded (no JSON).

Lista los miembros del equipo

GET /api/list-team-members lista los miembros del equipo de tu cuenta con sus datos de acceso, incluidas las carpetas asignadas a cada miembro. Filtra por IsActive (1 = activo, el valor por defecto; 0 = inactivo).

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

Respuesta:

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

Consulta un solo miembro del equipo

GET /api/get-team-member/{memberId} devuelve un solo miembro por su ID de miembro — nombre, correo, estado de verificación del correo (IsEmailVerified) y las carpetas que tiene asignadas. El miembro se devuelve envuelto en un objeto Item, y Folders es una lista separada por comas de las carpetas a las que puede acceder (vacío = sin restricción de carpetas). El memberId es el ID del miembro del equipo de List Team Members — no un ID de flipbook.

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

Respuesta:

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

Crea o actualiza un miembro del equipo

POST /api/set-team-member crea un nuevo miembro del equipo o actualiza uno existente, controlando quién puede acceder a tu cuenta y, mediante el campo Folders, a qué carpetas queda limitado. Omite ID o envía -1 para crear; envía un ID mayor que 0 para actualizar. Si tiene éxito, se escribe una entrada en el registro de auditoría. El cuerpo es form-urlencoded.

Algunas notas de la especificación:

• El nombre del miembro es un único campo Name — no hay FirstName/LastName.
• Folders es una lista separada por comas de nombres de carpetas (por ejemplo, Marketing,Sales); déjalo vacío para no tener restricción de carpetas. El miembro solo puede acceder a los flipbooks dentro de estas carpetas.
• Password va en texto plano y se cifra en el servidor; dejarlo vacío al actualizar mantiene la contraseña existente.
• El correo no debe pertenecer ya a un usuario de FlipLink, y los correos con alias + se rechazan.

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='

Respuesta (creación):

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

Cuando se envía ID (la vía de actualización), el mensaje es "Updated successfully" en su lugar.

Activa o desactiva un miembro del equipo

PUT /api/set-team-member-active/{memberId} activa o desactiva un miembro, controlando si puede iniciar sesión y acceder a la cuenta. El cuerpo es form-urlencoded con un único campo 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'

Respuesta:

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

Elimina un miembro del equipo

DELETE /api/delete-team-member/{memberId} es una eliminación lógica (desactivación) — los miembros del equipo nunca se eliminan de forma definitiva. Desactiva al miembro (un alias REST de set-team-member-active con IsActive=false). Su historial de pagos y las referencias de auditoría permanecen intactos, y puede reactivarse más tarde con 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'

Respuesta:

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

Errores posibles

• Clave de API ausente o no válida → HTTP 401. Esto devuelve una página HTML de "Unauthorized" sin formato — no hay cuerpo JSON. Comprueba que el encabezado X-Api-Key (o Authorization: Bearer) esté presente y sea correcto. Esto aplica a los cinco endpoints.
• Ningún miembro del equipo con ese ID en Get Team Member (por ejemplo, pasaste un ID de flipbook) → HTTP 200 con el mensaje Team member not found.
• ID de elemento no encontrado o no perteneciente a tu clave en Set Team Member Active y Delete Team Member → HTTP 200 con el mensaje Item not found.
• Campo del cuerpo desconocido o mal escrito en Set Team Member y Set Team Member Active → HTTP 200 con el mensaje Unknown field(s) '…'. Expected: ….

Notas

• El parámetro de ruta {memberId} es siempre el ID del miembro del equipo de List Team Members — nunca un ID de flipbook.
• Las contraseñas nunca se devuelven en ninguno de estos endpoints.
• Folders limita a un miembro a carpetas específicas; un valor vacío significa sin restricción de carpetas.