스킵하기
개발자센터
연동/API

API 시작하기

섹션 제목: “API 시작하기”


단말기로부터 발생한 매출 데이터와 가맹점 시스템과 연계할 수 있는 부가 서비스들을 API 형태로 제공합니다.
API 서비스는 유상 서비스로 진행됩니다.

관련 문의는 영업팀을 통해 문의해주세요.

  • 유상: 당일 거래 포함한 아래 모든 서비스 제공
    (단, 호출시간으로부터 최대 5분 전 거래까지 제공 - 카드사 응답 대기 최대 지연시간)


지원 서비스

섹션 제목: “지원 서비스”
  • 거래내역
    • 거래내역 목록
  • 마감정보
    • 특정 일자의 마감된 거래들의 집계정보 목록
  • 상태정보
    • 단말기의 상태정보 (1시간 마다 단말기에서 발송하는 상태정보 제공) 목록


사전 준비 사항

섹션 제목: “사전 준비 사항”

유비씨엔 API를 사용하기 위해서는 먼저, 가맹점 고유번호인 company와 암호화 된 token을 발급받아야 합니다. 해당 정보는 유비씨엔 관리자에게 문의하여 발급받을 수 있습니다.



Request Schema

섹션 제목: “Request Schema”
Content-Typecompanytoken
application/json12345ABCDEFGHIJKLMNOPQRSTUVWXYZ


API 호출 방법

섹션 제목: “API 호출 방법”

API 호출 방법은 다음과 같습니다.

const API = axios.create({
  baseURL: `http://api.ubcn.co.kr/api`,
  headers: {
    "Access-Control-Allow-Origin": "*",
    "company": "{company}",
    "token": "{token}",
  },
});


// 서비스에 따라 `Method` 가 다를 수 있습니다.
const res = await API.get("{service}");
console.log(res.data);


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