AppStore 연동규격서 v1.1

사 용 권 한

본 문서에 대한 서명은 ㈜유라클 내부에서 본 문서에 대하여 수행 및 유지관리의 책임이 있음을 인정하는 것임.

제.개정 이력

버전

변경일자

제.개정 내용

작성자

1.0

2012.09.10

최초작성

권형석

1.1

2013.11.29

수정

정여택

  1. 개요

    1. 목적_gwV22

본 문서는 AppStore 클라이언트 개발을 위한 제반 사항을 기술한다.

고려사항

  • 매뉴얼 변경 시에는 근거를 명시하고 버전 관리를 정확하게 수행

  • 데이터는 JSON 형식을 따르며 통신은 HTTP, FTP를 지원한다.

  • 전문 내용 중 데이터 길이가 명시되지 않은 항목은 가변길이 이다.

    1. 참고_gwV22

  • 본 문서는 성능개선, 기능추가 등의 사항으로 내용이 변경 될 수 있다.

패킷 정의

본 절에서는 패킷에 대하여 정의 하도록 한다.

요청 패킷 정의

구분

항목

Size

Type

필수여부

설명

head

action

String

Y

리소스 인터페이스

service_id

String

Y

리소스에 대한 서비스 아이디

Body

요청 데이터

JSONObject

Y

응답 패킷 정의

구분

항목

Size

Type

필수여부

설명

head

result_code

String

Y

응답 결과 코드

result_message

String

Y

응답 결과 메시지

body

응답 데이터

JSONObject

리소스 인터페이스

해당 서비스 리소스에 대한 한정적인 인터페이스를 수행하여 간결하고 통일화 한다. 리소스에 대한 인터페스는 다음과 같다.

Action 명

설명

add

리소스의 정보를 저장 한다.

get

특정 리소스의 정보를 조회 한다.

update

특정 리소스의 정보를 업데이트 한다.

delete

특정 리소스의 정보를 삭제 한다.

list

특정 리소스의 목록을 조회 한다.

  1. 전문 정의

    1. 전문 리스트

리소스명

서비스 아이디

Action Interface (CRUD)

설명

앱목록

appinfo

list

AppStore에 등록된 앱목록을 조회한다.

앱상세

appinfo

get

AppStore에 등록된 앱 상세정보를 조회한다.

카테고리목록

category

list

AppStore에 등록된 카테고리목록을 조회한다.

다운로드이력추가

download

add

AppStore에 등록된 앱을 다운로드 후 클라이언트에서 이력추가 요청한다.

스토어 로그인

login

get

AppStore에 사용자 로그인 처리를 요청한다.

전문 유형

3.2.1 앱목록(appinfo list)

용도: AppStore에 등록된 앱목록 정보를 클라이언트에 응답한다.

주소 : http://xxx.xxx.xxx.xxx/api/appinfo/list

형식

구분

항목

값

길이

필수

설명

head

action

list

M

리소스 인터페이스

service_id

appinfo

M

리소스에 대한 서비스 아이디

body

userid

7

O

회원아이디

system_name

20

O

시스템 명

cate_cd

10

O

카테고리코드

예제

{“body”:{“userid”:”test01”,”system_name”:”iOS”,”categorycd”:”0000000001”},

“head”:{“action”:”list”,”service_id”:”appinfo”}}

응답

구분

항목

값

길이

필수

설명

head

result_code

M

성공 : 200 (이외 실패)

result_message

M

응답결과 메시지

body

list

array

O

결과목록

list[app_no]

10

M

앱순번

list[app_id]

40

M

앱아이디

list[app_nm]

50

M

앱이름

list[package_nm]

1000

M

안드로이드 : 단말앱확인값(패키지)

list[required]

2

M

필수여부(10. 필수, 20.일반)

list[cate_cd]

10

O

카테고리코드

list[cate_nm]

1000

O

카테고리명

list[icon_app_url]

1000

M

작은아이콘URL

등록된 아이콘이 없으면 default 제공

list[icon_app_bic_url]

1000

M

큰아이콘URL

등록된 아이콘이 없으면 default 제공

list[app_ver]

100

M

앱버전

list[bin_url]

1000

