• Français
      • Avis de traduction IA

      Cette documentation a été traduite automatiquement par IA.

      Synchronisation des données utilisateur via l'API HTTP

      Obtenir une clé API

      Référez-vous à la section Clés API. Assurez-vous que le rôle associé à votre clé API dispose des permissions nécessaires pour synchroniser les données utilisateur.

      Présentation de l'API

      Exemple

      curl 'https://localhost:13000/api/userData:push' \
  -H 'Authorization: Bearer <token>' \
  --data-raw '{"dataType":"user","records":[]}' # Voir les détails du corps de la requête ci-dessous

      Endpoint

      POST /api/userData:push

      Format des données utilisateur

      UserData

      ParamètreTypeDescription
      dataType'user' | 'department'Obligatoire. Type de données à envoyer. Utilisez user pour les données utilisateur.
      matchKey'username' | 'email' | 'phone'Facultatif. Permet de faire correspondre les utilisateurs existants du système en fonction du champ spécifié.
      recordsUserRecord[]Obligatoire. Tableau d'enregistrements de données utilisateur.

      UserRecord

      ParamètreTypeDescription
      uidstringObligatoire. Identifiant unique des données utilisateur source, utilisé pour associer les données source à l'utilisateur système. Immuable pour un utilisateur donné.
      nicknamestringFacultatif. Surnom de l'utilisateur.
      usernamestringFacultatif. Nom d'utilisateur.
      emailstringFacultatif. Adresse e-mail de l'utilisateur.
      phonestringFacultatif. Numéro de téléphone de l'utilisateur.
      departmentsstring[]Facultatif. Tableau des UIDs des départements auxquels l'utilisateur appartient.
      isDeletedbooleanFacultatif. Indique si l'enregistrement est supprimé.
      <field>anyFacultatif. Champs personnalisés dans la table utilisateur.

      Format des données de département

      Info

      L'envoi de données de département nécessite que le plugin Départements soit installé et activé.

      DepartmentData

      ParamètreTypeDescription
      dataType'user' | 'department'Obligatoire. Type de données à envoyer. Utilisez department pour les données de département.
      recordsDepartmentRecord[]Obligatoire. Tableau d'enregistrements de données de département.

      DepartmentRecord

      ParamètreTypeDescription
      uidstringObligatoire. Identifiant unique des données de département source, utilisé pour associer les données source au département système. Immuable pour un département donné.
      titlestringObligatoire. Titre du département.
      parentUidstringFacultatif. UID du département parent.
      isDeletedbooleanFacultatif. Indique si l'enregistrement est supprimé.
      <field>anyFacultatif. Champs personnalisés dans la table de département.
      Info
      1. L'envoi de données est une opération idempotente.
      2. Si un département parent n'existe pas lors de l'envoi de données de département, l'association ne peut pas être établie. Vous pouvez renvoyer les données une fois que le département parent a été créé.
      3. Si le département d'un utilisateur n'existe pas lors de l'envoi de données utilisateur, l'utilisateur ne peut pas être associé à ce département. Vous pouvez renvoyer les données utilisateur après avoir envoyé les données de département.