Motimate: Hur använder man Motimate Public API?
Använd det publika API:et för att automatisera användarintegration och synkronisering med din datakälla och koppla Motimate till andra coola tjänster 🔀
Public API v2 är nu tillgängligt för alla kunder!
- Dokumentation för PAPI v1 (Endast äldre version - alla nya kunder kommer att få v2)
- Dokumentation för PAPI v2
Public API är en uppsättning tjänster som kan användas för att uppdatera och hantera data i Motimate. Det är dokumenterat på ett standardiserat sätt, kallat OpenAPI, och ger utvecklare programmatisk åtkomst till vår programvara som en tjänst. Detta API har ett bredare stöd än vad du kan göra med SCIM och CSV, men du behöver en integrationstjänst eller mjukvarurobot för att använda det.
Lanseringen av PAPI v2 gör det enklare än någonsin att exportera data från ditt MotiSpace, med slutpunkter som t.ex:
- /motis/framsteg
- /motis/kompletteringar_av_kapitel
- /posts och
- /insikter/utbildningar/rapport_förfrågningar
Vänligen notera:
- Du måste begära dina API-uppgifter från supporten för att kunna börja använda den här tjänsten.
- API-databasen uppdateras med jämna mellanrum några gånger i timmen.
Datamodeller
Public API tillhandahåller modeller för att automatisera användartillgänglighet och Pulse-poster. Den har dessa datamodeller:
-
Användarmodell: Du kan använda den här för att läsa, skriva och uppdatera information om användarkonton. Detta kan inkludera kontaktinformation, åtkomstroller och grupptilldelningar för moti-hantering. Om en användare har en eller flera positioner kan detta också ställas in i denna endpoint.
-
Modell för grupper: Med den här modellen kan du läsa, skriva och tilldela användargrupper. Dessa grupper kan också struktureras i en trädstruktur för att passa din organisation och förenkla inlärningsuppgifterna.
Viktigt: Gruppnivån definieras för närvarande med hjälp av attributet kind. Värdet av " kind" kan variera från organisation till organisation. Den kan också enkelt ändras av din organisationsadministratör. När du konfigurerar API-integration är det lämpligt att definiera en permanent lista över typnamn för dina gruppnivåer för att undvika potentiella fel i API-integrationen om typnamnen ändras.
-
Positionsmodell: Med den här modellen kan du läsa och skriva positioner som användarkonton kan tilldelas.
-
Inlägg: Du kan använda den här funktionen för att skapa inlägg och publicera dem på Pulse. Detta kan göras i kombination med filtjänsterna för att ladda upp bilder.
-
Filer: Denna tjänst används för att ladda upp bilder för Pulse Posts. Storleksgränsen för bilder är 40 MB, videor är 100 MB och dokument 100 MB.
- Insikter: Denna tjänst används för att generera och få en länk till en anpassad rapport. Rapportmallen måste skapas i förväg i Motimate-plattformen med hjälp av funktionen "Generera rapporter" under "Insikter".
Autentisering
OAuth Token endpoint används för att skapa access token. Få ditt client_id och din client_secret genom att kontakta support@motimateapp.com.
När du har fått dessa uppgifter kan tokens genereras programmatiskt eller via plattformar som Postman. Allt du behöver göra är att skicka ett API-anrop till POST /oauth/tokens slutpunktmed client_id och client_secret-autentiseringsuppgifterna som du fick från Motimate Support som en JSON-kropp.
API:et kommer att svara med en unik token som är giltig i 24 timmar. Du kan generera så många tokens som du behöver. Token ska skickas till Authorization-headern som en Bearer-token i dina förfrågningar till alla andra slutpunkter ("Bearer"+[your_token]).
Exempel:"Bearer eyJhbkyFjHk0oIY6ghkkgRI1NiJ9.eyJ0b23Lo7G5jk7mJkYzdiZD"
Du kan använda GET /me slutpunkt används för att verifiera åtkomsttoken. Detta är användbart om du har en keystore för att lagra din access-token och du vill verifiera att den fungerar utan att anropa några transaktionella anrop.
Hur man testar API:et:
För att testa API:et rekommenderar vi att du använder en API-plattform som t.ex. Postman. Du kan hitta en guide om hur du importerar hela Motimate API-dokumentationen till Postman och Insomnia Collections här.
Du bör skapa din API-åtkomsttoken enligt beskrivningen ovan och sedan ange denna token som en Bearer-token i fliken Authorization i Postman. Du kan sedan gå vidare och testa API:et och granska svaren.
0 kommentarer
logga in för att lämna en kommentar.