Motimate: Hoe openbare API gebruiken om gebruikers en groepen aan te maken en te beheren?

Je kunt gebruikers aanmaken en beheren in Motimate door je bronsysteem te verbinden met onze REST API. Hiermee kun je verschillende kerntaken in Motimate uitvoeren, zoals het aanmaken van gebruikers, het bijwerken van gebruikers, het verwijderen van gebruikers, het aanmaken van groepen en het toewijzen van gebruikers aan de juiste groepen. 

Achtergrondinformatie: 

• Alle gebruikers en groepen hebben hun unieke Motimate ID's die gebruikt kunnen worden met de API, maar je kunt ook een 'externe ID' definiëren die je kunt gebruiken met de API. Deze 'externe ID' wordt meestal ingesteld om overeen te komen met de ID die u hebt voor die gebruiker of groep in uw eigen gegevensbron. 
   
• Groepen worden gebruikt om een hiërarchie of boomstructuur van groepen te maken. Dit komt meestal overeen met uw organisatiestructuur en wordt gebruikt om training te delegeren en rapporten te verkrijgen. Dit is vaak gebaseerd op afdelingen en teams, of op regio's. We raden aan om groepen aan te maken voordat je gebruikers aanmaakt, zodat je gebruikers direct aan groepen kunt toewijzen bij het aanmaken. Kijk hier voor meer informatie over de groepsstructuur.
   
• Met de Positie van een gebruiker kun je training delegeren op basis van hun rol in de organisatie. Kijk hier voor meer informatie over gebruikersposities.
   
• We raden aan om een testomgeving op te zetten om je gesprekken en integratie als geheel te testen, voordat je deze overzet naar je productieomgeving. Neem contact op met uw Customer Success Manager of support@motimateapp.com voor hulp. 
   
• De API van Motimate is in JSON-indeling. 

Groepen maken

Gebruik de volgende aanroep om groepen te maken:
POST https://motimateapp.com/public_api/groups

Voeg de payload toe aan de body met de nodige informatie over de groep. Het veld "parent_id" wordt gebruikt om een groepsstructuur te maken. Als je de ID van een andere groep in dit veld invoert, wordt die groep de bovenliggende groep.

Let op: het niveau van de groep moet in een lagere hiërarchie liggen dan de bovenliggende groep, waarbij "Niveau 1" het hoogste niveau is. Hiermee kun je groepsstructuren importeren in je Motimate-account. 

Groepen bijwerken 

Om een groep bij te werken in Motimate heb je de volgende oproep nodig. De id die in dit voorbeeld wordt gebruikt, is de id van de Motimate-groep. 

PATCH https://motimateapp.com/public_api/groups/{group_id}

Voeg payload toe aan de body met de benodigde gegevens die je wilt bijwerken op de groepen. Dit kan worden gebruikt als een groep naar een ander niveau moet worden verplaatst of als de structuur moet worden aangepast. 

 

Groepen verwijderen

Om een groep te verwijderen in Motimate heb je het volgende gesprek nodig. De id die in dit voorbeeld wordt gebruikt, is de id van de Motimate-groep. Door kracht op ´1´ te zetten wordt de record hard vernietigd, er is geen manier om de groep in dit scenario te herstellen.

VERWIJDER https://motimateapp.com/public_api/groups/{group_id}

Door deze oproep uit te voeren wordt de geselecteerde groep verwijderd, hoewel er geen antwoord wordt teruggestuurd:

 

Gebruikers aanmaken

Gebruik de volgende aanroep om gebruikers aan te maken: 

POST https://motimateapp.com/public_api/users

Voeg de payload toe aan de body met de benodigde informatie van de gebruiker. Het e-mailadres of telefoonnummer is een verplicht veld, afhankelijk van de instellingen van je Motimate account. Je kunt de groepen van de gebruiker selecteren via het veld Groepstoewijzingen. Voer het groepnummer in waarvan je wilt dat de gebruiker er deel van uitmaakt en hun rol in de groep (lid, beheerder of waarnemer). We raden aan om assing_ancestors op 'true' te zetten in de meeste scenario's. Dit zorgt ervoor dat gebruikers lid worden van de bovenliggende groepen van de aan hen toegewezen groepen. 

 

Gebruikers bijwerken

Om de informatie van een gebruiker in Motimate bij te werken, heb je de volgende oproep nodig. De id die in dit voorbeeld wordt gebruikt is de gebruikers-id van Motimate. 

PATCH https://motimateapp.com/public_api/users/{user_id}?identifier_type=id

Voeg payload toe aan de body met de enige noodzakelijke gegevens die je wilt bijwerken voor de gebruiker.

 

Gebruikers verwijderen

Om een gebruiker te verwijderen in Motimate heb je het volgende gesprek nodig. De id die in dit voorbeeld wordt gebruikt is de gebruikers-id van Motimate. Door kracht op ´1´ te zetten wordt de record hard vernietigd, er is geen manier om de groep in dit scenario te herstellen. Door het op ´0´ te zetten wordt de record zacht gewist, zodat deze indien nodig hersteld kan worden. 

DELETE https://motimateapp.com/public_api/users/{user_id}?force=1&identifier_type=id

Door deze aanroep uit te voeren, wordt de geselecteerde gebruiker verwijderd, hoewel er geen antwoord wordt teruggestuurd: 

Gebruikers herstellen

Soms wordt een gebruiker per ongeluk verwijderd en moet hij hersteld worden. Als ze zacht verwijderd zijn en niet hard vernietigd, kan dit gedaan worden met de volgende aanroep. De id die in dit voorbeeld wordt gebruikt is de gebruikers-id van Motimate. 

PATCH https://motimateapp.com/public_api/users/{user_id}/restore?identifier_type=id