Du kan opprette og administrere brukere i Motimate ved å koble kildesystemet ditt til vår REST API. Dette lar deg håndtere flere sentrale oppgaver i Motimate, som å opprette brukere, oppdatere brukere, slette brukere, opprette grupper og tilordne brukere til riktige grupper.
API-dokumentasjon:https://motimate.motimateapp.com/public_api/docs
API-tilgang: For å be om autorisasjonsopplysninger for din MotiSpace, ta kontakt med din Customer Success Manager eller support@motimateapp.com
Forstå API-et
- En ansatt i Motimate refereres til som en bruker. Både brukere og grupper vil ha sin egen eksterne ID, som du kan bruke til å oppdatere eller gjøre endringer. Denne ID-en samsvares vanligvis med ID-en du har for den brukeren eller gruppen i datakilden din.
- Grupper brukes til å opprette en organisasjonsstruktur der du kan delegere opplæring og få rapporter. Dette er ofte basert på avdelinger og team, eller regioner. Vi anbefaler å opprette grupper før du oppretter brukere, slik at du kan tilordne brukere direkte til grupper ved opprettelsen.
- Brukerens stilling lar deg delegere opplæring basert på deres rolle i organisasjonen. Dette brukes vanligvis når det er stillinger som brukes gjennom hele organisasjonen. Denne artikkelen beskriver ikke hvordan du oppretter stillinger.
- Du kan se alle tilgjengelige API-kall i dokumentasjonen vår. For å teste kall i brukergrensesnittet må du ha en tilgangsnøkkel. Dette gjøres ved å angi din klient-ID og passord i POST/oauth/token-kallet.
- Vi anbefaler å sette opp et testmiljø for å teste kallene og integrasjonen som helhet før du går over til produksjonsmiljøet ditt. Ta kontakt med din Customer Success Manager eller support@motimateapp.comfor hjelp.
- Motimates API bruker JSON-format.
- Alle felt i Motimate er som standard satt og kan ikke tilpasses. Dette inkluderer felt som "first_name", "last_name" og "email".
Opprette grupper
For å opprette grupper bruk følgende kall:
POST: https://motimateapp.com/public_api/groups
Legg til data i kroppen med den nødvendige informasjonen om gruppen. Feltet "parent_id" brukes til å opprette en gruppestruktur. Ved å angi ID-en til en annen gruppe i dette feltet vil den angitte gruppen bli foreldren til den nye gruppen. Merk at nivået til gruppen må være i en lavere hierarki enn foreldregruppen, der "Nivå 1" er det høyeste nivået. Dette lar deg importere gruppestrukturer til Motimate-kontoen din.
Oppdatering av grupper
For å oppdatere en gruppe i Motimate, bruk følgende kall. ID-en som brukes i dette eksempelet er Motimate-gruppe-ID-en.
PATCH: https://motimateapp.com/public_api/groups/{group_id}?identifier_type=id
Legg til data i kroppen med de nødvendige oppdateringene som skal gjøres på gruppene.
Sletting av grupper
For å slette en gruppe i Motimate, bruk følgende kall. ID-en som brukes i dette eksempelet er Motimate-gruppe-ID-en. Hvis du angir force til ´1´, blir oppføringen permanent slettet uten mulighet for gjenoppretting.
DELETE: https://motimateapp.com/public_api/groups/{group_id}?force=1&identifier_type=id
Opprettelse av brukere
For å opprette brukere, bruk følgende kall:
POST: https://motimateapp.com/public_api/users
Legg til data i kroppen med den nødvendige informasjonen om brukeren. Enten e-postadressen eller telefonnummeret vil være et obligatorisk felt avhengig av dine Motimate-kontoinnstillinger. Du kan velge brukerens grupper ved å bruke feltet for gruppetilknytninger. Angi ID-en til gruppen som du ønsker at brukeren skal være en del av, og deres rolle i gruppen (medlem, administrator eller observatør). Vi anbefaler å sette assing_ancestors til 'true' i de fleste tilfeller. Dette sikrer at brukere også blir medlemmer av foreldregruppene til deres tilordnede grupper.
Oppdatering av brukere
For å oppdatere informasjonen til en bruker i Motimate, bruk 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 data i kroppen med den nødvendige informasjonen du ønsker å oppdatere for brukeren.
Sletting av brukere
For å slette en bruker i Motimate, bruk følgende kall. ID-en som brukes i dette eksempelet er Motimate-bruker-ID-en. Hvis du angir force til ´1´, blir oppføringen permanent slettet uten mulighet for gjenoppretting. Hvis du angir force til ´0´, blir oppføringen mykt slettet og kan gjenopprettes om nødvendig.
DELETE: https://motimateapp.com/public_api/users/{user_id}?force=1&identifier_type=id
Gjenoppretting av brukere
Tidvis blir en bruker slettet ved et uhell og trenger å gjenopprettes. Hvis de har blitt mykt slettet, og ikke hardt ødelagt, kan du gjøre dette 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