Tapplace API v1.2.1

API 주소

개발 : https://api.tapplace.cloud

노션 주소 : https://dev159.notion.site/Tapplace-API-v1-2-1-59bc730670154642983ed37b12443f97

변경사항

• 1.1.1 → 1.1.2
  1. 피드백 횟수 카운트 서버로 이전, 피드백 횟수 5회로 증가
  2. PATCH /pay/feedback 수정 ( 입력값에 ‘user_id’ 추가, 리턴값에 ‘remain_count’ 추가)
  3. GET /feedback-count/:user_id 추가 ( user_id별 금일 남은 피드백 횟수 리턴 )
  4. pay_list 테이블 삭제, feedback_count 테이블 생성
• 1.1.2 → 1.2
  1. pay별 테이블 삭제 → ‘pay’테이블로 데이터 통합
  2. POST /store/around 속도개선
  3. 회원 성별, 나이, token 선택적으로 입력가능
  4. POST /user 입력값에 ‘personal_date’ , ‘service_date’ 추가 (회원 초기설정시 GET /terms 리턴 데이터 입력)
  5. POST /user 입력값에 ‘marketing_agree’ 추가 (true or false)
  6. PATCH /user/pays → PATCH /user/:user_id 로 변경 ( 회원정보 수정 - 유저 마케팅 동의여부는 수정 x )
  7. PATCH /user/marketing 추가 (유저 마케팅 동의여부 수정)
  8. POST /userlog 리턴값에 최신약관확인 추가
  9. 피드백 테이블 ‘feedback’ 추가 - 유저별 피드백 데이터 서버 저장
  10. 즐겨찾기 테이블 ‘bookmark’ 추가 - 유저별 즐겨찾기 서버 저장
  11. POST /pay/list , /pay/list/check 입력값에 user_id 추가, 리턴값에 북마크인지 확인하는 ‘isBookmark’ 추가
  12. qna, notice 페이징시 마지막 페이지 체크하는 ‘isEnd’ 추가
  13. qna, notice, bookmark, feedback 페이징시 한 페이지당 20개씩 노출
  14. 북마크 최대 등록개수 60개로설정
  15. 기존 true 리턴값 → statuscode,messgae로 변경 9/23 변경사항
  16. POST /store/around 입력값 user_id 추가, 리턴값에 isBookmark 추가 ( 웹페이지는 user_id 공백으로 입력시 리턴값에 isBookmark 항목 없이 리턴)
  17. (웹)POST /pay/list , /pay/list/check 입력값에 user_id 공백으로 입력시 리턴값에 isBookmark 항목 없이 리턴
• 1.2 → 1.2.1
  1. GET feedback/bookmark/:user_id(더보기) 리턴값에 남은 피드백 횟수 추가
  2. qna 테이블 store_id, answer 컬럼 추가 (기존 스토어 정보에서 수정제안시 식별할 수 있는 store_id 없었음) qna 삭제, 수정 삭제, qna 유저별 목록 불러오기 추가
  3. birth 포맷 yyyy-MM-dd 형식 검사 추가
  4. 유저 정보 가져오기 추가
  5. (admin) 마케팅 동의한 유저들 토큰목록 api 추가 ( 관리자 api 아직 업데이트 x, 추후 다듬고 postman이랑 같이 배포예정 )
  6. key값 jwt로 대체

Pay 리스트 (= ~pay 테이블명)

1. kakaopay
2. naverpay
3. payco
4. zeropay
5. apple_visa
6. apple_master
7. apple_jcb
8. conless_visa (contactless)
9. conless_master
10. conless_amex (american express)
11. conless_union
12. conless_jcb
13. google_visa
14. google_master
15. google_maestro
16. toss

화면 별 API

화면1) 최초실행

화면2) 설정

화면3) 주변찾기

화면4) 주변찾기 - 가게선택

화면5) 등록 - 가게선택

화면6) 피드백

화면7) 공지사항

화면8) 문의하기

화면9) 더보기

화면10) 즐겨찾기

화면11) 피드백 목록

API 목록

