Flextudio API - User

Flextudio API - User 서비스는 테넌트에 사용자 정보를 조회, 저장, 수정, 삭제를 수행할 수 있도록 해주는 기능을 제공합니다. 이 서비스를 통해 별도의 관리자 페이지를 구성하여 사용할 수 있습니다.

공통 구성 요소 설명

서비스 종류

서비스에서 사용 가능한 목록입니다.

모듈명

사용자가 선택한 시스템에 등록된 모듈들을 표시합니다.

서비스 유형

사용자가 선택한 시스템-모듈에 등록된 세부 서비스 유형을 표시합니다. Flextudio API - User에는 조회, 저장, 수정, 삭제 모듈이 있으며, 이를 통해 사용자에 대한 조회, 추가, 수정, 삭제 작업을 수행할 수 있습니다.

기본앱은 snsLogin을 통해서만 유저 추가가 가능합니다.

사용자 동기화를 사용하는 테넌트는 유저 추가, 수정, 삭제 기능을 지원하지 않습니다.

Flex API Key

Flextudio API 를 호출하기 위해 필요한 API Key입니다. Flex API Key관리에서 발급받은 키를 통해 API를 호출할 수 있습니다.

고급설정

서비스 호출에 대한 상세 설정을 할 수 있습니다.

조회 고급설정

페이지 번호 컬렉션 키

조회할 페이지 값이 있는 컬렉션키를 지정합니다.

기본값은 1페이지입니다.

페이징 크기

한번에 조회할 항목 수를 지정합니다. 한번에 최대 50개까지 조회할 수 있습니다.

기본값은 30개 입니다.

필드 명

쿼리 조건을 적용할 대상 필드명입니다. 이 필드를 기준으로 지정한 조건에 따라 데이터를 검색하게 됩니다.

Operator

필드에 적용할 조건 연산자입니다.

지원하는 연산자로는 contains ,!contains ,== , != , < , <= , > , >= 이 있습니다.

필드값 컬렉션 키

조건 비교 대상이 되는 값을 가진 컬렉션 키를 지정합니다. 이 컬렉션 키에 해당하는 값과 필드 명에 지정된 필드의 값이 지정된 연산자에 따라 비교됩니다.

저장 고급설정

서비스 호출 한 앱에 사용 권한 부여

사용자를 저장할 때, 서비스를 호출한 앱에 대한 사용 권한을 자동으로 부여합니다.

모듈별 이벤트 데이터

조회

보내는 데이터

ParamBlock1 : 첫 번째 섹터를 조건 데이터로 사용합니다. 이 데이터는 조회 실행 시 검색 조건으로 활용됩니다.

받는 데이터

ResultBlock1 : 실행 결과로 조회된 유저정보를 반환합니다.

ResultBlock2 : 페이징 결과정보를 반환합니다.

키	설명
currentPage	현재 페이지
limit	페이징 크기
count	조회된 결과 수
hasNextPage	다음 페이지 유무
hasPrevPage	이전 페이지 유무
nextPage	다음 페이지 번호
prevPage	이전 페이지 번호

저장

보내는 데이터

ParamBlock1 : 모든 섹터의 유저정보를 저장합니다. 이 과정에서 전달된 모든 유저정보를 저장합니다.

서비스 호출 한 앱에 사용 권한 부여를 사용 시 첫번째 섹터의 유저정보만 저장합니다.

fPhoneNo와 fEmail 값 중 한가지는 있어야합니다.

fBaseUserID를 포함한 유저정보는 저장하지 않습니다.

userData 아래 항목과 고객관리상세페이지-회사정보에서 추가한 항목만 저장됩니다.

키	Type	Required	설명
fBaseUserName	String/JSON	O	String : 모국어만 사용하는 경우 JSON : 국가별 성명 관리 필요한 경우
fBaseUserNo	String		유저관리 키, 값이 없을경우 자동생성
fPhoneNo	String		앱 로그인 시, 사용될 휴대폰 번호
fEmail	String		앱 로그인 시, 사용될 이메일
fBaseDeptName	String		소속명
EtcInfo	String		기타정보 : [사용자관리]에서 조회 및 검색이 필요한 정보 개행이 필요한 경우 \n 사용

받는 데이터

ResultBlock1 : 저장된 유저정보 결과를 반환합니다.

ResultBlock2 : 저장 실패한 유저정보 및 항목별 오류메시지를 포함한 결과를 반환합니다.

수정

보내는 데이터

ParamBlock1 : 모든 섹터의 유저정보를 수정합니다. 이 과정에서 전달된 값에 대해서만 수정됩니다.

userData 아래 항목과 고객관리상세페이지-회사정보에서 추가한 항목만 수정합니다.

키	Type	Required	설명
fBaseUserID	String	O	유저ID
fBaseUserName	String/JSON	O	String : 모국어만 사용하는 경우 JSON : 국가별 성명 관리 필요한 경우
fBaseUserNo	String		유저관리 키, 값이 없을경우 자동생성
fPhoneNo	String		앱 로그인 시, 사용될 휴대폰 번호
fEmail	String		앱 로그인 시, 사용될 이메일
fBaseDeptName	String		소속명
EtcInfo	String		기타정보 : [사용자관리]에서 조회 및 검색이 필요한 정보 개행이 필요한 경우 \n 사용

받는 데이터

ResultBlock1 : 수정된 유저정보 결과를 반환합니다.

ResultBlock2 : 수정 실패한 유저정보 및 항목별 오류메시지를 포함한 결과를 반환합니다.

삭제

보내는 데이터

ParamBlock1 : 모든 섹터를 유저정보를 삭제합니다. 이 과정에서 전달된 값에 대해서만 수정됩니다.

키	Type	Required	설명
fBaseUserID	String	O	유저ID

받는 데이터

ResultBlock1 : 삭제된 유저의 fBaseUserID와 status : "D"를 포함한 결과를 반환합니다. fBaseUserID를 기준으로 병합을 통해 콜렉션에서 해당 fBaseUserID에 해당하는 섹터를 삭제할 수 있습니다.

ResultBlock2 : 삭제 실패한 유저의 fBaseUserID와 오류메시지를 포함한 결과를 반환합니다.