HTTP Request Header 공통 파라미터

User API를 사용하기 위해 HTTP Request Header 에 공통적으로 사용하는 값 들 입니다.

Authorization [Required] : String
- 토큰 발급 API 를 통해 부여받은 토큰
- 형태 : “Bearer xxxxxx…”
- 인증이 필요한 모든 API 들에 대해 필수입니다. 토큰 발급, 토큰 갱신 API 에서는 사용하지 않습니다.
merchant_id [Required] : String
- token의 key type이 CHANNEL 인 경우 필수
- 토큰 발급, 토큰 갱신 API 에서는 사용하지 않습니다
trace_id : String
- API 이슈 트래킹을 위한 트랜잭션 식별 아이디. 100자 이내의 임의 스트링값으로 구성됩니다. (UUID)

Response Body 형태

{
    "status": {
        "code": "SUCCESS",
        "message": "success",
        "extra_message": null,
        "trace_id": "5aa2ca3f-0685-4a61-9b29-756636fce6c3"
    },
    "data": {
    }
}

status : 요청 처리 결과(상태)들이 담겨집니다. (응답코드표 링크)
- code : 요청 결과 코드 (성공 / 실패 코드)
  - Ex. 성공 : SUCCESS / 실패 : INVALID_PARAMETER
- message : 요청 결과 코드 에 따른 메시지
  - Ex. Invalid Parameter
- extra_message : message 필드에서 표현 하지 못한 추가적인 메시지
  - 개발자가 직접 입력하거나, 외부 연동 기관의 실패 메시지, 유효하지 못한 필드명 등이 표현 될 수 있습니다.
  - Ex. amount is required
- trace_id : 하나의 요청에 대해 처리 내용(로그 등)들을 추적 할 수 있는 Id
  - 이슈 추적등의 용도로 사용됩니다.
data : 요청 내용에 대한 데이터들이 담겨집니다
- Pagination 이 있는 List 조회의 경우 data 객체 안에 페이징 객체(pagination)를 포함하여 리턴합니다.
  - offset : 목록의 시작 위치
  - limit : 목록당 데이터의 최대 수
  - total : 데이터 목록에 있는 항목의 총 수
  - count : 현재 페이지에서 반환된 항목의 수

⭕ SUCCESS

// Case 1
{
    "status": {
        "code": "SUCCESS", 
        "message": "success",  
        "extra_message": null,
        "trace_id": "798fe30d-e3a6-4b1a-8fd6-3210aa6f8001"
    },
    "data": null
}

// Case 2
{
    "status": {
        "code": "SUCCESS", 
        "message": "success",  
        "extra_message": null,
        "trace_id": "798fe30d-e3a6-4b1a-8fd6-3210aa6f8002"
    },
    "data": {
      ...
    }
}

// Case 3
{ 
  "status": {
          "code": "SUCCESS", 
          "message": "success",  
          "extra_message": null,
          "trace_id": "798fe30d-e3a6-4b1a-8fd6-3210aa6f8002"
  },
  "data": {
      "xxxx": [],
      "pagination": {
            "offset": 0,
            "limit": 10,
            "total": 41,
            "count": 10
      }
  }
}

❌ Failure

{
    "status": {
        "code": "INVALID_PARAMETER",
        "message": "invalid parameter.",
        "extra_message":"parameter: id",
        "trace_id": "798fe30d-e3a6-4b1a-8fd6-3210aa6f8003"
    },
    "data": null
}