Motimate: Hvordan bruke offentlige API-er til å klargjøre og administrere brukere og grupper?

Du kan klargjøre og administrere brukere i Motimate ved å koble kildesystemet ditt til vårt REST API. Dette gjør det mulig å håndtere flere kjerneoppgaver i Motimate, for eksempel å opprette brukere, oppdatere brukere, slette brukere, opprette grupper og tilordne brukere til de riktige gruppene. 

Bakgrunnsinformasjon: 

• Alle brukere og grupper har sine egne unike Motimate-ID-er som kan brukes med API-et, men du kan også definere en "ekstern ID" som du kan bruke med API-et. Denne "eksterne ID-en" er vanligvis satt til å samsvare med ID-en du har for den aktuelle brukeren eller gruppen i din egen datakilde. 
   
• Grupper brukes til å opprette et hierarki eller et gruppetre. Denne vil vanligvis gjenspeile organisasjonsstrukturen din, og brukes til å delegere opplæring og innhente rapporter. Dette er ofte basert på enten avdelinger og team eller regioner. Vi anbefaler at du oppretter grupper før du oppretter brukere, slik at du kan tilordne brukere direkte til grupper når de opprettes. Se her for mer informasjon om konsernstruktur.
   
• Med en brukers Position kan du delegere opplæring basert på brukerens rolle i organisasjonen. Se her for mer informasjon om brukerposisjoner.
   
• Vi anbefaler at du setter opp et testmiljø for å teste anropene og integrasjonen som helhet, før du overfører dem til produksjonsmiljøet. Ta kontakt med Customer Success Manager eller support@motimateapp.com for å få hjelp. 
   
• Motimates API er i JSON-format. 

Opprette grupper

Bruk følgende kall for å opprette grupper:
POST https://motimateapp.com/public_api/groups

Legg til nyttelasten i brødteksten med den nødvendige informasjonen med gruppen. Feltet "parent_id" brukes til å opprette en gruppestruktur. Hvis du skriver inn ID-en til en annen gruppe i dette feltet, blir denne gruppen angitt som overordnet gruppe.

Merk: Gruppens nivå må være i et lavere hierarki enn den overordnede gruppen, der "Nivå 1" er det høyeste nivået. Dette gjør at du kan importere gruppestrukturer til Motimate-kontoen din. 

Oppdatering av grupper 

For å oppdatere en gruppe i Motimate trenger du følgende kall. ID-en som brukes i dette eksempelet, er Motimate-gruppens ID. 

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

Legg til nyttelast i brødteksten med de nødvendige dataene du ønsker å oppdatere i gruppene. Dette kan brukes når en gruppe må flyttes til et annet nivå, eller hvis strukturen må justeres. 

 

Slette grupper

For å slette en gruppe i Motimate trenger du følgende anrop. ID-en som brukes i dette eksempelet, er Motimate-gruppens ID. Hvis du setter force til ´1´, ødelegges posten, og det er ingen måte å gjenopprette gruppen på i dette scenariet.

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

Når du kjører dette kallet, slettes den valgte gruppen, selv om det ikke returneres noe svar:

 

Opprette brukere

For å opprette brukere bruker du følgende kall: 

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

Legg til nyttelasten i brødteksten med nødvendig informasjon om brukeren. Enten e-postadressen eller telefonnummeret vil være et obligatorisk felt, avhengig av innstillingene for Motimate-kontoen din. Du kan velge brukerens grupper ved hjelp av feltet for gruppetilordninger. Angi gruppe-ID-en du vil at brukeren skal være en del av, og hvilken rolle vedkommende skal ha i gruppen (medlem, administrator eller observatør). Vi anbefaler at assing_ancestors settes til "true" i de aller fleste scenarier. Dette sikrer at brukerne blir medlemmer av foreldregruppene til gruppene de er tildelt. 

 

Oppdatering av brukere

For å oppdatere en brukers informasjon i Motimate trenger du følgende kall. ID-en som brukes i dette eksempelet, er Motimate-bruker-ID-en. 

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

Legg til nyttelast i brødteksten med de eneste nødvendige dataene du ønsker å oppdatere for brukeren.

 

Slette brukere

For å slette en bruker i Motimate trenger du følgende kall. ID-en som brukes i dette eksempelet, er Motimate-bruker-ID-en. Hvis du setter force til ´1´, ødelegges posten, og det er ingen måte å gjenopprette gruppen på i dette scenariet. Hvis du setter den til "0", slettes posten mykt, slik at den kan gjenopprettes om nødvendig. 

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

Hvis du kjører dette kallet, slettes den valgte brukeren, selv om det ikke returneres noe svar: 

Gjenopprette brukere

Noen ganger slettes en bruker ved en feiltakelse og må gjenopprettes. Hvis de har blitt slettet mykt, og ikke ødelagt hardt, kan dette gjøres med følgende kall. ID-en som brukes i dette eksempelet, er Motimate-bruker-ID-en. 

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