• Español
      • Aviso de traducción por IA

      Esta documentación ha sido traducida automáticamente por IA.

      Sincronizar datos de usuario a través de la API HTTP

      Obtener una clave API

      Consulte Claves API. Asegúrese de que el rol asociado a la clave API tenga los permisos necesarios para sincronizar los datos de usuario.

      Descripción general de la API

      Ejemplo

      curl 'https://localhost:13000/api/userData:push' \
  -H 'Authorization: Bearer <token>' \
  --data-raw '{"dataType":"user","records":[]}' # Consulte los detalles del cuerpo de la solicitud a continuación

      Endpoint

      POST /api/userData:push

      Formato de datos de usuario

      UserData

      ParámetroTipoDescripción
      dataType'user' | 'department'Obligatorio. Tipo de datos que se envían. Use user para enviar datos de usuario.
      matchKey'username' | 'email' | 'phone'Opcional. Se utiliza para buscar y emparejar usuarios existentes en el sistema basándose en el campo especificado.
      recordsUserRecord[]Obligatorio. Array de registros de datos de usuario.

      UserRecord

      ParámetroTipoDescripción
      uidstringObligatorio. Identificador único para los datos de usuario de origen, utilizado para asociar los datos de origen con el usuario del sistema. Inmutable para un usuario.
      nicknamestringOpcional. Apodo del usuario.
      usernamestringOpcional. Nombre de usuario.
      emailstringOpcional. Dirección de correo electrónico del usuario.
      phonestringOpcional. Número de teléfono del usuario.
      departmentsstring[]Opcional. Array de UIDs de los departamentos a los que pertenece el usuario.
      isDeletedbooleanOpcional. Indica si el registro ha sido eliminado.
      <field>anyOpcional. Campos personalizados en la tabla de usuarios.

      Formato de datos de departamento

      Info

      Para enviar datos de departamento, es necesario tener instalado y habilitado el plugin de Departamentos.

      DepartmentData

      ParámetroTipoDescripción
      dataType'user' | 'department'Obligatorio. Tipo de datos que se envían. Use department para datos de departamento.
      recordsDepartmentRecord[]Obligatorio. Array de registros de datos de departamento.

      DepartmentRecord

      ParámetroTipoDescripción
      uidstringObligatorio. Identificador único para los datos de departamento de origen, utilizado para asociar los datos de origen con el departamento del sistema. Inmutable.
      titlestringObligatorio. Título del departamento.
      parentUidstringOpcional. UID del departamento padre.
      isDeletedbooleanOpcional. Indica si el registro ha sido eliminado.
      <field>anyOpcional. Campos personalizados en la tabla de departamentos.
      Info
      1. El envío de datos es una operación idempotente.
      2. Si un departamento padre no existe al enviar datos de departamento, la asociación no se podrá realizar. Puede volver a enviar los datos una vez que el departamento padre haya sido creado.
      3. Si el departamento de un usuario no existe al enviar datos de usuario, el usuario no podrá ser asociado a ese departamento. Puede volver a enviar los datos de usuario después de haber enviado los datos del departamento.