From add6ea80b10620f9f8bb5210ef362ff8cbfaa43c Mon Sep 17 00:00:00 2001 From: JIWOO Date: Wed, 3 Sep 2025 09:32:29 +0900 Subject: [PATCH] =?UTF-8?q?=EC=9D=B4=EC=A7=80=EC=9A=B0=20-=20API=20?= =?UTF-8?q?=EC=86=8C=EA=B0=9C=20=ED=8E=98=EC=9D=B4=EC=A7=80=20=EC=9E=91?= =?UTF-8?q?=EC=97=85=20=EC=A4=91?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../webapp/WEB-INF/jsp/web/api/apiSpec.jsp | 26 +- .../WEB-INF/jsp/web/api/ft/apiSpec_tab1.jsp | 216 +++++++++++ .../WEB-INF/jsp/web/api/ft/apiSpec_tab2.jsp | 232 ++++++++++++ .../WEB-INF/jsp/web/api/ft/apiSpec_tab3.jsp | 331 ++++++++++++++++ .../WEB-INF/jsp/web/api/ft/apiSpec_tab4.jsp | 353 ++++++++++++++++++ .../WEB-INF/jsp/web/api/ft/apiSpec_tab5.jsp | 195 ++++++++++ .../WEB-INF/jsp/web/api/ft/apiSpec_tab6.jsp | 195 ++++++++++ .../WEB-INF/jsp/web/api/ft/apiSpec_tab7.jsp | 195 ++++++++++ .../WEB-INF/jsp/web/api/ft/apiSpec_tab8.jsp | 195 ++++++++++ 9 files changed, 1934 insertions(+), 4 deletions(-) create mode 100644 src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab1.jsp create mode 100644 src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab2.jsp create mode 100644 src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab3.jsp create mode 100644 src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab4.jsp create mode 100644 src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab5.jsp create mode 100644 src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab6.jsp create mode 100644 src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab7.jsp create mode 100644 src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab8.jsp diff --git a/src/main/webapp/WEB-INF/jsp/web/api/apiSpec.jsp b/src/main/webapp/WEB-INF/jsp/web/api/apiSpec.jsp index c3916eae..9c1d4124 100644 --- a/src/main/webapp/WEB-INF/jsp/web/api/apiSpec.jsp +++ b/src/main/webapp/WEB-INF/jsp/web/api/apiSpec.jsp @@ -42,10 +42,12 @@ $(document).ready(function(){
+
@@ -85,8 +87,9 @@ $(document).ready(function(){
+ - +
@@ -95,8 +98,8 @@ $(document).ready(function(){
    • -
    • -
    • +
    • +
    • @@ -144,6 +147,21 @@ $(document).ready(function(){
    + + + +
    +
    +
      +
      • +
      • +
      • +
      • +
      • +
    +
    +
    + diff --git a/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab1.jsp b/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab1.jsp new file mode 100644 index 00000000..6a4e1f99 --- /dev/null +++ b/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab1.jsp @@ -0,0 +1,216 @@ +<%@ page language="java" contentType="text/html; charset=UTF-8" + pageEncoding="UTF-8"%> + + + + +
    + +
    Request
    +
    +
    +

    Request

    + + + + + + + + + + + + + + + + + + + + + + +
    API Request Http Method, 프로토콜, HOST, Service Port + 정보 테이블
    Http MethodPOST
    프로토콜HTTP/1.1
    HOSTapi.munjaon.co.kr
    Service Port443
    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    문자발송 API Request 키 종류 및 설명, 타입, 필수 여부 테이블
    키설명타입필수
    mberId사용자 IDStringO
    accessKey인증용 API KeyStringO
    +
    +

    ※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.

    +

    ※ 문자 텍스트 용량(byte) : 한글 1자당 2byte, 영문/숫자 1자당 1byte

    +
    +
    +
    +
    [Example]
    +
    +

    ｛

    +
    +

    + "mberId":"홍길동" +

    +

    + ,"accessKey":"XXXXXXXXXXXXXX414050694b953" +

    +
    +

    ｝

    +
    +
    + + +
    Response
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    문자발송 API Response 키 종류 및 설명, 타입 테이블
    키설명타입
    resultCode성공 여부 ("0" 이면 성공, 그 외는 실패)String
    data응답 결과 객체 (성공 시 배열, 실패 시 메시지)Array<Object>
    data[].userId사용자 IDString
    data[].senderKey발신자 키String
    data[].phoneNumber수신자 전화번호String
    data[].yellowId카카오톡 채널 IDString
    data[].firstRegistPnttm최초 등록 시각 (yyyy‑MM‑dd HH:mm:ss)String
    data[].firstRegisterId최초 등록자 IDString
    + +
    +

    ※ JSON 객체로 응답합니다.

    +
    +
    +
    +
    + [Example]O 성공 + 예시 +
    +
    +

    ｛

    +
    +

    + "resultCode":"0" +

    +

    + ,"data"｛ +

    +
    +

    + ,"senderKey":"6691434xxxxxxxxxxxxxxxxxxxxxxxxx" +

    +

    + ,"phoneNumber":"010xxxxxxxx" +

    +

    + ,"yellowId":"@ID" +

    +

    + ,"firstRegistPnttm":"2025-10-05 18:08:58" +

    +

    + ,"firstRegisterId":"userId" +

    +
    +

    ｝

    +
    +

    ｝

    +
    +
    +
    +
    + [Example]X 실패 예시 +
    +
    +

    ｛

    +
    +

    + "resultCode":"401" +

    +

    + ,"message":"Unauthorized" +

    +
    +

    ｝

    +
    +
    + +
    + diff --git a/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab2.jsp b/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab2.jsp new file mode 100644 index 00000000..67d57e4a --- /dev/null +++ b/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab2.jsp @@ -0,0 +1,232 @@ +<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> + + + +
    + +
    Request
    +
    +
    +

    Request

    + + + + + + + + + + + + + + + + + + + + + + +
    API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블
    Http MethodPOST
    프로토콜HTTP/1.1
    HOSTapi.munjaon.co.kr
    Service Port443
    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    문자발송 API Request 키 종류 및 설명, 타입, 필수 여부 테이블
    키설명타입필수
    mberId사용자 IDStringO
    accessKey인증용 API KeyStringO
    senderKey발신 프로필 KeyStringO
    +
    +

    ※ 문자 텍스트 용량(byte) : 한글 1자당 2byte, 영문/숫자 1자당 1byte

    +
    +
    +
    +
    [Example]
    +
    +

    ｛

    +
    +

    "mberId":"홍길동"

    +

    ,"accessKey":"414050694b953XXXXXXXXXXXXXX"

    +

    ,"senderKey":"669143473b1af459628b8bdXXXXXXXXXXXXXX"

    +
    +

    ｝

    +
    +
    + + +
    Response
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    문자발송(대량) API Response 키 종류 및 설명, 타입 테이블
    키설명타입
    resultCode성공 여부("0" 아니면 실패)String
    data템플릿 정보 리스트Array
    [data].senderKey발신 프로필 키String
    [data].templateCode템플릿 코드String
    [data].templateName템플릿 이름String
    [data].createdAt생성일시String
    [data].modifiedAt수정일시String
    [data].serviceStatus템플릿 상태
    (REG: 등록, REQ: 검수요청, REJ: 반려, +STP: 차단, RDY: 발송전, ACT: 정상, DMT: 휴면, BLK: +차단)    		String
    +
    +

    ※ JSON 객체로 응답합니다.

    +
    +
    +
    +
    [Example]O 성공 예시
    + +
    +

    ｛

    +
    +

    + "resultCode":"0" +

    +

    + ,"data"｛ +

    +
    +

    + ,"senderKey":"669143473b1af459628xxxxxxxxxxxxxxxxxxxxx" +

    +

    + ,"templateCode":"bizp_20250527112232xxxxxxxxxxxxx" +

    +

    + ,"templateName":"템플릿 명" +

    +

    + ,"createdAt":"2025-05-27 11:22:33" +

    +

    + ,"modifiedAt":"2025-05-27 11:22:33" +

    +

    + ,"serviceStatus":"REG(등록완료)" +

    +
    +

    ｝

    +

    ,｛

    +
    +

    + ,"senderKey":"669143473b1af459628xxxxxxxxxxxxxxxxxxxxx" +

    +

    + ,"templateCode":"bizp_20250527112232xxxxxxxxxxxxx" +

    +

    + ,"templateName":"템플릿 명2" +

    +

    + ,"createdAt":"2025-05-27 11:22:33" +

    +

    + ,"modifiedAt":"2025-05-27 11:22:33" +

    +

    + ,"serviceStatus":"RDY(대기)" +

    +
    +

    ｝

    +
    +

    ｝

    +
    +
    +
    +
    [Example]X 실패 예시
    +
    +

    ｛

    +
    +

    "resultCode":"4099"

    +

    ,"msg":"기타 시스템 오류"

    +
    +

    ｝

    +
    +
    + +
    diff --git a/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab3.jsp b/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab3.jsp new file mode 100644 index 00000000..c9570ab3 --- /dev/null +++ b/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab3.jsp @@ -0,0 +1,331 @@ +<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> + + + +
    + +
    Request
    +
    +
    +

    Request

    + + + + + + + + + + + + + + + + + + + + + + +
    API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블
    Http MethodPOST
    프로토콜HTTP/1.1
    HOSTapi.munjaon.co.kr
    Service Port443
    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    전송결과 조회 API Request 키 종류 및 설명, 타입, 필수 여부 테이블
    키설명타입필수
    mberId사용자 IDStringO
    accessKey인증용 API KeyStringO
    senderKey발신 프로필 KeyStringO
    templateCode템플릿 코드StringO
    +
    +

    ※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.

    +
    +
    +
    +
    [Example]
    +
    +

    ｛

    +
    +

    "mberId":"홍길동"

    +

    ,"accessKey":"414050694b953XXXXXXXXXXXXXX"

    +

    ,"senderKey":"669143473b1af459628b8bdXXXXXXXXXXXXXX"

    +

    ,"templateCode":"bizp_202503141052XXXXXXXXXXXXXX"

    +
    +

    ｝

    +
    +
    + + +
    Response
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    전송결과 조회 API Response 키 종류 및 설명, 타입 테이블
    키설명타입
    resultCode성공 여부("0" 아니면 실패)String
    data템플릿 정보 리스트Array
    [data].templateCode템플릿 코드String
    [data].templateName템플릿 이름String
    [data].templateMessageType템플릿 메시지 유형 (BA:기본형(default), EX:부가정보형, AD:광고추가형, MI:복합형)String
    [data].templateEmphasizeType템플릿 강조 유형 (NONE: 선택안함, TEXT: 강조표기형, IMAGE: 이미지형, ITEM_LIST: 아이템리스트형)String
    [data].templateContent템플릿 내용String
    [data].templateExtra부가정보String
    [data].templateAd광고성 메시지String
    [data].templateImageName템플릿 이미지 파일명String
    [data].templateImageUrl템플릿 이미지 링크String
    [data].templateTitle템플릿 내용 중 강조 표기할 핵심 정보String
    [data].templateSubtitle강조 표기 보조 문구String
    [data].templateHeader헤더String
    [data].categoryCode템플릿 카테고리 코드String
    [data].securityFlag보안 템플릿 여부 (true:설정)Boolean
    [data].inspectionStatus검수 상태 (REG: 등록, REQ: 검수요청, REJ: 반려, APR: 승인)String
    [data].createdAt생성일String
    [data].modifiedAt수정일String
    [data].status템플릿 상태(D:중지, A:정상, R:대기(발송전))String
    [data].block템플릿 차단 여부 (true:차단, false: 해제)Boolean
    [data].dormant템플릿 휴면 여부 (true:휴면, false: 해제)Boolean
    [data].templateItemHighlight아이템 하이라이트Object
    [data].templateItemHighlight.title타이틀String
    [data].templateItemHighlight.description상세 설명String
    [data].templateItemHighlight.imageUrl썸네일 이미지 주소String
    [data].templateItem아이템 정보Object
    [data].templateItem.list[]아이템 리스트Array
    [data].templateItem.list[].title타이틀String
    [data].templateItem.list[].description디스크립션String
    [data].templateItem.summary아이템 요약 정보Object
    [data].templateItem.summary.title타이틀String
    [data].templateItem.summary.description디스크립션String
    [data].buttons[]버튼 정보Array
    [data].buttons[].name버튼명String
    [data].buttons[].linkType버튼 링크타입 (DS:배송조회, WL:웹링크, AL:앱링크, BK:봇키워드, MD: 메시지전달, AC: 채널추가, BC: 상담톡전환, BT: 봇전환, P1: 이미지 보안전송 플러그인, P2: 개인정보이용 플러그인, P3: 원클릭 결제 플러그인)String
    [data].buttons[].linkAndAndroid 앱 링크 주소String
    [data].buttons[].linkIosIOS 앱 링크 주소String
    [data].buttons[].linkMo모바일 웹 링크 주소String
    [data].buttons[].linkPcPC 웹 링크 주소String
    [data].buttons[].pluginId플러그인 IDString
    [data].quickReplies[]바로연결 정보Array
    [data].quickReplies[].name바로연결명String
    [data].quickReplies[].linkType바로연결 링크타입 (WL:웹링크, AL:앱링크, BK:봇키워드, MD: 메시지전달, BC: 상담톡전환, BT: 봇전환)String
    [data].quickReplies[].linkAndAndroid 앱 링크 주소String
    [data].quickReplies[].linkIosIOS 앱 링크 주소String
    [data].quickReplies[].linkMo모바일 웹 링크 주소String
    [data].quickReplies[].linkPcPC 웹 링크 주소String
    [data].comments[]댓글 목록Array
    [data].comments[].content댓글 본문String
    [data].comments[].createdAt댓글 생성일String
    [data].comments[].status댓글 상태 (REQ:등록, INQ:문의, APR:승인, REJ:반려, REP:답변)String
    [data].comments[].userName댓글 작성자String
    [data].comments[].attachment첨부파일Array
    [data].comments[].attachment[]첨부파일Array
    [data].comments[].attachment[].originalFileName업로드한 파일 이름String
    [data].comments[].attachment[].filePath파일 다운로드 경로String
    +
    +

    ※ JSON 객체로 응답합니다.

    +
    +
    +
    +
    [Example]O 성공 예시
    +
    +

    ｛

    +
    +

    "resultCode":"0"

    +

    ,"data":［

    +

    ｛

    +
    +

    "templateCode": "bizp_20250314105XXXXXXXXXXXXXXX"

    +

    ,"templateName": "템플릿 명"

    +

    ,"templateMessageType": "BA"

    +

    ,"templateEmphasizeType": "TEXT"

    +

    ,"templateContent": "템플릿 내용 예시"

    +

    ,"templateExtra": "부가정보"

    +

    ,"templateAd": "광고성 문구"

    +

    ,"templateImageName": "template.jpg"

    +

    ,"templateImageUrl": "https://cdn.example.com/image.jpg"

    +

    ,"templateTitle": "강조 제목"

    +

    ,"templateSubtitle": "보조 문구"

    +

    ,"templateHeader": "템플릿 헤더"

    +

    ,"categoryCode": "005001"

    +

    ,"securityFlag": true

    +

    ,"inspectionStatus": "REG"

    +

    ,"createdAt": "2025-06-30 10:30:00"

    +

    ,"modifiedAt": "2025-07-01 11:00:00"

    +

    ,"status": "A"

    +

    ,"block": false

    +

    ,"dormant": false

    + + +

    ,"templateItemHighlight": {

    +
    +

    "title": "하이라이트 제목"

    +

    ,"description": "하이라이트 설명"

    +

    ,"imageUrl": "https://cdn.example.com/thumb.jpg"

    +
    +

    }

    + + +

    ,"templateItem": {

    +
    +

    "list": [

    +
    +

    ｛

    +

    "title": "아이템 제목"

    +

    ,"description": "아이템 설명"

    +

    ｝

    +
    +

    ],

    +

    "summary": {

    +
    +

    "title": "요약 제목"

    +

    ,"description": "요약 설명"

    +
    +

    }

    +
    +

    }

    + + +

    ,"buttons": [

    +
    +

    ｛

    +

    "name": "버튼명"

    +

    ,"linkType": "WL"

    +

    ,"linkAnd": "https://aos.example.com"

    +

    ,"linkIos": "https://ios.example.com"

    +

    ,"linkMo": "https://m.example.com"

    +

    ,"linkPc": "https://www.example.com"

    +

    ,"pluginId": "plugin123"

    +

    ｝

    +
    +

    ]

    + + +

    ,"quickReplies": [

    +
    +

    ｛

    +

    "name": "빠른응답"

    +

    ,"linkType": "WL"

    +

    ,"linkAnd": "https://aos.quick.com"

    +

    ,"linkIos": "https://ios.quick.com"

    +

    ,"linkMo": "https://m.quick.com"

    +

    ,"linkPc": "https://www.quick.com"

    +

    ｝

    +
    +

    ]

    + + +

    ,"comments": [

    +
    +

    ｛

    +

    "content": "댓글 예시입니다."

    +

    ,"createdAt": "2025-07-01 10:00:00"

    +

    ,"status": "REQ"

    +

    ,"userName": "관리자"

    +

    ,"attachment": [

    +
    +

    ｛

    +

    "originalFileName": "example.pdf"

    +

    ,"filePath": "/download/example.pdf"

    +

    ｝

    +
    +

    ]

    +

    ｝

    +
    +

    ]

    +
    +

    ｝

    +

    ］

    +
    +

    ｝

    +
    +
    +
    +
    [Example]X 실패 예시
    +
    +

    ｛

    +
    +

    "resultCode":"4099"

    +

    ,"data":"기타 시스템 오류"

    +
    +

    ｝

    +
    +
    + +
    diff --git a/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab4.jsp b/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab4.jsp new file mode 100644 index 00000000..44d4a720 --- /dev/null +++ b/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab4.jsp @@ -0,0 +1,353 @@ +<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> + + + +
    + +
    Request
    +
    +
    +

    Request

    + + + + + + + + + + + + + + + + + + + + + + +
    API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블
    Http MethodPOST
    프로토콜HTTP/1.1
    HOSTapi.munjaon.co.kr
    Service Port443
    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    상세결과 조회 API Request 키 종류 및 설명, 타입, 필수 여부 테이블
    키설명타입필수
    mberId사용자 IDStringO
    accessKey인증용 API KeyStringO
    msgGroupId메시지 그룹 IDStringO
    page페이지 번호StringX
    pageSize페이지당 출력 개수StringX
    test_yn테스트 데이터 여부StringX
    +
    +

    ※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.

    +
    +
    +
    +
    [Example]
    +
    +

    ｛

    +
    +

    "mberId":"홍길동"

    +

    ,"accessKey":"XXXXXXXXXXXXXX414050694b953"

    +

    ,"msgGroupId":"MSGGID_0000000011452"

    +

    ,"page":""

    +

    ,"pageSize":""

    +

    ,"test_yn":""

    +
    +

    ｝

    +
    +
    + + +
    Response
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    상세결과 조회 API Response 키 종류 및 설명, 타입 테이블
    키설명타입
    resultCode성공 여부("0" 아니면 실패)String
    data결과값 객체(성공 : 데이터, 실패 : 메시지)Object
    [data].message문자String
    [data].next_yn다음 페이지 여부String
    [data].objectList결과값 목록Object List
    [data].msgGroupId메시지 그룹 IDString
    [data].msgId메시지 IDString
    [data].msgTypeName문자 구분명(단문, 장문, 그림)String
    [data].msgType메시지 타입(4 : 단문, 6 : 장문)String
    [data].callFrom발신자 번호String
    [data].callTo수신자 번호String
    [data].msgGroupCnt문자 발송 건수String
    [data].sCnt성공 건수String
    [data].fCnt실패 건수String
    [data].wCnt대기 건수String
    [data].msgResult발송 결과(성공 : S, 실패 : F)String
    [data].smsTxt문자 내용String
    [data].subject제목String
    [data].reqdate발송 일자String
    [data].curState전송 처리 결과값String
    [data].userId사용자 IDString
    [data].regdate등록 일자String
    [data].reserveCYn예약 취소 여부String
    [data].ttlCnt전체 요청 수String
    [data].remainMsgCnt남은 문자 건수String
    [data].totMsgCnt전체 문자 개수String
    +
    +

    ※ JSON 객체로 응답합니다.

    +
    +
    +
    +
    [Example]O 성공 예시
    +
    +

    ｛

    +
    +

    "resultCode":"0"

    +

    ,"data":［

    +

    ｛

    +
    +

    "resultCode":"0"

    +

    ,"message": null

    +

    ,"next_yn":"n"

    +

    ,"msgGroupId":"MSGGID_0000000000000"

    +

    ,"objectList":［

    +

    ｛

    +
    +

    "msgTypeName":"단문(SMS)"

    +

    ,"msgType":"4"

    +

    ,"callFrom":"01011112222"

    +

    ,"callTo":"01011112223"

    +

    ,"msgGroupCnt":"2"

    +

    ,"msgGroupId":"MSGGID_0000000013340"

    +

    ,"msgId":"MSGID_0000000000001"

    +

    ,"scnt":null

    +

    ,"fcnt":null

    +

    ,"wcnt":null

    +

    ,"msgResult":"S"

    +

    ,"smsTxt":"문자 내용 단문 예제"

    +

    ,"subject":null

    +

    ,"reqdate":"2023-06-13 17:48:08"

    +

    ,"curState":"3"

    +

    ,"userId":"testuser"

    +

    ,"regdate":"2023-06-13 17:48:07"

    +

    ,"reserveCYn":"N"

    +

    ,"ttlCnt":"10"

    +

    ,"remainMsgCnt":"0"

    +

    ,"totMsgCnt":"10"

    +
    +

    ｝

    +

    ,｛

    +
    +

    "msgTypeName":"단문(SMS)"

    +

    ,"msgType":"4"

    +

    ,"callFrom":"01011112222"

    +

    ,"callTo":"01011112223"

    +

    ,"msgGroupCnt":"2"

    +

    ,"msgGroupId":"MSGGID_0000000013340"

    +

    ,"msgId":"MSGID_0000000000002"

    +

    ,"scnt":null

    +

    ,"fcnt":null

    +

    ,"wcnt":null

    +

    ,"msgResult":"S"

    +

    ,"smsTxt":"문자 내용 단문 예제"

    +

    ,subject":null

    +

    ,reqdate":"2023-06-13 17:48:09"

    +

    ,"curState":"3"

    +

    ,"userId":"testuser"

    +

    ,"regdate":"2023-06-13 17:48:07"

    +

    ,"reserveCYn":"N"

    +

    ,"ttlCnt":"10"

    +

    ,"remainMsgCnt":"0"

    +

    ,"totMsgCnt":"10"

    +

    ｝

    +
    +

    ］

    +
    +

    ｝

    +

    ］

    +
    +

    ｝

    +
    +
    +
    +
    [Example]X 실패 예시
    +
    +

    ｛

    +
    +

    "resultCode":"4099"

    +

    ,"data":"기타 시스템 오류"

    +
    +

    ｝

    +
    +
    + +
    diff --git a/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab5.jsp b/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab5.jsp new file mode 100644 index 00000000..df406dc3 --- /dev/null +++ b/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab5.jsp @@ -0,0 +1,195 @@ +<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> + + + +
    + +
    Request
    +
    +
    +

    Request

    + + + + + + + + + + + + + + + + + + + + + + +
    API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블
    Http MethodPOST
    프로토콜HTTP/1.1
    HOSTapi.munjaon.co.kr
    Service Port443
    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    발송가능 건수 API Request 키 종류 및 설명, 타입, 필수 여부 테이블
    키설명타입필수
    mberId사용자 IDStringO
    accessKey인증용 API KeyStringO
    +
    +

    ※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.

    +
    +
    +
    +
    [Example]
    +
    +

    ｛

    +
    +

    "mberId":"String"

    +

    ,"accessKey":"String"

    +
    +

    ｝

    +
    +
    + + +
    Response
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    발송가능 건수 API Response 키 종류 및 설명, 타입 테이블
    키설명타입
    resultCode성공 여부("0" 아니면 실패)String
    data결과값 객체(성공 : 데이터, 실패 : 메시지)Object
    [data].longPrice장문 단가String
    [data].longSendPsbltEa장문 발송 가능 건수String
    [data].mberMoney현재 보유 금액String
    [data].message문자String
    [data].picturePrice그림문자 단가String
    [data].pictureSendPsbltEa그림문자 발송 가능 건수String
    [data].shortPrice단문 단가String
    [data].shortSendPsbltEa단문 발송 가능 건수String
    +
    +

    ※ JSON 객체로 응답합니다.

    +
    +
    +
    +
    [Example]O 성공 예시
    +
    +

    ｛

    +
    +

    "resultCode":"0"

    +

    ,"data"｛

    +
    +

    "longPrice":"50"

    +

    ,"longSendPsbltEa":"19651"

    +

    ,"mberMoney":"982586.7"

    +

    ,"message":null

    +

    ,"picturePrice":"90"

    +

    ,"pictureSendPsbltEa":"10917"

    +

    ,"shortPrice":"18"

    +

    ,"shortSendPsbltEa":"54588"

    +
    +

    ｝

    +
    +

    ｝

    +
    +
    +
    +
    [Example]X 실패 예시
    +
    +

    ｛

    +
    +

    "resultCode":"5099"

    +

    ,"data":"기타 시스템 오류"

    +
    +

    ｝

    +
    +
    + +
    diff --git a/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab6.jsp b/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab6.jsp new file mode 100644 index 00000000..df406dc3 --- /dev/null +++ b/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab6.jsp @@ -0,0 +1,195 @@ +<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> + + + +
    + +
    Request
    +
    +
    +

    Request

    + + + + + + + + + + + + + + + + + + + + + + +
    API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블
    Http MethodPOST
    프로토콜HTTP/1.1
    HOSTapi.munjaon.co.kr
    Service Port443
    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    발송가능 건수 API Request 키 종류 및 설명, 타입, 필수 여부 테이블
    키설명타입필수
    mberId사용자 IDStringO
    accessKey인증용 API KeyStringO
    +
    +

    ※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.

    +
    +
    +
    +
    [Example]
    +
    +

    ｛

    +
    +

    "mberId":"String"

    +

    ,"accessKey":"String"

    +
    +

    ｝

    +
    +
    + + +
    Response
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    발송가능 건수 API Response 키 종류 및 설명, 타입 테이블
    키설명타입
    resultCode성공 여부("0" 아니면 실패)String
    data결과값 객체(성공 : 데이터, 실패 : 메시지)Object
    [data].longPrice장문 단가String
    [data].longSendPsbltEa장문 발송 가능 건수String
    [data].mberMoney현재 보유 금액String
    [data].message문자String
    [data].picturePrice그림문자 단가String
    [data].pictureSendPsbltEa그림문자 발송 가능 건수String
    [data].shortPrice단문 단가String
    [data].shortSendPsbltEa단문 발송 가능 건수String
    +
    +

    ※ JSON 객체로 응답합니다.

    +
    +
    +
    +
    [Example]O 성공 예시
    +
    +

    ｛

    +
    +

    "resultCode":"0"

    +

    ,"data"｛

    +
    +

    "longPrice":"50"

    +

    ,"longSendPsbltEa":"19651"

    +

    ,"mberMoney":"982586.7"

    +

    ,"message":null

    +

    ,"picturePrice":"90"

    +

    ,"pictureSendPsbltEa":"10917"

    +

    ,"shortPrice":"18"

    +

    ,"shortSendPsbltEa":"54588"

    +
    +

    ｝

    +
    +

    ｝

    +
    +
    +
    +
    [Example]X 실패 예시
    +
    +

    ｛

    +
    +

    "resultCode":"5099"

    +

    ,"data":"기타 시스템 오류"

    +
    +

    ｝

    +
    +
    + +
    diff --git a/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab7.jsp b/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab7.jsp new file mode 100644 index 00000000..df406dc3 --- /dev/null +++ b/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab7.jsp @@ -0,0 +1,195 @@ +<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> + + + +
    + +
    Request
    +
    +
    +

    Request

    + + + + + + + + + + + + + + + + + + + + + + +
    API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블
    Http MethodPOST
    프로토콜HTTP/1.1
    HOSTapi.munjaon.co.kr
    Service Port443
    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    발송가능 건수 API Request 키 종류 및 설명, 타입, 필수 여부 테이블
    키설명타입필수
    mberId사용자 IDStringO
    accessKey인증용 API KeyStringO
    +
    +

    ※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.

    +
    +
    +
    +
    [Example]
    +
    +

    ｛

    +
    +

    "mberId":"String"

    +

    ,"accessKey":"String"

    +
    +

    ｝

    +
    +
    + + +
    Response
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    발송가능 건수 API Response 키 종류 및 설명, 타입 테이블
    키설명타입
    resultCode성공 여부("0" 아니면 실패)String
    data결과값 객체(성공 : 데이터, 실패 : 메시지)Object
    [data].longPrice장문 단가String
    [data].longSendPsbltEa장문 발송 가능 건수String
    [data].mberMoney현재 보유 금액String
    [data].message문자String
    [data].picturePrice그림문자 단가String
    [data].pictureSendPsbltEa그림문자 발송 가능 건수String
    [data].shortPrice단문 단가String
    [data].shortSendPsbltEa단문 발송 가능 건수String
    +
    +

    ※ JSON 객체로 응답합니다.

    +
    +
    +
    +
    [Example]O 성공 예시
    +
    +

    ｛

    +
    +

    "resultCode":"0"

    +

    ,"data"｛

    +
    +

    "longPrice":"50"

    +

    ,"longSendPsbltEa":"19651"

    +

    ,"mberMoney":"982586.7"

    +

    ,"message":null

    +

    ,"picturePrice":"90"

    +

    ,"pictureSendPsbltEa":"10917"

    +

    ,"shortPrice":"18"

    +

    ,"shortSendPsbltEa":"54588"

    +
    +

    ｝

    +
    +

    ｝

    +
    +
    +
    +
    [Example]X 실패 예시
    +
    +

    ｛

    +
    +

    "resultCode":"5099"

    +

    ,"data":"기타 시스템 오류"

    +
    +

    ｝

    +
    +
    + +
    diff --git a/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab8.jsp b/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab8.jsp new file mode 100644 index 00000000..df406dc3 --- /dev/null +++ b/src/main/webapp/WEB-INF/jsp/web/api/ft/apiSpec_tab8.jsp @@ -0,0 +1,195 @@ +<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> + + + +
    + +
    Request
    +
    +
    +

    Request

    + + + + + + + + + + + + + + + + + + + + + + +
    API Request Http Method, 프로토콜, HOST, Service Port 정보 테이블
    Http MethodPOST
    프로토콜HTTP/1.1
    HOSTapi.munjaon.co.kr
    Service Port443
    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    발송가능 건수 API Request 키 종류 및 설명, 타입, 필수 여부 테이블
    키설명타입필수
    mberId사용자 IDStringO
    accessKey인증용 API KeyStringO
    +
    +

    ※ HTTPS 프로토콜을 사용하여 POST로 요청합니다.

    +
    +
    +
    +
    [Example]
    +
    +

    ｛

    +
    +

    "mberId":"String"

    +

    ,"accessKey":"String"

    +
    +

    ｝

    +
    +
    + + +
    Response
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    발송가능 건수 API Response 키 종류 및 설명, 타입 테이블
    키설명타입
    resultCode성공 여부("0" 아니면 실패)String
    data결과값 객체(성공 : 데이터, 실패 : 메시지)Object
    [data].longPrice장문 단가String
    [data].longSendPsbltEa장문 발송 가능 건수String
    [data].mberMoney현재 보유 금액String
    [data].message문자String
    [data].picturePrice그림문자 단가String
    [data].pictureSendPsbltEa그림문자 발송 가능 건수String
    [data].shortPrice단문 단가String
    [data].shortSendPsbltEa단문 발송 가능 건수String
    +
    +

    ※ JSON 객체로 응답합니다.

    +
    +
    +
    +
    [Example]O 성공 예시
    +
    +

    ｛

    +
    +

    "resultCode":"0"

    +

    ,"data"｛

    +
    +

    "longPrice":"50"

    +

    ,"longSendPsbltEa":"19651"

    +

    ,"mberMoney":"982586.7"

    +

    ,"message":null

    +

    ,"picturePrice":"90"

    +

    ,"pictureSendPsbltEa":"10917"

    +

    ,"shortPrice":"18"

    +

    ,"shortSendPsbltEa":"54588"

    +
    +

    ｝

    +
    +

    ｝

    +
    +
    +
    +
    [Example]X 실패 예시
    +
    +

    ｛

    +
    +

    "resultCode":"5099"

    +

    ,"data":"기타 시스템 오류"

    +
    +

    ｝

    +
    +
    + +