Hoe medewerkers toe te voegen aan Plecto via API
POST-verzoek om leden in Plecto te creëren
Endpoint: https://app.plecto.com/api/v2/members/
POST een verzoek zoals weergegeven in het bovenstaande voorbeeld. Dit verzoek bevat minimale sleutels om een gebruiker (lid/werknemer) in Plecto zonder inlogtoegang te creëren.
Hier is een overzicht van elke sleutel:
-
"updating_api_provider_id": "API Provider ID"
- Dit zal worden weergegeven als de Externe ID in het werknemersprofiel. Eenmaal verzonden, kun je deze naam niet meer overschrijven.
-
"updating_api_provider": "MIJN API"
- Dit zal de Systeemnaam zijn, ook bekend als Gegevensleverancier. Als je deze sleutel bijwerkt en een nieuw verzoek verzendt terwijl je andere sleutels hetzelfde houdt, zal het werknemersprofiel in Plecto een nieuwe Gegevensleverancier aan de lijst toevoegen.
-
"updating_api_provider_email": "api.email@example.com"
- Dit is het e-mailadres van de gebruiker. Eenmaal verzonden, is het niet mogelijk om het e-mailadres te overschrijven (bijvoorbeeld, als je het e-mailadres bijwerkt naar api.email_new@exaple.com).
-
"name": "John Doe"
- Dit is de naam van de gebruiker. Meerdere namen worden automatisch gesplitst in voor- en achternaamvelden. Je kunt het gemakkelijk overschrijven.
-
"is_active": true
- Om een gebruiker te deactiveren, stel je deze sleutel in op false.
-
"teams": []
- Dit is een verplichte sleutel, maar je kunt het leeg laten. Als je teams wilt specificeren, controleer dan de https://app.plecto.com/api/v2/teams/ endpoint en voeg de id's van je teams toe. Voor meerdere teams, scheid ze met een komma.
Je kunt andere, niet-verplichte sleutels toevoegen (je zult een lijst van sleutels in de verzoekrespons zien, maar alleen de hieronder vermelde sleutels staan je toe om te schrijven):
-
"title": "Senior API Specialist"
-
"display_name": "Anchorman"
-
"manager": "e1c111ebbc1111be1cbb1c111ced1111"
-
"managed_teams": []
Hoe medewerkers uit te nodigen voor Plecto via API
In de vorige stap hebben we laten zien hoe je een werknemer zonder inlogtoegang kunt creëren. Hier zie je een voorbeeld van een verzoek als je een werknemer wilt uitnodigen voor Plecto.