M

앱설치파일경로

list[bin_size]

M

앱설치파일크기

3.2.2 앱정보(appinfo get)

용도: AppStore에 등록된 앱 상세정보를 클라이언트에 응답한다.

주소 : http://xxx.xxx.xxx.xxx/api/appinfo/get

형식

구분

항목

값

길이

필수

설명

head

action

get

M

리소스 인터페이스

service_id

appinfo

M

리소스에 대한 서비스 아이디

body

app_no

10

M

앱순번

예제

{“body”:{“app_no”:”1961726”},”head”:{“action”:”get”,”service_id”:”appinfo”}}

응답

구분

항목

값

길이

필수

설명

head

result_code

M

성공 : 200 (이외 실패)

result_message

M

응답결과 메시지

body

app_no

10

M

앱순번

app_id

40

M

앱아이디

app_nm

50

M

앱이름

package_nm

1000

M

안드로이드 : 단말앱확인값

패키지

app_info

1000

M

앱개요

app_desc

4000

M

앱설명

required

2

M

필수여부

cate_cd

10

O

카테고리코드

cate_nm

1000

O

카테고리명

icon_app_url

1000

M

작은아이콘URL

등록된 아이콘이 없으면 default 제공

icon_app_bic_url

1000

M

큰아이콘URL

등록된 아이콘이 없으면 default 제공

con_detail_img

array

M

등록된 미리보기가 없으면 default 제공

con_detail_img[img_url]

1000

M

미리보기URL

app_ver

100

M

앱버전

bin_url

1000

M

앱설치파일경로

bin_size

M

앱설치파일크기

bin_no

M

앱설치파일번호

3.2.3 카테고리 목록 조회 (category list)

용도: 설정된 전체 카테고리 목록을 조회한다.

주소 : http://xxx.xxx.xxx.xxx/api/category/list

형식

구분

항목

값

길이

필수

설명

head

action

list

M

리소스 인터페이스

service_id

category

M

리소스에 대한 서비스 아이디

body

parent_cate_cd

10

O

상위코드

해당 상위코드 아래 카테고리 목록을 조회한다.

예제

{“head”:{“action”:”list”,”service_id”:”category”},”body”:{“parent_cate_cd”:”STORE”}}

응답

구분

항목

값

길이

필수

설명

head

result_code

M

성공 : 200 (이외 실패)

result_message

M

응답결과 메시지

body

list

array

list[cate_cd]

M

카테고리코드

list[cate_nm]

M

카테고리명

3.2.4 다운로드 이력추가 (download add)

용도: 앱 다운로드 후 클라이언트에서 이력을 추가 요청한다.

주소 : http://xxx.xxx.xxx.xxx/api/download/add

형식

구분

항목

값

길이

필수

설명

head

action

add

M

리소스 인터페이스

service_id

download

M

리소스에 대한 서비스 아이디

body

imei

15

M

단말기고유식별번호(IMEI)

phone_no

20

M

폰번호

emp_no

10

M

회원번호

cuid

50

M

고객고유식별번호

예) 도시철도 : emp_no

app_id

10

M

앱정보순번

app_ver

100

M

앱버전

bin_no

100

M

바이너리의 순번

예제

{“head”:{“action”:”add”,”service_id”:”download”}

,”body”:{“imei”:”abcde1234567890”,”phone_no”:”01010002000”,”emp_no”:”0001”

,”cuid”:”0001”,”app_id”:”1”,”app_ver”:”1.1”,”bin_no”:”1”}}

응답

구분

항목

값

길이

필수

설명

head

result_code

M

성공 : 200 (이외 실패)

result_message

M

응답결과 메시지

3.2.5 로그인 처리 요청 (login get)

용도: 앱에서 사용자 로그인 처리를 요청한다.

주소 : http://xxx.xxx.xxx.xxx/api/login/get

형식

구분

항목

값

길이

필수

설명

head

action

get

M

리소스 인터페이스

service_id

login

M

리소스에 대한 서비스 아이디

body

user_id

20

M

사용자 ID

user_pw

20

M

사용자 암호

예제

{“head”:{“action”:”get”,”service_id”:”login”},”body”:{“user_id”:”test01”,”user_pw”:”0000”}}

