Motimate: Come utilizzare le API pubbliche di Motimate?
Usa l'API pubblica per automatizzare l'integrazione e la sincronizzazione degli utenti con la tua fonte di dati e per collegare Motimate ad altri servizi interessanti 🔀
L'API pubblica v2 è ora disponibile per tutti i clienti!
- Documentazione per PAPI v1 (solo legacy - tutti i nuovi clienti riceveranno la v2)
- Documentazione per PAPI v2
Le API pubbliche sono un insieme di servizi che possono essere utilizzati per aggiornare e gestire i dati in Motimate. È documentato in modo standard, chiamato OpenAPI, e fornisce agli sviluppatori un accesso programmatico al nostro software come servizio. Questa API ha un supporto più ampio di quello che puoi ottenere con SCIM e CSV, ma per utilizzarla hai bisogno di un servizio di integrazione o di un robot software.
Il lancio di PAPI v2 rende più facile che mai l'esportazione dei dati dal tuo MotiSpace, con endpoint quali:
Nota bene:
- Per iniziare a utilizzare questo servizio, devi richiedere le tue credenziali API all'assistenza.
- Il database API si aggiorna a intervalli regolari , alcune volte ogni ora.
Modelli di dati
L'API pubblica fornisce modelli per automatizzare il provisioning degli utenti e i post di Pulse. Dispone di questi modelli di dati:
-
Modello utente: Puoi usarlo per leggere, scrivere e aggiornare le informazioni sugli account utente. Questo può includere informazioni di contatto, ruoli di accesso e assegnazioni di gruppi per la gestione dei moti. Se un utente ha una o più posizioni, può essere impostato anche in questo endpoint.
-
Modello Gruppi: Permette di leggere, scrivere e assegnare gruppi di utenti. Questi gruppi possono anche essere strutturati ad albero per adattarsi alla tua organizzazione e semplificare gli incarichi di apprendimento.
Importante: il livello del gruppo è attualmente definito utilizzando il tipo di attributo. Il valore della gentilezza può variare da organizzazione a organizzazione. Può anche essere modificato facilmente dall'amministratore della tua organizzazione. Quando si imposta l'integrazione API, è consigliabile definire un elenco permanente di nomi dei tipi per i livelli del gruppo, per evitare potenziali errori nell'integrazione API in caso di modifica dei nomi dei tipi.
-
Modello delle posizioni: Questo modello ti permette di leggere e scrivere le posizioni a cui possono essere assegnati gli account utente.
-
Messaggi: Puoi usare questa funzione per creare post e pubblicarli su Pulse. Questo può essere fatto in combinazione con i servizi di file per caricare le immagini.
-
File: Questo servizio serve a caricare le immagini per i post di Pulse. Il limite di dimensione per le immagini è di 40 MB, per i video di 100 MB e per i documenti di 100 MB.
- Approfondimenti: Questo servizio serve per generare e ottenere un link a un report personalizzato. Il modello di rapporto deve essere creato in anticipo nella piattaforma Motimate utilizzando la funzione "Genera rapporti" in "Approfondimenti".
Autenticazione
L'endpoint OAuth Token viene utilizzato per creare il token di accesso. Ottieni il tuo client_id e la tua client_secret contattando support@motimateapp.com.
Una volta ricevuti questi dati, i token possono essere generati in modo programmatico o tramite piattaforme come Postman. Tutto quello che devi fare è inviare una chiamata API all'endpoint POST /oauth/tokenscon il client_id e le credenziali client_secret che hai ricevuto dal supporto Motimate come corpo JSON.
L'API risponderà con un token unico, valido per 24 ore. Puoi generare tutti i gettoni di cui hai bisogno. Il token deve essere passato nell'intestazione Authorization come token Bearer nelle richieste a tutti gli altri endpoint ("Bearer "+[your_token]).
Esempio:"Portatore eyJhbkyFjHk0oIY6ghkkgRI1NiJ9.eyJ0b23Lo7G5jk7mJkYzdiZD"
Puoi utilizzare l'endpoint L'endpoint GET /me per verificare il token di accesso. Questo è utile se hai un keystore per conservare il tuo token di accesso e vuoi verificare che funzioni senza invocare alcuna chiamata transazionale.
Come testare l'API:
Per testare l'API, ti consigliamo di utilizzare una piattaforma API come Postman. Puoi trovare una guida su come importare la documentazione completa dell'API Motimate in Postman e Insomnia Collections qui.
Dovresti creare il tuo token di accesso all'API come descritto sopra e poi inserire questo token come token Bearer nella scheda Autorizzazione di Postman. A questo punto puoi testare l'API ed esaminare le risposte.
0 commenti
Accedi per aggiungere un commento.