Motimate: Hvordan bruger man Motimate Public API?
Brug den offentlige API til at automatisere brugerintegration og synkronisering med din datakilde, og forbind Motimate med andre seje tjenester 🔀.
Public API v2 er nu tilgængelig for alle kunder!
- Dokumentation til PAPI v1 (Kun for ældre kunder - alle nye kunder får v2)
- Dokumentation til PAPI v2
Public API er et sæt tjenester, der kan bruges til at opdatere og administrere data i Motimate. Det er dokumenteret på en standardiseret måde, kaldet OpenAPI, og giver udviklere programmatisk adgang til vores software som en service. Denne API har bredere understøttelse end det, du kan gøre med SCIM og CSV, men du har brug for en integrationstjeneste eller en softwarerobot for at bruge den.
Lanceringen af PAPI v2 gør det nemmere end nogensinde at eksportere data fra dit MotiSpace med slutpunkter som f.eks:
Bemærk venligst:
- Du skal anmode om dine API-legitimationsoplysninger fra support for at kunne begynde at bruge denne tjeneste.
- API-databasen opdateres med jævne mellemrum et par gange i timen.
Datamodeller
Offentlig API giver modeller til at automatisere brugertildeling og Pulse-indlæg. Den har disse datamodeller:
-
Brugermodel: Du kan bruge den til at læse, skrive og opdatere oplysninger om brugerkonti. Dette kan omfatte kontaktoplysninger, adgangsroller og gruppetildelinger til motivstyring. Hvis en bruger har en eller flere positioner, kan dette også indstilles i dette endpoint.
-
Model for grupper: Her kan man læse, skrive og tildele brugergrupper. Disse grupper kan også struktureres i en træstruktur, så de passer til din organisation og forenkler læringsopgaverne.
Vigtigt: Gruppeniveauet defineres i øjeblikket ved hjælp af attributten kind. Værdien af venlighed kan variere fra organisation til organisation. Den kan også nemt ændres af din organisations administrator. Når du opsætter API-integration, anbefales det at definere en permanent liste over artsnavne for dine gruppeniveauer for at undgå potentielle fejl i API-integrationen, hvis artsnavne ændres.
-
Model for positioner: Denne model giver dig mulighed for at læse og skrive positioner, som brugerkonti kan tildeles.
-
Indlæg: Du kan bruge denne funktion til at oprette indlæg og udgive dem på Pulse. Dette kan gøres i kombination med filtjenesterne for at uploade billeder.
-
Filer: Denne tjeneste bruges til at uploade billeder til Pulse Posts. Størrelsesgrænsen for billeder er 40 MB, videoer er 100 MB og dokumenter 100 MB.
- Indsigt: Denne tjeneste bruges til at generere og få et link til en tilpasset rapport. Rapportskabelonen skal oprettes på forhånd i Motimate-platformen ved hjælp af funktionen 'Generer rapporter' under 'Indsigt'.
Autentificering
OAuth Token endpoint bruges til at oprette adgangstoken. Få dit client_id og din client_secret ved at kontakte support@motimateapp.com.
Når du har modtaget disse oplysninger, kan tokens genereres programmatisk eller via platforme som Postman. Alt, hvad du skal gøre, er at sende et API-kald til POST /oauth/tokens slutpunktmed client_id og client_secret-legitimationsoplysningerne, som du har modtaget fra Motimate Support, som en JSON-krop.
API'en svarer med et unikt token, som er gyldigt i 24 timer. Du kan generere så mange tokens, som du har brug for. Tokenet skal sendes til Authorization-headeren som et Bearer-token i dine anmodninger til alle andre slutpunkter ("Bearer"+[your_token]).
Eksempel:"Bearer eyJhbkyFjHk0oIY6ghkkgRI1NiJ9.eyJ0b23Lo7G5jk7mJkYzdiZD"
Du kan bruge GET /me slutpunkt bruges til at verificere adgangstokenet. Det er nyttigt, hvis du har et keystore til at opbevare dit access token, og du gerne vil kontrollere, at det fungerer uden at foretage transaktionskald.
Sådan tester du API'et:
For at teste API'en anbefaler vi at bruge en API-platform som Postman. Du kan finde en guide til, hvordan du importerer den fulde Motimate API-dokumentation til Postman og Insomnia Collections her.
Du skal oprette dit API-adgangstoken som beskrevet ovenfor og derefter indtaste dette token som et bærertoken på fanen Authorization i Postman. Derefter kan du gå i gang med at teste API'en og gennemgå svarene.
0 kommentarer
Log ind for at kommentere.