Motimate: Come utilizzare le API pubbliche per fornire e gestire utenti e gruppi?

Puoi fornire e gestire gli utenti in Motimate collegando il tuo sistema sorgente alla nostra API REST. Questo ti permette di gestire diverse operazioni fondamentali in Motimate come la creazione di utenti, l'aggiornamento di utenti, l'eliminazione di utenti, la creazione di gruppi e il provisioning di utenti ai gruppi corretti. 

Informazioni di base: 

• Tutti gli utenti e i gruppi hanno un ID Motimate unico che può essere utilizzato con l'API, ma puoi anche definire un "ID esterno" che puoi utilizzare con l'API. Questo "ID esterno" è in genere impostato in modo da corrispondere all'ID che hai per quell'utente o gruppo nella tua fonte di dati. 
   
• I gruppi sono utilizzati per creare una gerarchia o un albero di gruppi. Di solito rispecchia fedelmente la struttura della tua organizzazione e viene utilizzato per delegare la formazione e ottenere rapporti. Spesso si basa su dipartimenti e team o su regioni. Ti consigliamo di creare i gruppi prima di creare gli utenti, in modo da poter assegnare gli utenti direttamente ai gruppi al momento della creazione. Per maggiori informazioni sulla struttura del gruppo, vedi qui.
   
• La Posizione di un utente ti permette di delegare la formazione in base al suo ruolo nell'organizzazione. Per maggiori informazioni sulle posizioni degli utenti, vedi qui.
   
• Ti consigliamo di creare un ambiente di prova per testare le chiamate e l'integrazione nel suo complesso, prima di trasferirle nell'ambiente di produzione. Contatta il tuo Customer Success Manager o support@motimateapp.com per ricevere assistenza. 
   
• L'API di Motimate è in formato JSON. 

Creare gruppi

Per creare i gruppi usa la seguente chiamata:
POST https://motimateapp.com/public_api/groups

Aggiungi il payload al corpo con le informazioni necessarie e il gruppo. Il campo "parent_id" viene utilizzato per creare una struttura di gruppo. Inserendo l'ID di un altro gruppo in questo campo, quel gruppo verrà impostato come genitore.

Nota bene: il livello del gruppo deve essere inferiore alla gerarchia del gruppo padre, con "Livello 1" come livello più alto. Questo ti permette di importare le strutture dei gruppi nel tuo account Motimate. 

Aggiornamento dei gruppi 

Per aggiornare un gruppo in Motimate è necessaria la seguente chiamata. L'id utilizzato in questo esempio è l'id del gruppo Motimate. 

PATCH https://motimateapp.com/public_api/groups/{group_id}

Aggiungi il payload al corpo con i dati necessari che desideri aggiornare sui gruppi. Questo può essere utilizzato quando un Gruppo deve essere spostato a un livello diverso o se la struttura deve essere modificata. 

 

Eliminazione dei gruppi

Per eliminare un gruppo in Motimate è necessaria la seguente chiamata. L'id utilizzato in questo esempio è l'id del gruppo Motimate. Impostando la forza a ´1´ il record verrà distrutto, non c'è modo di recuperare il gruppo in questo scenario.

CANCELLARE https://motimateapp.com/public_api/groups/{group_id}

L'esecuzione di questa chiamata cancella il gruppo selezionato, anche se non viene restituita una risposta:

 

Creazione di utenti

Per creare degli utenti, usa la seguente chiamata: 

POSTA https://motimateapp.com/public_api/users

Aggiungi il payload al corpo con le informazioni necessarie dell'utente. L'indirizzo e-mail o il numero di telefono saranno campi obbligatori a seconda delle impostazioni del tuo account Motimate. Puoi selezionare i gruppi dell'utente utilizzando il campo Assegnazioni di gruppo. Inserisci l'id del gruppo di cui vuoi che l'utente faccia parte e il suo ruolo nel gruppo (membro, amministratore o osservatore). Si consiglia di impostare assing_ancestors su 'true' nella maggior parte degli scenari. Questo assicura che gli utenti siano membri dei gruppi padre dei gruppi loro assegnati. 

 

Aggiornamento degli utenti

Per aggiornare le informazioni di un utente in Motimate è necessaria la seguente chiamata. L'id utilizzato in questo esempio è l'id utente di Motimate. 

PATCH https://motimateapp.com/public_api/users/{user_id}?identifier_type=id

Aggiungi il payload al corpo con i soli dati necessari che desideri aggiornare per l'utente.

 

Eliminazione degli utenti

Per eliminare un utente in Motimate è necessaria la seguente chiamata. L'id utilizzato in questo esempio è l'id utente di Motimate. Impostando la forza a ´1´ il record verrà distrutto, non c'è modo di recuperare il gruppo in questo scenario. Impostando il valore ´0´, il record verrà eliminato in modo soft, consentendo di recuperarlo se necessario. 

CANCELLARE https://motimateapp.com/public_api/users/{user_id}?force=1&identifier_type=id

L'esecuzione di questa chiamata eliminerà l'utente selezionato, anche se non verrà restituita una risposta: 

Ripristino degli utenti

A volte un utente viene cancellato per errore e deve essere ripristinato. Se sono stati cancellati in modo soft e non distrutti in modo hard, è possibile farlo con la seguente chiamata. L'id utilizzato in questo esempio è l'id utente di Motimate. 

PATCH https://motimateapp.com/public_api/users/{user_id}/restore?identifier_type=id