Method	Endpoint		Request body	Return	When to use	구현 현황
POST	/user	Authorization : Bearer JWT	{ user(T),}	ok or ERROR	최초 설정	O
GET	/user/:user_id	Authorization : Bearer JWT		{ user(T) }	유저 정보 가져오기	O
PATCH	/user/:user_id	Authorization : Bearer JWT	{ user(T)}	true or ERROR	유저 정보수정 (마케팅정보 수정x)	O
PATCH	/user/drop	Authorization : Bearer JWT	{ user_id}	ok or ERROR	회원탈퇴	O
PATCH	/user/marketing	Authorization : Bearer JWT	{ user_id, marketing_agree}	ok or ERROR	마케팅 동의여부 수정	O
POST	/userlog	Authorization : Bearer JWT	{ user_id}	{ terms(T) } - true or false	어플 실행 / 유저정보가 최신 약관과 동일한지 여부	O
POST	/store/around		{ x1, y1, distance, pays[ ] }	{ stores[ ] }	주변 찾기	O
GET	/store/:store_id			{ store(T) }	store_id에 맞는 store 가져옴 ( 공유하기 할때 meta데이터 표시용)	O
POST	/pay/list		{ store_id, pays[ ], user_id }	{ store(T), feedback[ ] }	주변 찾기 → 가게 선택	O
POST	/pay/list/check		{ store(T), pays[ ], user_id }	{ feedback[ ] }	등록 → 가게 선택	O
POST	/pay/list/more		{ store_id, pays[ ] }	{ feedback[ ] }	피드백 → 결제수단 더보기	O
PATCH	/pay/feedback	Authorization : Bearer JWT	{ store_id, user_feedback[ ], user_id }	{ feedback_result [ ], remain_count }	주변 찾기 & 등록→ 가게 선택 → 피드백	O
GET	/notice/:category1/:category2/:page			{ total_count, notice [ ] }	공지사항/자주하는 질문	O
GET	/qna/:user_id/:page	Authorization : Bearer JWT		{ total_count, qna [ ] }	문의하기 목록	O
POST	/qna	Authorization : Bearer JWT	{ qna(T) }	ok or ERROR	문의하기 등록	O
GET	/feedback-count/:user_id			{ remain_count }	나도 피드백하기 클릭	O
GET	/feedback/:user_id/:page	Authorization : Bearer JWT		{ total_count, isEnd, feedbacks[ feedback(T) ] }	피드백 목록보기	O
GET	/feedback/bookmark/:user_id			{ bookmark_count, feedback_count }	더보기에서 즐겨찾기, 피드백 갯수 표시	O
POST	/bookmark	Authorization : Bearer JWT	{ user_id, store_id }	ok or ERROR	즐겨찾기 등록	O
GET	/bookmark/:user_id/:page	Authorization : Bearer JWT		{ total_count, isEnd, bookmarks[ store(T) ] }	즐겨찾기 불러오기	O
DELETE	/bookmark	Authorization : Bearer JWT	{ user_id, store_id }	ok or ERROR	즐겨찾기 삭제	O
GET	/terms			{ terms(T) }	최신 약관일자 받아옴	O

관리자 API 목록

Method	Endpoint	Request body	header	Return	When to use	구현 현황
POST	/admin/login	{ admin_id, password }		JWT	관리자 로그인	O
POST	/admin/signup	{ admin_id, password, role }	Authorization : Bearer JWT	true or ERROR	관리자 등록	O
POST	/terms	{ personal_date, service_date }	Authorization : Bearer JWT	true or ERROR	약관 날짜 등록	O
GET	/terms/:num		Authorization : Bearer JWT	{ terms(T) }	특정 약관 날짜 가져오기	O
PATCH	/terms/:num	{ terms(T) } ( terms(T) 중 수정하고 싶은 컬럼만 넣으면 됨 )	Authorization : Bearer JWT	true or ERROR	특정 약관 날짜 수정	O
DELETE	/terms/:num		Authorization : Bearer JWT	true or ERROR	특정 약관 날짜 삭제	O
POST	/notice	{ title, content, category1, category2 }	Authorization : Bearer JWT	true or ERROR	글 등록	O
PATCH	/notice/:num	{ notice(T) } ( notice(T) 중 수정하고 싶은 컬럼만 넣으면 됨 )	Authorization : Bearer JWT	true or ERROR	특정 글 수정	O
DELETE	/notice/:num		Authorization : Bearer JWT	true or ERROR	특정 글 삭제	O

