Motimate: Hoe gebruik je Motimate Public API?
Gebruik de openbare API om gebruikersintegratie en synchronisatie met uw gegevensbron te automatiseren en Motimate te verbinden met andere coole services 🔀
Openbare API v2 is nu beschikbaar voor alle klanten!
- Documentatie voor PAPI v1 (Alleen legacy - alle nieuwe klanten krijgen v2)
- Documentatie voor PAPI v2
Openbare API is een verzameling services die kunnen worden gebruikt om gegevens in Motimate bij te werken en te beheren. Het is gedocumenteerd op een standaard manier, OpenAPI genaamd, en biedt ontwikkelaars programmatische toegang tot onze software als een service. Deze API heeft een bredere ondersteuning dan wat je kunt doen met SCIM en CSV, maar je hebt een integratieservice of softwarerobot nodig om hem te gebruiken.
De lancering van PAPI v2 maakt het eenvoudiger dan ooit om gegevens te exporteren vanuit uw MotiSpace, met eindpunten zoals:
Let op:
- Je moet je API-referenties aanvragen bij Support om deze service te kunnen gebruiken.
- De API-database wordt regelmatig ververst , een paar keer per uur.
Gegevensmodellen
De openbare API biedt modellen om het aanmaken van gebruikers en Pulse-posts te automatiseren. Het heeft deze gegevensmodellen:
-
Gebruikersmodel: Je kunt dit gebruiken om informatie over gebruikersaccounts te lezen, schrijven en bij te werken. Dit kan contactgegevens, toegangsrollen en groepstoewijzingen voor motibeheer omvatten. Als een gebruiker één of meerdere posities heeft, kan dit ook worden ingesteld in dit eindpunt.
-
Groepen model: Hiermee kun je gebruikersgroepen lezen, schrijven en toewijzen. Deze groepen kunnen ook gestructureerd worden in een boomstructuur om ze aan te passen aan uw organisatie en leeropdrachten te vereenvoudigen.
Belangrijk: Het groepsniveau wordt momenteel gedefinieerd met behulp van het attribuut soort. De waarde van aard kan variëren van organisatie tot organisatie. Het kan ook gemakkelijk worden gewijzigd door de beheerder van je organisatie. Bij het instellen van API integratie is het aan te raden om een permanente lijst van soortnamen voor je groepsniveaus te definiëren om mogelijke fouten in de API integratie te voorkomen als soortnamen veranderen.
-
Positie model: Met dit model kun je posities lezen en schrijven waaraan gebruikersaccounts kunnen worden toegewezen.
-
Berichten: Hiermee kun je berichten maken en publiceren op Pulse. Dit kan worden gedaan in combinatie met de bestandsservices om afbeeldingen te uploaden.
-
Bestanden: Deze service wordt gebruikt om afbeeldingen te uploaden voor Pulse Posts. De maximale grootte voor afbeeldingen is 40 MB, voor video's 100 MB en voor documenten 100 MB.
- Inzichten: Deze service wordt gebruikt om een link naar een aangepast rapport te genereren en te verkrijgen. De rapportsjabloon moet vooraf worden aangemaakt in het Motimate platform met de functie 'Rapporten genereren' onder 'Inzichten'.
Authenticatie
OAuth Token endpoint wordt gebruikt om een toegangstoken aan te maken. Vraag je client_id en client_secret op door contact op te nemen met support@motimateapp.com.
Zodra je deze gegevens hebt ontvangen, kunnen tokens programmatisch of via platforms zoals Postman worden gegenereerd. Je hoeft alleen maar een API-aanroep te verzenden naar het POST /oauth/tokens eindpuntmet de client_id en de client_secret referenties die je hebt ontvangen van Motimate Support als JSON body.
De API zal reageren met een uniek token dat 24 uur geldig is. Je kunt zoveel tokens genereren als je nodig hebt. Het token moet worden doorgegeven aan de Authorization header als een Bearer token in uw verzoeken naar alle andere eindpunten ("Bearer"+[uw_token]).
Voorbeeld:"Drager eyJhbkyFjHk0oIY6ghkkgRI1NiJ9.eyJ0b23Lo7G5jk7mJkYzdiZD".
Je kunt het GET /me eindpunt wordt gebruikt om het toegangstoken te verifiëren. Dit is handig als je een sleutelbewaarplaats hebt om je toegangstoken in te bewaren en je wilt controleren of het werkt zonder transactionele aanroepen te doen.
Hoe de API te testen:
Om de API te testen, raden we aan een API-platform zoals Postman te gebruiken. Je kunt hier een handleiding vinden voor het importeren van de volledige Motimate API documentatie naar Postman en Insomnia Collections.
Je moet je API toegangstoken aanmaken zoals hierboven beschreven, en dit token vervolgens invoeren als een Bearer token in de Authorization tab binnen Postman. Vervolgens kun je de API testen en de reacties bekijken.
0 opmerkingen
U moet u aanmelden om een opmerking te plaatsen.