CREMA API 시작하기
CREMA API는?
CREMA API는 CREMA 서비스를 사용하기 위해 필요한 데이터를 업로드/다운로드 할 수 있는 방법을 제공합니다. HTTP/1.1을 사용하며 REST API의 규약을 따르기 때문에 HTTP가 지원되는 모든 종류의 플랫폼/언어를 사용할 수 있습니다.
CREMA API 사용하기
모든 API 요청은 api.cre.ma Host 를 통해 이루어지며, 승인 토큰 (access_token) 이 필요합니다. 승인 토큰 또한 api.cre.ma 에 요청하여 발급받으실 수 있습니다. 승인 토큰 (access_token) 을 얻는 방법은 '인증 (OAuth)'에 자세히 설명 되어있습니다.
CREMA API 용어
| 용어 | 설명 |
|---|---|
code |
쇼핑몰에서 사용하는 ID와 CREMA에서 사용하는 ID를 구분하기 위해 쇼핑몰의 ID는 code, CREMA의 ID는 id라고 지칭합니다. |
API 목록
CREMA API가 지원하는 API 목록은 다음과 같습니다.
| API명 | 설명 | 필수 |
|---|---|---|
| User API | 쇼핑몰의 회원을 CREMA 서버에 등록하거나 읽어오기 위한 API입니다. | ✔ |
| UserGrade API | 쇼핑몰의 회원등급을 CREMA 서버에 등록하거나 읽어오기 위한 API입니다. | |
| Category API | 쇼핑몰의 카테고리를 CREMA 서버에 등록하거나 읽어오기 위한 API입니다. | ✔ |
| Product API | 쇼핑몰의 상품을 CREMA 서버에 등록하거나 읽어오기 위한 API입니다. | ✔ |
| CartItem API | 쇼핑몰의 장바구니를 CREMA 서버에 등록하거나 읽어오기 위한 API입니다. | |
| UserCoupon API | 쇼핑몰의 회원쿠폰을 CREMA 서버에 등록하거나 읽어오기 위한 API입니다. | |
| Order API | 쇼핑몰의 주문을 CREMA 서버에 등록하거나 읽어오기 위한 API입니다. | ✔ |
| SubOrder API | 쇼핑몰의 주문상품을 CREMA 서버에 등록하거나 읽어오기 위한 API입니다. | ✔ |
| UnpaidOrder API | 쇼핑몰의 미입금 무통장 주문을 CREMA 서버에 등록하거나 읽어오기 위한 API입니다. | |
| Review API | 쇼핑몰의 리뷰를 CREMA 서버에 등록하거나 읽어오기 위한 API입니다. | |
| Comment API | 쇼핑몰의 댓글을 CREMA 서버에 등록하거나 읽어오기 위한 API입니다. | |
| Mileage API | 적립금 지급을 연동하기 위한 API입니다. | ✔ |
| SubBrand API | 쇼핑몰의 하위 브랜드를 CREMA 서버에 등록하거나 읽어오기 위한 API입니다. | |
| FitProduct API | 쇼핑몰 핏 상품의 실측 치수, 정보, 속성을 CREMA 서버에 등록하거나 읽어오기 위한 API입니다. | |
| FitSizeRecommendation API | 고객정보에 적합한 추천 사이즈를 읽어오기 위한 API입니다. |
CREMA API 문의 양식
아래 3가지를 첨부하여 문의해주세요.
- 요청 url 전문
- 요청 시각
- 응답 결과
예시:
1. 요청 url 전문
GET http://api.cre.ma/v1/sub_orders?code=a1&order_code=2022050392065
2. 요청 시각
2022-09-30 00:00:00
3. 응답 결과(response의 body를 통해 확인 가능)
{
"code": 4004000,
"message": "Sub order for {\\"code\\"=>\\"a2\\", \\"product_code\\"=>\\"123\\", \\"price\\"=>52130.0, \\"product_count\\"=>1, \\"delivery_started_at\\"=>\\"2022-05-03T09:27:18\\", \\"delivered_at\\"=>\\"2022-05-03T09:27:29\\", \\"invoice\\"=>\\"1234\\", \\"delivery_service\\"=>34, \\"order_status\\"=>110} already exists. It belongs to order_code: 2022051092158, product_code: 123."
}
각종 사유로 응답 결과를 못 받으셨을 때에는 다음 항목을 입력하여 문의해주세요.
- 응답 결과를 못 받은 상황 설명
- 요청 URL 전문
- 요청 시각
- 응답 결과
주소 안내
- https://sapi.cre.ma 테스트 서버
- https://api.cre.ma 라이브 서버
api 개발 문서 주소(dev.cre.ma)로 요청하는 경우가 있습니다.
dev.cre.ma가 아니라 api.cre.ma가 api 주소입니다
데이터 동기화 안내
CREMA Review를 쇼핑몰에 적용하기 전 아래 요구사항에 맞춰서 데이터 동기화가 되어있어야 합니다.
CREMA API 를 이용해 데이터 동기화를 진행해주세요.
API로 기존 데이터를 동기화해주시면 데이터 연동 검수를 한번에 완료할 수 있어 설치 절차가 빠르게 진행됩니다.
- 상품 데이터 전체 동기화
- 주문 데이터 최근 1개월 분 동기화
- 리뷰 데이터 전체 동기화
참고사항
- API 구현 후 정상작동 유무 확인이 필요할 경우 담당자에게 문의바랍니다.
- 모든 API에는
access_token인자가 필요합니다. 없을 경우401 Unauthorized가 반환됩니다. -
access_token유효시간 60일이 지나면 그 후에도401 Unauthorized가 반환됩니다. 이 경우에는 Token을 다시 발급받아주세요. - 업데이트 요청시
PATCH대신PUT메소드도 사용 가능하지만,PATCH메소드를 권장합니다. - 제휴사의 경우 요청하는 쇼핑몰을 특정하기 위해
brand_id인자를 추가해주세요.