API 전달 값

이름	설명	예시
테이블명(T)	테이블명의 컬럼이 전부 포함된 값(num과 기본값이 있는 컬럼 제외)	user(T) = user_id, os, birth, pays
ex) { user(T) } = { user_id, os, birth, pays }
paylist[ ]	pay_list 테이블의 데이터 전부 담은 배열	paylist : [ ”apple_visa”, “apple_master”, “kakaopay” ….. ]
true or ERROR	요청 성공 시 true 리턴 , 실패시 ERROR 발생
stores[ ]		stores : [ { store(T), distance, pays[ ] }… ]
pays[ ]	pay_list 테이블 데이터 중 일부를 담은 배열	pays : [ ”apple_visa”, “payco” ]
distance	주변 찾기 시 반경으로 설정된 값 (number)	distance : 1.5 (반경이 1.5km로 설정되었을 때)
x1, y1	주변 찾기 시 사용자 현재 위치 값
feedback[ ]	해당 store의 pay별 feedback 현황	feedback : [ { pay(T), pay, exist }(feedback 결과가 있는 pay), { pay, exist }(feedback 결과가 없는 pay) ]
user_feedback[ ]	feedback시 pay별 pay, exist, feed를 담은 값	feedbacks : [ { “pay” : “apple_visa”, “exist” : false, “feed” :true }, { “pay” : “naverpay”, “exist” : true, “feed” : false } ... ]
exist	pay종류 별 기존 데이터가 존재하는지 여부값 [ true, false ]	exist : true = 기존 데이터 있음 ( pay(T)의 데이터 그대로 쓰면 됨) exist : false = 기존 데이터 없음
feed	피드백시 success(true)또는 fail(false) 여부 값 [ true, false ]	feed : true = DB success +1 fail : false = DB fail +1
feedback_result	피드백 후 결과값	feedback_result : [ { “pay” : “naverpay”, “success”:10, “fail” : 2, “last_state” : “success } … ]
:category1 (notice)	notice - 공지사항, faq - 자주 묻는 질문	/notice/qna/:category2/:page
:category2 (notice)	all - category2 전부, 현재는 category2 가 정해진게 없어서 all로만 가능	/notice/:category1/all/:page
:page	한 화면에 표시될 페이지, 현재 1페이지당 10개로 설정. page 1 이면 1-10번 게시물, 2이면 11-20번 게시물	/notice/:category1/:category2/1
total_count	category1,category2 조건에 맞는 총 게시글 수	total_count : “12”
notice[ ]	category1,category2,page 조건에 맞는 notice(T)	notice : [ { “num” : 1, “title” : “공지사항1”, “content” : “지사항 내용”, “wriete_date” : “2022-09-04 06:40:30”, “category1” : “notice”, “category2” : “” } … ]
category (qna)	qna - 문의하기, edit - 수정제안, all - 답변, 미답변 전부	/qna/edit/:answer_check/:page
answer_check	false 또는 0 - 미답변, true 또는 1 - 답변완료, all - 답변,미답변 전부	/qna/:category/true/:page
qna[ ]	category,answer_check,page 조건에 맞는 qna(T)	qna : [ {"num": 6,"user_id": "11","category": "edit","title":"문의사항입니다3", "content": "답변부탁드려요","write_date": "2022-09-13 08:24:35","answer_check": 1,"email": "tlqhrm@naver.com", "os": "android" } …]
remain_count	금일 남은 피드백 횟수	remain_count : 5
idEnd	페이징에서 마지막 페이지 인지	isEnd : boolean
isBookmark	등록된 북마크인지 확인	isBookmark : boolean
나머지	DB 컬럼의 이름에 맞는 값

DB 구성

store 테이블

