Motimate: Hvordan bruke Motimate Public API?
Bruk det offentlige API-et til å automatisere brukerintegrering og synkronisering med datakilden din, og koble Motimate til andre kule tjenester 🔀.
Public API v2 er nå tilgjengelig for alle kunder!
- Dokumentasjon for PAPI v1 (Kun for eldre kunder - 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. Den er dokumentert på en standardisert måte, kalt OpenAPI, og gir utviklere programmatisk tilgang til programvaren vår som en tjeneste. Dette API-et har bredere støtte enn det du kan gjøre med SCIM og CSV, men du trenger en integrasjonstjeneste eller programvarerobot for å bruke det.
Lanseringen av PAPI v2 gjør det enklere enn noensinne å eksportere data fra MotiSpace, med endepunkter som f.eks:
Vær oppmerksom på dette:
- Du må be om API-legitimasjon fra kundestøtte for å kunne begynne å bruke denne tjenesten.
- API-databasen oppdateres med jevne mellomrom noen ganger i timen.
Datamodeller
Public API tilbyr modeller for å automatisere brukerklargjøring og Pulse-innlegg. Den har disse datamodellene:
-
Brukermodell: Du kan bruke denne til å lese, skrive og oppdatere informasjon om brukerkontoer. Dette kan omfatte kontaktinformasjon, tilgangsroller og gruppetildelinger for motivadministrasjon. Hvis en bruker har én eller flere stillinger, kan dette også angis i dette endepunktet.
-
Gruppemodell: Her kan du lese, skrive og tildele brukergrupper. Disse gruppene kan også struktureres i en trestruktur for å matche organisasjonen din og forenkle læringsoppgavene.
Viktig: Gruppenivået defineres for øyeblikket ved hjelp av attributtet kind. Verdien av " kind " kan variere fra organisasjon til organisasjon. Den kan også enkelt endres av organisasjonens administrator. Når du setter opp API-integrasjon, er det lurt å definere en permanent liste med artsnavn for gruppenivåene dine for å unngå potensielle feil i API-integrasjonen hvis artsnavnene endres.
-
Modell for posisjoner: Med denne modellen kan du lese og skrive posisjoner som brukerkontoer kan tilordnes til.
-
Innlegg: Her kan du opprette innlegg og publisere dem på Pulse. Dette kan gjøres i kombinasjon med filtjenester for opplasting av bilder.
-
Filer: Denne tjenesten brukes til å laste opp bilder til Pulse Posts. Størrelsesgrensen for bilder er 40 MB, videoer er 100 MB og dokumenter 100 MB.
- Innsikt: Denne tjenesten brukes til å generere og få en kobling til en tilpasset rapport. Rapportmalen må opprettes på forhånd i Motimate-plattformen ved hjelp av "Generer rapporter"-funksjonen 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 opplysningene, kan tokens genereres programmatisk eller via plattformer som Postman. Alt du trenger å gjøre er å sende et API-anrop til POST /oauth/tokens endepunktmed client_id og client_secret-legitimasjonen som du har mottatt fra Motimate Support som en JSON-kropp.
API-et vil svare med et unikt token, som er gyldig i 24 timer. Du kan generere så mange tokens du trenger. Tokenet skal sendes til Authorization-headeren som et Bearer-token i forespørsler til alle andre endepunkter ("Bearer"+[your_token]).
Eksempel:"Bærer eyJhbkyFjHk0oIY6ghkkgRI1NiJ9.eyJ0b23Lo7G5jk7mJkYzdiZD"
Du kan bruke GET /me endepunkt brukes til å verifisere tilgangstokenet. Dette er nyttig hvis du har et keystore for å oppbevare tilgangstokenet ditt, og du ønsker å verifisere at det fungerer uten å påkalle noen transaksjonskall.
Slik tester du API-et:
For å teste API-et anbefaler vi at du bruker en API-plattform som Postman. Du finner en guide til hvordan du importerer hele Motimate API-dokumentasjonen til Postman og Insomnia Collections her.
Du bør opprette API-tilgangstokenet ditt som beskrevet ovenfor, og deretter angi dette tokenet som et bærertoken i Authorization-fanen i Postman. Deretter kan du teste API-et og gå gjennom svarene.
0 kommentarer
Logg på hvis du vil legge inn en kommentar.