Avviso di traduzione IA
Questa documentazione è stata tradotta automaticamente dall'IA.
Sincronizzare i Dati Utente tramite API HTTP
Ottenere una Chiave API
Faccia riferimento a Chiavi API. Si assicuri che il ruolo associato alla chiave API disponga delle autorizzazioni necessarie per sincronizzare i dati utente.
Panoramica dell'API
Esempio
Endpoint
Formato dei Dati Utente
UserData
| Parametro | Tipo | Descrizione |
|---|---|---|
dataType | 'user' | 'department' | Obbligatorio. Tipo di dati da inviare. Utilizzi user per l'invio di dati utente. |
matchKey | 'username' | 'email' | 'phone' | Opzionale. Utilizzato per abbinare gli utenti esistenti nel sistema in base al campo specificato. |
records | UserRecord[] | Obbligatorio. Array di record di dati utente. |
UserRecord
| Parametro | Tipo | Descrizione |
|---|---|---|
uid | string | Obbligatorio. Identificatore univoco per i dati utente di origine, utilizzato per associare i dati di origine all'utente del sistema. Immutabile per un utente. |
nickname | string | Opzionale. Nickname dell'utente. |
username | string | Opzionale. Nome utente. |
email | string | Opzionale. Indirizzo email dell'utente. |
phone | string | Opzionale. Numero di telefono dell'utente. |
departments | string[] | Opzionale. Array di UID dei dipartimenti a cui appartiene l'utente. |
isDeleted | boolean | Opzionale. Indica se il record è stato eliminato. |
<field> | any | Opzionale. Campi personalizzati nella tabella utente. |
Formato dei Dati del Dipartimento
INFO
L'invio di dati sui dipartimenti richiede che il plugin Dipartimenti sia installato e abilitato.
DepartmentData
| Parametro | Tipo | Descrizione |
|---|---|---|
dataType | 'user' | 'department' | Obbligatorio. Tipo di dati da inviare. Utilizzi department per i dati del dipartimento. |
records | DepartmentRecord[] | Obbligatorio. Array di record di dati del dipartimento. |
DepartmentRecord
| Parametro | Tipo | Descrizione |
|---|---|---|
uid | string | Obbligatorio. Identificatore univoco per i dati del dipartimento di origine, utilizzato per associare i dati di origine al dipartimento del sistema. Immutabile. |
title | string | Obbligatorio. Titolo del dipartimento. |
parentUid | string | Opzionale. UID del dipartimento padre. |
isDeleted | boolean | Opzionale. Indica se il record è stato eliminato. |
<field> | any | Opzionale. Campi personalizzati nella tabella del dipartimento. |
INFO
- L'invio ripetuto dei dati è un'operazione idempotente.
- Se un dipartimento padre non esiste al momento dell'invio dei dati del dipartimento, l'associazione non può essere stabilita. Può inviare nuovamente i dati dopo che il dipartimento padre è stato creato.
- Se il dipartimento di un utente non esiste al momento dell'invio dei dati utente, l'utente non può essere associato a quel dipartimento. Può inviare nuovamente i dati utente dopo aver inviato i dati del dipartimento.