웰포인트의 사원관리와 관련된 API 기능을 제공합니다.

웰포인트 API를 호출하여 사원의 관리를 요청 할 수 있습니다. 서비스 테스트를 위해서는 API 호출이 필요합니다.

---

기본 호출 구문

공통 헤더

요청에서 필요로 하는 공통된 Header는 다음과 같습니다.

필드명	상세필드명	필수	타입	설명	비고
PER-ID	-	Y	String	API 연동 ID	-
PER-TOKEN	-	Y	String	발급 받은 토큰값	유효시간 10분.

const API = axios.create({
  baseURL: `https://api.ubcn.co.kr/api`, // http도 허용됩니다.
  headers: {
    "Access-Control-Allow-Origin": "*",
    "PER-ID": "{유출금지}",         // 사원관리 요청 호출 시 `PER-ID`와 `PER-TOKEN`이 필수
    "PER-TOKEN": "{유출금지}",      // 사원관리 요청 호출 시 `PER-ID`와 `PER-TOKEN`이 필수
  },
});

// post 요청만을 지원합니다.
// {service}에 따라 구분됩니다. 아래 상세 설명을 참조해주세요.
const res = await API.post("/well/client/{service}");
console.log(res.data);

// 프로세스가 제대로 완료되지 않은 경우 에러 코드가 존재합니다.
if (res.code != null) {
  return alert(res.decription);
}

---

사용자 정보 조회

Request Schema

요청에서 필요로 하는 필드는 다음과 같습니다.

필드명	상세필드명	필수	타입	설명	비고
cardNo	-	Y	String	카드번호	-
payment	-	N	String	결제수단	"QR" 혹은 "Barcode"만 허용. 생략 시 "Barcode"

호출구문

const API = axios.create({
        baseURL: `https://api.ubcn.co.kr/api`, // http도 허용됩니다.
        headers: {
            "Access-Control-Allow-Origin": "*",
            "PER-ID": "{유출금지}",
            "PER-TOKEN": "{유출금지}",
        },
});

    // post 요청만을 지원합니다.
    // {cardNo} : 조회하고자 하는 사원의 카드번호
    // {payment} : 조회하고자 하는 웰포인트의 결제 방식("QR" 혹은 "Barcode")
    const res = await API.post("/well/client/{cardNo}/{payment}");
    console.log(res.data);

    // 프로세스가 제대로 완료되지 않은 경우 에러 코드가 존재합니다.
    if (res.code != null) {
        return alert(res.decription);
}

Response Schema

결과 값에 들어 있는 필드는 다음과 같습니다.

필드명	상세필드명	필수	타입	설명	비고
findCnt	-	Y	int	조회된 사원(사용자) 수	-
foundList	-	Y	Array	조회된 사원(사용자) 리스트	아래 foundList 내부 필드 설명 참조
result_msg	-	Y	String	응답 메시지	-
result_code	-	Y	String	응답 코드	-

---

foundList 내부 필드 설명

foundList는 사원(사용자)의 배열로, 내부 객체는 다음과 같은 필드를 포함합니다.

필드명	상세필드명	필수	타입	설명	비고
seq	-	Y	int	사용자의 SEQ	-
cseq	-	Y	String	고객사 SEQ	-
userCardNo	-	Y	String	카드번호	-
userNo	-	Y	String	사용자 식별번호	-
userName	-	Y	String	사용자 명	-
vm	-	Y	String	현재 포인트 잔액	마이너스가 가능하여 String Type
grade	-	Y	String	등급	현재 미사용 데이터
validity	-	Y	String	사용자 활성화 여부	1: 활성화, 0: 삭제상태

---

Response JSON 예시

{
    "findCnt": 1,
    "foundList": [
        {
            "seq": "1",
            "cseq": "1"
            "userCardNo": "1198609522000001",
            "userNo": "000001",
            "userName": "ubcn테스트사원",
            "vm": "50000",
            "grade": "0",
            "validity": "1",
        }
    ],
    "result_code": "0000",
    "result_msg": "정상처리",
}

---

사용자 정보 등록

Request Schema

요청에서 필요로 하는 필드는 다음과 같습니다. 객체 리스트를 통해 2명 이상의 사용자를 등록할 수 있습니다.

필드명	상세필드명	필수	타입	설명	비고
employeeList	-	Y	Array	등록하고자 하는 사원 Array	객체 리스트

employeeList 내부 필드 설명

employeeList는 사원의 배열로, 내부 객체는 다음과 같은 필드를 포함합니다.

필드명	상세필드명	필수	타입	설명	비고
userCardNo	-	Y	String	사원 카드번호	최대 20자리
userNo	-	Y	String	사원 번호	-
vm	-	Y	String	초기 복지금액	-
userName	-	N	String	사원 명	-

호출 구문

