Bruk Public API for å automatisere brukerintegrasjon og synkronisering med din datakilde, og koble Motimate til andre kule tjenester.
Public API v2 er nå tilgjengelig for alle kunder!
Public API er et sett med tjenester som kan brukes til å oppdatere og administrere data i Motimate. Det er dokumentert på en standard måte, kalt OpenAPI, og gir utviklere programmatisk tilgang til vår programvare som en tjeneste. Denne API-en har bredere støtte enn det du kan gjøre med SCIM og CSV, men du trenger en integrasjonstjeneste eller programvarerobot for å bruke den.
Lanseringen av PAPI v2 gjør det enklere enn noen gang å eksportere data fra din MotiSpace, med endepunkter som:
Vennligst merk:
API-databasen oppdateres med jevne mellomrom noen ganger hver time.
Datamodeller
Public API tilbyr modeller for å automatisere brukerprovisjonering og Pulse-innlegg. Den har disse datamodellene:
- Brukermodell: Du kan bruke denne til å lese, skrive og oppdatere informasjon om brukerkontoer. Dette kan inkludere kontaktinformasjon, tilgangsroller og gruppeoppgaver for moti-administrasjon. Hvis en bruker har en eller flere stillinger, kan dette også settes i dette endepunktet.
- Gruppermodell: Dette lar deg lese, skrive og tildele brukergrupper. Disse gruppene kan også struktureres i en trestruktur for å matche din organisasjon og forenkle læringsoppgaver.
Viktig:
Gruppnivået er for tiden definert ved hjelp av attributtet "kind". Verdien av "kind" kan variere fra organisasjon til organisasjon. Det kan også enkelt endres av din organisasjonsadministrator. Når du setter opp API-integrasjon, er det tilrådelig å definere en permanent liste over "kind"-navn for dine gruppenivåer for å unngå potensielle feil i API-integrasjonen hvis "kind"-navn endres.
-
Posisjonsmodell: Denne modellen lar deg lese og skrive posisjoner som brukerkontoer kan tildeles.
-
Innlegg: Du kan bruke dette til å opprette innlegg og publisere dem på Pulse. Dette kan gjøres i kombinasjon med filtjenestene for å laste opp bilder.
-
Filer: Denne tjenesten brukes til å laste opp bilder for Pulse-innlegg. Størrelsesgrensen for bilder er 40 MB, videoer er 100 MB, og dokumenter er 100 MB.
- Innsikt: Denne tjenesten brukes til å generere og få en lenke til en tilpasset rapport. Rapportmalen må opprettes på forhånd i Motimate-plattformen ved å bruke funksjonen 'Generer rapporter' under 'Innsikt'.
Det er også to støttetjenester du trenger for å bruke datamodellene ovenfor:
-
OAuth Token-endepunktet brukes til å opprette tilgangstoken. Få din klient-ID og klienthemmelighet ved å kontakte support@motimateapp.com
- Me-endepunktet brukes til å verifisere tilgangstokenet. Dette er nyttig hvis du har en nøkkellager for å oppbevare tilgangstokenet ditt og du ønsker å verifisere at det fungerer uten å utføre noen transaksjonelle kall.
Hvordan teste API-en:
For å teste API-en, anbefaler vi å bruke en API-plattform som Postman.
Du bør opprette ditt API-tilgangstoken som beskrevet ovenfor, og deretter angi dette tokenet som et Bearer-token i Autorisasjons-fanen i Postman. Du kan deretter teste API endepunktene og gjennomgå responsen.