Teamleden beheren

Teamleden

Bekijk, lees, maak, werk bij, activeer, deactiveer en verwijder de teamleden op je account, inclusief de mappen waartoe elk lid beperkt is.

API's die in deze discussie worden gebruikt

Iets onjuist of verouderd in deze gids?

Wat je kunt doen

Teamleden zijn de vendorgebruikers op je account. Met de API beheer je ze van begin tot eind en bepaal je tot welke mappen elk lid beperkt is (een lid ziet alleen flipbooks binnen de toegewezen mappen). Wachtwoorden worden door geen van deze endpoints teruggegeven.

  • Bekijk de teamleden op je account, gefilterd op actieve status.
  • Lees één lid via zijn lid-ID, inclusief de mappen waaraan het is toegewezen.
  • Maak of werk bij een lid en stel de naam, e-mail, wachtwoord, profielafbeelding en mapscope in.
  • Activeer of deactiveer een lid, waarmee je bepaalt of het kan inloggen.
  • Verwijder (soft delete) een lid, wat het deactiveert maar de geschiedenis intact houdt.

Voordat je begint

  • Een API-sleutel — meegestuurd als de X-Api-Key-header, of als Authorization: Bearer YOUR_API_KEY, op elk verzoek.
  • Alle verzoeken gaan naar de basis-URL https://go.fliplink.me.
  • Meerdere endpoints nemen een {memberId}-padparameter — dit is de teamlid-ID uit List Team Members, geen flipbook-ID. Het meegeven van een onbekende ID geeft een fout waarvan het bericht afhangt van het endpoint: Get Team Member geeft "Team member not found", terwijl Set Team Member Active en Delete Team Member "Item not found" geven.
  • De schrijf-endpoints (set-team-member en set-team-member-active) nemen een form-urlencoded body (geen JSON).

Teamleden opsommen

GET /api/list-team-members somt de teamleden op je account op met hun toegangsgegevens, inclusief de mappen waaraan elk lid is toegewezen. Filter op IsActive (1 = actief, de standaard; 0 = inactief).

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

Response:

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

Eén teamlid ophalen

GET /api/get-team-member/{memberId} geeft één lid terug via zijn lid-ID — naam, e-mail, e-mailverificatiestatus (IsEmailVerified) en de mappen waaraan het is toegewezen. Het lid wordt teruggegeven verpakt in een Item-object, en Folders is een door komma's gescheiden lijst van de mappen waartoe het toegang heeft (leeg = geen mapbeperking). De memberId is de teamlid-ID uit List Team Members — geen flipbook-ID.

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

Response:

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

Een teamlid maken of bijwerken

POST /api/set-team-member maakt een nieuw teamlid aan of werkt een bestaand lid bij, en bepaalt wie toegang tot je account heeft en — via het veld Folders — tot welke mappen het beperkt is. Laat ID weg of stuur -1 om aan te maken; stuur een ID groter dan 0 om bij te werken. Bij succes wordt een auditlogboekvermelding weggeschreven. De body is form-urlencoded.

Een paar opmerkingen uit de spec:

  • De naam van het lid is één Name-veld — er is geen FirstName/LastName.
  • Folders is een door komma's gescheiden lijst van mapnamen (bijv. Marketing,Sales); laat het leeg voor geen mapbeperking. Het lid heeft alleen toegang tot flipbooks binnen deze mappen.
  • Password is platte tekst en wordt server-side versleuteld; het leeg laten bij een update behoudt het bestaande wachtwoord.
  • De e-mail mag niet al bij een FlipLink-gebruiker horen, en e-mails met een +-alias worden geweigerd.
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='

Response (aanmaken):

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

Wanneer ID wordt meegegeven (het update-pad), is het bericht in plaats daarvan "Updated successfully".

Een teamlid activeren of deactiveren

PUT /api/set-team-member-active/{memberId} activeert of deactiveert een lid, waarmee je bepaalt of het kan inloggen en toegang tot het account heeft. De body is form-urlencoded met één IsActive-veld.

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

Response:

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

Een teamlid verwijderen

DELETE /api/delete-team-member/{memberId} is een soft delete (deactivering) — teamleden worden nooit hard verwijderd. Het deactiveert het lid (een REST-alias voor set-team-member-active met IsActive=false). Hun betaalgeschiedenis en auditverwijzingen blijven intact, en ze kunnen later opnieuw worden geactiveerd 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'

Response:

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

Mogelijke fouten

  • Ontbrekende of ongeldige API-sleutel → HTTP 401. Dit geeft een kale Unauthorized-HTML-pagina terug — er is geen JSON-body. Controleer of de X-Api-Key-header (of Authorization: Bearer) aanwezig en correct is. Dit geldt voor alle vijf de endpoints.
  • Geen teamlid met die ID bij Get Team Member (bijvoorbeeld als je een flipbook-ID hebt meegegeven) → HTTP 200 met bericht Team member not found.
  • Item-ID niet gevonden of niet in eigendom van je sleutel bij Set Team Member Active en Delete Team Member → HTTP 200 met bericht Item not found.
  • Onbekend of verkeerd gespeld body-veld bij Set Team Member en Set Team Member Active → HTTP 200 met bericht Unknown field(s) '…'. Expected: ….

Opmerkingen

  • De {memberId}-padparameter is altijd de teamlid-ID uit List Team Members — nooit een flipbook-ID.
  • Wachtwoorden worden door geen van deze endpoints teruggegeven.
  • Folders beperkt een lid tot specifieke mappen; een lege waarde betekent geen mapbeperking.