Motimate: Hvordan bruger man et offentligt API til at oprette og administrere brugere og grupper?

Du kan oprette og administrere brugere i Motimate ved at forbinde dit kildesystem til vores REST API. Det giver dig mulighed for at håndtere flere kerneopgaver i Motimate som at oprette brugere, opdatere brugere, slette brugere, oprette grupper og tildele brugere til de rigtige grupper. 

Baggrundsinformation: 

• Alle brugere og grupper har deres egne unikke Motimate-id'er, som kan bruges sammen med API'en, men du kan også definere et "eksternt id", som du kan bruge sammen med API'en. Dette "eksterne ID" er typisk indstillet til at matche det ID, du har for den pågældende bruger eller gruppe i din egen datakilde. 
   
• Grupper bruges til at skabe et hierarki eller et gruppetræ. Den vil normalt afspejle din organisationsstruktur og bruges til at uddelegere træning og indhente rapporter. Dette er ofte baseret på enten afdelinger og teams eller regioner. Vi anbefaler at oprette grupper, før du opretter brugere, så du kan tildele brugere direkte til grupper, når de oprettes. Se her for mere information om gruppestruktur.
   
• En brugers Position giver dig mulighed for at uddelegere træning baseret på deres rolle i organisationen. Se her for mere information om brugerpositioner.
   
• Vi anbefaler, at du opretter et testmiljø for at teste dine kald og integrationen som helhed, før du overfører til dit produktionsmiljø. Kontakt din Customer Success Manager eller support@motimateapp.com for at få hjælp. 
   
• Motimates API er i JSON-format. 

Oprettelse af grupper

For at oprette grupper skal du bruge følgende kald:
POST https://motimateapp.com/public_api/groups

Føj nyttelasten til kroppen med de nødvendige oplysninger om gruppen. Feltet "parent_id" bruges til at oprette en gruppestruktur. Hvis du indtaster ID'et for en anden gruppe i dette felt, bliver den gruppe sat som overordnet.

Bemærk: Gruppens niveau skal være i et lavere hierarki end forældregruppen, hvor "Niveau 1" er det højeste niveau. Det giver dig mulighed for at importere gruppestrukturer til din Motimate-konto. 

Opdatering af grupper 

For at opdatere en gruppe i Motimate skal du bruge følgende kald. Det id, der bruges i dette eksempel, er Motimate-gruppens id. 

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

Tilføj payload til body'en med de nødvendige data, du vil opdatere i grupperne. Det kan bruges, når en gruppe skal flyttes til et andet niveau, eller hvis strukturen skal justeres. 

 

Sletning af grupper

For at slette en gruppe i Motimate skal du bruge følgende kald. Det id, der bruges i dette eksempel, er Motimate-gruppens id. Hvis du sætter force til ´1´, ødelægges pladen hårdt, og det er ikke muligt at gendanne gruppen i dette scenarie.

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

Når man kører dette kald, slettes den valgte gruppe, selvom der ikke returneres et svar:

 

Oprettelse af brugere

For at oprette brugere skal du bruge følgende kald: 

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

Føj nyttelasten til kroppen med de nødvendige oplysninger om brugeren. Enten e-mailadressen eller telefonnummeret vil være et obligatorisk felt afhængigt af dine Motimate-kontoindstillinger. Du kan vælge brugerens grupper ved at bruge feltet Gruppetildelinger. Indtast det gruppe-id, som du ønsker, at brugeren skal være en del af, og deres rolle i gruppen (medlem, administrator eller observatør). Vi anbefaler at sætte assing_ancestors til 'true' i langt de fleste scenarier. Dette sikrer, at brugerne bliver medlemmer af de overordnede grupper for deres tildelte grupper. 

 

Opdatering af brugere

For at opdatere en brugers oplysninger i Motimate skal du bruge følgende kald. Det id, der bruges i dette eksempel, er Motimate-bruger-id'et. 

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

Tilføj payload til kroppen med de eneste nødvendige data, du ønsker at opdatere for brugeren.

 

Sletning af brugere

For at slette en bruger i Motimate skal du bruge følgende kald. Det id, der bruges i dette eksempel, er Motimate-bruger-id'et. Hvis du sætter force til ´1´, ødelægges pladen hårdt, og det er ikke muligt at gendanne gruppen i dette scenarie. Hvis du sætter den til "0", slettes posten blødt, så den kan gendannes, hvis det bliver nødvendigt. 

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

Når man kører dette kald, slettes den valgte bruger, selvom der ikke returneres et svar: 

Gendannelse af brugere

Nogle gange bliver en bruger slettet ved en fejl og skal gendannes. Hvis de er blevet soft deleted og ikke hard destroyed, kan det gøres med følgende kald. Det id, der bruges i dette eksempel, er Motimate-bruger-id'et. 

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