응답

구분

항목

값

길이

필수

설명

head

result_code

M

성공 : 200 (이외 실패)

result_message

M

응답결과 메시지

body

msg

M

로그인 결과 메시지

emp_nm

M

사용자명

3.2.6 사용자 단말기 목록 (device list)

용도 : 사용자의 단말기 목록을 가져온다.

주소 : http://xxx.xxx.xxx.xxx/api/device/get

형식

구분

항목

값

길이

필수

설명

head

action

get

M

리소스 인터페이스

service_id

login

M

리소스에 대한 서비스 아이디

body

emp_no

20

M

사용자 사번

예제

{
"head": {
    "result_msg": "Success",
    "result_code": "200"
},
"body": {
    "list": [
        {
            "use_fg": "Y",
            "device_nm": "SM-N920S",
            "os_nm": "Android",
            "device_uuid": "ffffffff-b7a8-bb9a-6a8b-0aff00000000",
            "last_date": "2021.03.12 16:00"
        }
    ]
}
}

응답

구분

항목

값

길이

필수

설명

head

result_code

M

성공 : 200 (이외 실패)

result_message

M

응답결과 메시지

body

list

array

O

결과목록

list[use_fg]

1

M

사용여부

list[device_nm]

50

M

단말기 모델

list[os_nm]

20

M

운영체제 이름

list[device_uuid]

100

M

단말기 고유번호

list[last_date]

16

M

최종 접속일시

3.2.7 단말기 사용 중지

용도 : 지정된 단말기의 사용을 중지 한다.

주소 : http://xxx.xxx.xxx.xxx/api/device/disable

형식

구분

항목

값

길이

필수

설명

head

action

get

M

리소스 인터페이스

service_id

login

M

리소스에 대한 서비스 아이디

body

emp_no

20

M

사용자 사번

device_uuid

100

M

단말기 고유번호

 
{
  "head": {
      "result_msg": "Success",
      "result_code": "200"
  },
  "body": {}
}

응답

구분

항목

값

길이

필수

설명

head

result_code

M

성공 : 200 (이외 실패)

result_message

M

응답결과 메시지

body

3.2.8 공지사항 조회

용도 : 스토어의 공지사항을 조회 한다.

주소 : http://xxx.xxx.xxx.xxx/api/notice/get

형식

구분

항목

값

길이

필수

설명

head

action

get

M

리소스 인터페이스

service_id

login

M

리소스에 대한 서비스 아이디

body

page_num

20

M

페이지 번호

page_size

20

M

페이지 목록 크기

예제

{
 "head": {
     "result_msg": "Success",
     "result_code": "200"
 },
 "body": {
     "list": [
         {
             "rnum": "1",
             "tot_CNT": "5",
             "board_IDX": "1",
             "svc_ID": "7",
             "board_TYPE": "NOTICE",
             "board_DETAIL_TYPE": "10",
             "board_DETAIL_NAME": "공지",
             "board_TITLE": "TEST",
             "board_CONTENT": "TEST<p>공지 테스트</p><p><br></p>",
             "hit": "1",
             "use_YN": "Y",
             "reg_ID": "admin",
             "reg_DT": "2021.03.11",
             "mod_DT": null,
             "mod_ID": null,
             "secret_YN": "Y",
             "file_IDX": null,
             "file_PATH": null,
             "file_NAME": null,
             "file_SAVE_NAME": null,
             "file_EXT": null,
             "file_SIZE": null,
             "file": null,
             "ref": "1",
             "stp": 0,
             "lvl": 0
         }
     ]
 }
}

응답

구분

항목

값

길이

필수

설명

head

result_code

M

성공 : 200 (이외 실패)

result_message

M

응답결과 메시지

body

tot_CNT

전체 글 갯수

board_IDX

글 번호

svc_ID

서비스 아이디

board_TITLE

글 제목

board_CONTENT

글 내용

hit

조회 수

reg_ID

등록자

reg_DT

등록일

mod_ID

수정자

mod_DT

수정일

file_PATH

첨부 파일 경로

file_NAME

원본 첨부 파일명

file_SAVE_NAME

첨부 파일명