Domain
Live
api.pod.shop
Dev
dev-api.pod.shop
HTTP Protocol
API는 HTTPS로 호출해야 합니다.
HTTPS는 HTTP의 보안(Secured)버전입니다.
HTTP로 주고 받는 데이터는 암호화되지 않은 평문(plaintext)이기 때문에 개인 정보가 유출될 수 있습니다.
따라서 고객의 결제 정보와 개인 정보를 보호하는 보안을 강화한 프로토콜인 HTTPS를 사용해야 합니다.
Response
Response type
API의 성공 여부는 HTTP 상태 코드로 전달합니다.
돌아온 HTTP 상태 코드에 따라 요청이나 에러를 처리하는 로직을 구축하세요.
Content-Type: application/json
Plain Text
복사
공통
•
목록 API 의 Parameter 중 pageNo는 index를 의미합니다
→ 1 Page 조회 : pageNo = 0
•
목록(LIST) API Response 의 경우 Response Header에 전체 Row 수를 포함 합니다
x-total-count : 176
JSON
복사
에러 객체
일반 오류
요청이 정상적으로 처리되지 않으면 응답으로 HTTP 상태 코드와 함께 아래와 같은 에러 객체가 돌아옵니다.
{
"errorKey": "productOrderNotFound",
"title": "Not found",
"status": 404,
"detail": "Product order not found."
}
JSON
복사
•
errorKey : 오류구분
•
title : error title
•
status : http status code
•
detail : error message
{
"timestamp": "2024-01-31T01:55:03.078+00:00",
"status": 404,
"error": "Not Found",
"path": "/ac/api/external/design-templates1"
}
JSON
복사
•
timestamp : 발생시각
•
status : http status code
•
error : error message
•
path : call path
인증 오류
인증 오류시 아래와 같은 에러 객체가 돌아옵니다
{
"status": 401,
"error": "this token does not exist"
}
SQL
복사
기간 만료시 아래와 같은 에러 객체가 돌아옵니다.
{
"status": 401,
"error": "This token has expired"
}
SQL
복사
{
"errorKey": "tokenHasExpired",
"title": "Jwt Invalid",
"status": 401,
"detail": "this token has expired."
}
SQL
복사