Gestire i membri del team

Cosa puoi fare

I membri del team sono gli utenti vendor del tuo account. L'API ti permette di gestirli da cima a fondo e di controllare a quali cartelle ciascun membro è limitato (un membro vede solo i flipbook all'interno delle cartelle a lui assegnate). Le password non vengono mai restituite da nessuno di questi endpoint.

• Elencare i membri del team del tuo account, filtrati per stato attivo.
• Leggere un singolo membro tramite il suo ID membro, incluse le cartelle a lui assegnate.
• Creare o aggiornare un membro, impostando nome, email, password, immagine del profilo e ambito delle cartelle.
• Attivare o disattivare un membro, controllando se può accedere.
• Eliminare (soft delete) un membro, che lo disattiva mantenendone intatta la cronologia.

Prima di iniziare

• Una chiave API — inviata come header X-Api-Key, o come Authorization: Bearer YOUR_API_KEY, in ogni richiesta.
• Tutte le richieste vanno all'URL di base https://go.fliplink.me.
• Diversi endpoint accettano un parametro {memberId} nel percorso — è l'ID del membro del team da List Team Members, non un ID di flipbook. Passare un ID sconosciuto restituisce un errore il cui messaggio dipende dall'endpoint: Get Team Member restituisce "Team member not found", mentre Set Team Member Active e Delete Team Member restituiscono "Item not found".
• Gli endpoint di scrittura (set-team-member e set-team-member-active) accettano un body form-urlencoded (non JSON).

Elencare i membri del team

GET /api/list-team-members elenca i membri del team del tuo account con i loro dettagli di accesso, incluse le cartelle assegnate a ciascun membro. Filtra per IsActive (1 = attivo, il predefinito; 0 = inattivo).

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

Risposta:

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

Ottenere un singolo membro del team

GET /api/get-team-member/{memberId} restituisce un singolo membro tramite il suo ID membro — nome, email, stato di verifica dell'email (IsEmailVerified) e le cartelle a lui assegnate. Il membro viene restituito racchiuso in un oggetto Item, e Folders è un elenco separato da virgole delle cartelle a cui può accedere (vuoto = nessuna restrizione di cartella). Il memberId è l'ID del membro del team da List Team Members — non un ID di flipbook.

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

Risposta:

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

Creare o aggiornare un membro del team

POST /api/set-team-member crea un nuovo membro del team o ne aggiorna uno esistente, controllando chi può accedere al tuo account e, tramite il campo Folders, a quali cartelle è limitato. Ometti ID o invia -1 per creare; invia un ID maggiore di 0 per aggiornare. In caso di successo viene scritta una voce nel registro di audit. Il body è form-urlencoded.

Alcune note dalla specifica:

• Il nome del membro è un unico campo Name — non c'è FirstName/LastName.
• Folders è un elenco di nomi di cartelle separati da virgole (per esempio Marketing,Sales); lascialo vuoto per nessuna restrizione di cartella. Il membro può accedere solo ai flipbook all'interno di queste cartelle.
• Password è in testo semplice e viene cifrata lato server; lasciarla vuota in aggiornamento mantiene la password esistente.
• L'email non deve già appartenere a un utente FlipLink, e le email con alias + vengono rifiutate.

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

Risposta (creazione):

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

Quando ID viene fornito (il percorso di aggiornamento), il messaggio è invece "Updated successfully".

Attivare o disattivare un membro del team

PUT /api/set-team-member-active/{memberId} attiva o disattiva un membro, controllando se può accedere e usare l'account. Il body è form-urlencoded con un unico 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'

Risposta:

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

Eliminare un membro del team

DELETE /api/delete-team-member/{memberId} è un soft delete (disattivazione) — i membri del team non vengono mai eliminati definitivamente. Disattiva il membro (un alias REST di set-team-member-active con IsActive=false). La loro cronologia dei pagamenti e i riferimenti di audit restano intatti, e possono essere riattivati in seguito tramite 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'

Risposta:

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

Errori possibili

• Chiave API mancante o non valida → HTTP 401. Restituisce una semplice pagina HTML di Unauthorized — non c'è alcun body JSON. Controlla che l'header X-Api-Key (o Authorization: Bearer) sia presente e corretto. Questo vale per tutti e cinque gli endpoint.
• Nessun membro del team con quell'ID su Get Team Member (per esempio, hai passato un ID di flipbook) → HTTP 200 con messaggio Team member not found.
• ID dell'elemento non trovato o non di proprietà della tua chiave su Set Team Member Active e Delete Team Member → HTTP 200 con messaggio Item not found.
• Campo del body sconosciuto o scritto male su Set Team Member e Set Team Member Active → HTTP 200 con messaggio Unknown field(s) '…'. Expected: ….

Note

• Il parametro {memberId} nel percorso è sempre l'ID del membro del team da List Team Members — mai un ID di flipbook.
• Le password non vengono mai restituite da nessuno di questi endpoint.
• Folders delimita un membro a cartelle specifiche; un valore vuoto significa nessuna restrizione di cartella.