컬럼	특성	설명
num	number, 기본키	자동으로 증가 되는 PK용 인조키
store_id	string, 유니크키	카카오 검색 API 호출 시 반환 되는 “id” 값
place_name	string	카카오 검색 API 호출 시 반환 되는 “place_name” 값
address_name	string	카카오 검색 API 호출 시 반환 되는 “address_name” 값
road_address_name	string	카카오 검색 API 호출 시 반환 되는 “road_address_name” 값
category_group_name	string	카카오 검색 API 호출 시 반환 되는 “category_group_name” 값
x	string	카카오 검색 API 호출 시 반환 되는 “x” 값
y	string	카카오 검색 API 호출 시 반환 되는 “y” 값
phone	string	카카오 검색 API 호출 시 반환 되는 “phone” 값

pay 테이블

컬럼	특성	설명
num	number, 기본키	자동으로 증가 되는 PK용 인조키
store_id	string, 외래키, 유니크키	store 테이블의 store_id 참조
success	number, 기본 값 : 0	결제 성공 피드백 값
fail	number, 기본 값 : 0	결제 실패 피드백 값
last_state	string, 값 [ ‘success’, ‘fail’ ]	마지막으로 피드백 된 상태
last_time	string	마지막으로 피드백 된 시간
pay	string	pay 종류

feedback_count 테이블

컬럼	특성	설명
num	number, 기본키	자동으로 증가 되는 PK용 인조키
user_id	string	유저 아이디
count	number	금일 피드백 횟수

user 테이블

컬럼	특성	설명
num	number, 기본키	자동으로 증가 되는 PK용 인조키
user_id	string, 유니크키	사용자 기기 고유 id
os	string, 값 [ ‘android’, ‘ios’ ]	사용자 운영체제
birth	string, 값 [ ‘yyyyMMdd’ ]	사용자 생년월일
sex	string, 값 [ ‘남’, ‘여’ ]	사용자 성별
pays	string	사용자 설정 pay종류
service_date	string, 값 [ ‘yyyy-MM-dd’ ]	서비스 동의 날짜
personal_date	string, 값 [ ‘yyyy-MM-dd’ ]	개인정보 동의날짜
marketing_date	string, 값 [ ‘yyyy-MM-dd’ ]	마케팅 동의날짜
marketing_agree	boolean	마케팅 동의여부

user_log 테이블

컬럼	특성	설명
num	number, 기본키	자동으로 증가 되는 PK용 인조키
user_id	string, 외래키	user 테이블 user_id 참조
time	string	접속 시간

notice 테이블

컬럼	특성	설명
num	number, 기본키	자동으로 증가 되는 PK용 인조키
title	string	글 제목
content	string	글 내용
write_date	string	글 작성일
category1	string, 값 [ ‘notice’, ‘faq’ ]	공지사항, 자주 하는 질문
category2	string, 값 [ ‘all’ ]	현재는 all 만 가능

terms 테이블

컬럼	특성	설명
num	number, 기본키	자동으로 증가 되는 PK용 인조키
personal_date	string	개인정보 이용동의 날짜
service_date	string	서비스 이용약관 날짜
regist_date	string	등록 일자

admin 테이블

컬럼	특성	설명
num	number, 기본키	자동으로 증가 되는 PK용 인조키
admin_id	string, 유니크키	관리자 id
password	string	비밀번호
role	string, 값 [ ‘admin’ ]	권한
regist_date	string	등록 일자

qna 테이블

컬럼	특성	설명
num	number, 기본키	자동으로 증가 되는 PK용 인조키
title	string	글 제목
content	string	글 내용
write_date	string	글 작성일
user_id	string	사용자 기기 고유id
category	string, 값 [ ‘qna’, ‘edit’ ]	qna : 문의하기 , edit : 수정제안
email	string	답변 받을 이메일
os	string	유저 os
answer_check	boolean, 기본값 : false(0)	true(1) : 답변완료, false(0) : 답변대기중
store_id	string	수정제안에 사용되는 store_id
answer	string	문의 답변

bookmark 테이블

컬럼	특성	설명
num	number, 기본키	자동으로 증가 되는 PK용 인조키
user_id	string	사용자 기기 고유 id
store_id	string	store 고유 id
date	string	등록 날짜

feedback 테이블

컬럼	특성	설명
num	number, 기본키	자동으로 증가 되는 PK용 인조키
user_id	string	사용자 기기 고유 id
store_id	string	store 고유 id
date	string	등록 날짜
feedback	string	유저 feddback 정보