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!
- Dokumentasjon for PAPI v1 (Kun for eksisterende brukere - alle nye kunder vil få v2)
- Dokumentasjon for PAPI v2
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'.
Autentisering
OAuth Token-endepunktet brukes til å opprette tilgangstoken. Få din client_id og client_secret ved å kontakte support@motimateapp.com.
Når du har mottatt disse detaljene, kan tokens genereres programmatisk eller via plattformer som Postman. Alt du trenger å gjøre er å sende et API-kall til POST /oauth/tokens-endepunktet, med client_id og client_secret legitimasjonen som du mottok fra Motimate Support som en JSON-body.
API-et vil svare med et unikt token, som vil være gyldig i 24 timer. Du kan generere så mange tokens du trenger. Tokenet skal sendes til Authorization-headeren som et Bearer-token i dine forespørsler til alle andre endepunkter ("Bearer " + [ditt_token]).
Eksempel:
“Bearer eyJhbkyFjHk0oIY6ghkkgRI1NiJ9.eyJ0b23Lo7G5jk7mJkYzdiZD”
Du kan bruke GET /me-endepunktet til å verifisere tilgangstokenet. Dette er nyttig hvis du har en keystore for å beholde tilgangstokenet ditt og du ønsker å verifisere at det fungerer uten å påkalle noen transaksjonelle kall.
Slik tester du API-et:
For å teste API-et, anbefaler vi å bruke en API-plattform som Postman. Du kan finne en guide til hvordan du importerer full Motimate API-dokumentasjon til Postman collections her.
Du bør opprette tilgangstokenet ditt som beskrevet ovenfor, og deretter legge inn dette tokenet som et Bearer-token i Authorization-fanen i Postman. Du kan deretter fortsette og teste API-et og gjennomgå svarene.