Motimate: Hur använder man ett publikt API för att tillhandahålla och hantera användare och grupper?

Du kan skapa och hantera användare i Motimate genom att ansluta ditt källsystem till vårt REST API. Detta gör att du kan hantera flera centrala jobb i Motimate som att skapa användare, uppdatera användare, ta bort användare, skapa grupper och tilldela användare till rätt grupper. 

Bakgrundsinformation: 

• Alla användare och grupper har sina unika Motimate-ID:n som kan användas med API:et, men du kan också definiera ett "externt ID" som du kan använda med API:et. Detta "externa ID" ställs vanligtvis in så att det matchar det ID som du har för den användaren eller gruppen i din egen datakälla. 
   
• Grupper används för att skapa en hierarki eller ett gruppträd. Denna speglar vanligtvis din organisationsstruktur och används för att delegera utbildning och få rapporter. Detta är ofta baserat på antingen avdelningar och team eller regioner. Vi rekommenderar att du skapar grupper innan du skapar användare, så att du kan tilldela användare direkt till grupper när de skapas. Se här för mer information om gruppstruktur.
   
• Med hjälp av en användares Position kan du delegera utbildning baserat på användarens roll i organisationen. Se här för mer information om användarpositioner.
   
• Vi rekommenderar att du skapar en testmiljö för att testa dina anrop och integrationen som helhet innan du överför den till din produktionsmiljö. Vänligen kontakta din Customer Success Manager eller support@motimateapp.com för hjälp. 
   
• Motimate's API är i JSON-format. 

Skapa grupper

För att skapa grupper använder du följande anrop:
POST https://motimateapp.com/public_api/groups

Lägg till nyttolasten i kroppen med nödvändig information med gruppen. Fältet "parent_id" används för att skapa en gruppstruktur. Om du anger ID för en annan grupp i det här fältet kommer den gruppen att anges som överordnad.

Observera: Gruppens nivå måste ligga i en lägre hierarki än föräldragruppen, där "Nivå 1" är den högsta nivån. Detta gör att du kan importera gruppstrukturer till ditt Motimate-konto. 

Uppdatering av grupper 

För att kunna uppdatera en grupp i Motimate behöver du följande anrop. Det id som används i det här exemplet är Motimate-gruppens id. 

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

Lägg till nyttolast till kroppen med de nödvändiga data som du vill uppdatera på grupperna. Detta kan användas när en grupp behöver flyttas till en annan nivå eller om strukturen behöver justeras. 

 

Radering av grupper

För att kunna ta bort en grupp i Motimate behöver du följande samtal. Det id som används i det här exemplet är Motimate-gruppens id. Om du ställer in force till ´1´ kommer skivan att förstöras, det finns inget sätt att återställa gruppen i det här scenariot.

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

Om du kör det här anropet raderas den valda gruppen, även om inget svar returneras:

 

Skapa användare

Använd följande anrop för att skapa användare: 

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

Lägg till nyttolasten i kroppen med nödvändig information om användaren. Antingen e-postadressen eller telefonnumret kommer att vara ett obligatoriskt fält beroende på dina Motimate-kontoinställningar. Du kan välja användarens grupper genom att använda fältet Group Assignments. Ange det grupp-ID som du vill att användaren ska vara en del av och deras roll i gruppen (medlem, administratör eller observatör). Vi rekommenderar att assing_ancestors sätts till "true" i de allra flesta scenarier. Detta säkerställer att användarna blir medlemmar i föräldragrupperna till de grupper de tilldelats. 

 

Uppdatering av användare

För att kunna uppdatera en användares information i Motimate behöver du följande anrop. Det id som används i det här exemplet är Motimate-användar-id. 

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

Lägg till payload i body med de enda nödvändiga data som du vill uppdatera för användaren.

 

Radering av användare

För att kunna ta bort en användare i Motimate behöver du följande anrop. Det id som används i det här exemplet är Motimate-användar-id. Om du ställer in force till ´1´ kommer skivan att förstöras, det finns inget sätt att återställa gruppen i det här scenariot. Om du ställer in den på ´0´ raderas posten mjukt, vilket gör att den kan återställas vid behov. 

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

Om du kör det här anropet raderas den valda användaren, även om inget svar returneras: 

Återställa användare

Ibland raderas en användare av misstag och behöver återställas. Om de har mjukraderats, men inte hårdförstörts, kan detta göras med följande anrop. Det id som används i det här exemplet är Motimate-användar-id. 

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