const API = axios.create({
    baseURL: `https://api.ubcn.co.kr/api`, // http도 허용됩니다.
    headers: {
        "Access-Control-Allow-Origin": "*",
        "PER-ID": "{유출금지}",
        "PER-TOKEN": "{유출금지}",
    },
});

// Array 내부에 등록하고자 하는 사원 수 만큼 Index 생성
const bodyList = [
    {
        "userCardNo" : "1198609522000000001",
        "userNo" : "UBCN001",
        "vm" : "10000",
        "userName" : "홍길동",
    }, ...,
]

// post 요청만을 지원합니다.
// {payment} : 조회하고자 하는 웰포인트의 결제 방식("QR" 혹은 "Barcode")
const res = await API.post("/well/client/regist/{payment}", bodyList);
console.log(res.data);

// 프로세스가 제대로 완료되지 않은 경우 에러 코드가 존재합니다.
if (res.code != null) {
    return alert(res.decription);
}

Response Schema

결과 값에 들어 있는 필드는 다음과 같습니다.

필드명	상세필드명	필수	타입	설명	비고
successCnt	-	Y	int	등록 성공 횟수	-
failCnt	-	Y	int	등록 실패 횟수	-
failList	-	N	Array	실패 원인 Array	아래 failList 내부 필드 설명 참조
result_code	-	Y	String	응답 코드	-
result_msg	-	Y	String	응답 메시지	-

failList 내부 필드 설명

failList 실패한 요청 파라미터와 실패 사유를 나타내는 배열로, 내부 객체는 다음과 같은 필드를 포함합니다.

필드명	상세필드명	필수	타입	설명	비고
seq	-	N	String	seq
userNo	-	N	String	사원번호
cSeq	-	N	String	고객사SEQ
userCardNo	-	N	String	사원카드번호
userName	-	N	String	사원명
vm	-	N	String	복지금액
grade	-	N	String	사원등급
validity	-	N	String	실패사유

---

사용자 정보 변경

Request Schema

요청에서 필요로 하는 필드는 다음과 같습니다.

필드명	상세필드명	필수	타입	설명	비고
seq	-	Y	String	사원 SEQ	-
userCardNo	-	Y	String	사원 카드번호	최대 19자리
userNo	-	Y	String	사원 번호	-
userName	-	N	String	사원명	-
vm	-	Y	String	복지금액	입력한 값으로 복지금액이 변경됩니다.

호출 구문

const API = axios.create({
    baseURL: `https://api.ubcn.co.kr/api`, // http도 허용됩니다.
    headers: {
       "Access-Control-Allow-Origin": "*",
       "PER-ID": "{유출금지}",
       "PER-TOKEN": "{유출금지}",
    },
});

const bodyData = {
    "seq" : "1",
    "userCardNo" : "1198609522000001",
    "userNo" : "UBCN002",
    "userName" : "수정할 이름",
    "vm" : "20000"
}

// post 요청만을 지원합니다.
// {payment} : 조회하고자 하는 웰포인트의 결제 방식("QR" 혹은 "Barcode")
const res = await API.post("/well/client/modify/{payment}", bodyData);
console.log(res.data);

// 프로세스가 제대로 완료되지 않은 경우 에러 코드가 존재합니다.
if (res.code != null) {
    return alert(res.decription);
}

Response Schema

결과 값에 들어 있는 필드는 다음과 같습니다.

필드명	상세필드명	필수	타입	설명	비고
result_code	-	Y	String	응답 코드	-
result_msg	-	Y	String	응답 메시지	-

---

사용자 사용해지

Request Schema

요청에서 필요로 하는 필드는 다음과 같습니다.

필드명	상세필드명	필수	타입	설명	비고
seq	-	Y	String	사원 SEQ	`사용자 정보 조회` API를 통해 해지하고자 하는 사원의 SEQ 확인

호출구문

const API = axios.create({
    baseURL: `https://api.ubcn.co.kr/api`, // http도 허용됩니다.
    headers: {
        "Access-Control-Allow-Origin": "*",
        "PER-ID": "{유출금지}",
        "PER-TOKEN": "{유출금지}",
    },
});

// post 요청만을 지원합니다.
// {seq} : 해지하고자 하는 사원 SEQ
const res = await API.post("/well/client/delete/{seq}");
console.log(res.data);

// 프로세스가 제대로 완료되지 않은 경우 에러 코드가 존재합니다.
if (res.code != null) {
    return alert(res.decription);
}

Response Schema

결과 값에 들어 있는 필드는 다음과 같습니다.

필드명	상세필드명	필수	타입	설명	비고
result_code	-	Y	String	응답 코드	-
result_msg	-	Y	String	응답 메시지	-

---

---

·

더 궁금한 내용이 있으신가요?

실시간 문의

·

가맹·영업 관련 문의가 필요하신가요?

이메일 보내기

·

개인정보처리방침