충전 코드

메서드, 요청 필드 및 응답입니다.

전체 가이드

이 섹션에는 메서드가 2개 있습니다. 메서드를 열어 접근 조건, 요청 필드 및 응답을 확인하세요.

메서드와 경로	설명	접근
`POST /api/v1/redeem`	코드 사용	대시보드 토큰
`GET /api/v1/redeem/history`	코드 사용 내역	대시보드 토큰

POST /api/v1/redeem — 코드 사용

접근: 대시보드 토큰

POST/api/v1/redeem

JSON / 폼 필드

필드	타입	필수	검증 / 설명
`code`	`string`	예	required

요청 본문 템플릿

{
  "code": "PLACEHOLDER_CODE (string)"
}

PLACEHOLDER는 사용자의 입력과 그 타입을 나타냅니다. 값을 바꾸고 필요한 선택 필드만 남기세요. 숫자, boolean, 객체 또는 배열 대신 문자열 표식을 보내면 안 됩니다.

요청 스키마: RedeemRequest

응답

JSON 응답에는 code, message, data가 포함됩니다. data 내용은 아래 스키마를 참고하세요.

응답 데이터 스키마: RedeemCode. 필드와 유형은 «데이터 스키마» 페이지에서 확인하세요.

응답 스키마, 예시 값

{
  "code": 0,
  "message": "success",
  "data": {
    "id": "PLACEHOLDER_ID (integer)",
    "code": "PLACEHOLDER_CODE (string)",
    "type": "PLACEHOLDER_TYPE (string)",
    "value": "PLACEHOLDER_VALUE (number)",
    "status": "PLACEHOLDER_STATUS (string)",
    "used_by": "PLACEHOLDER_USED_BY (integer)",
    "used_at": "PLACEHOLDER_USED_AT (string)",
    "created_at": "PLACEHOLDER_CREATED_AT (string)",
    "expires_at": "PLACEHOLDER_EXPIRES_AT (string)",
    "validity_days": "PLACEHOLDER_VALIDITY_DAYS (integer)",
    "notes": "PLACEHOLDER_NOTES (string)",
    "user": "PLACEHOLDER_USER (object)"
  }
}

특이 사항: 모든 개인정보와 객체는 JWT의 주체로 범위가 제한됩니다.

특이 사항: 상태를 변경하거나 일회성 인증을 이어가는 작업입니다. 예제는 규약을 설명하며 실행되지 않습니다.

GET /api/v1/redeem/history — 코드 사용 내역

접근: 대시보드 토큰

GET/api/v1/redeem/history

읽기 작업입니다. ID는 이전 응답에서 가져옵니다

curl --fail-with-body "https://ailoot.ai/api/v1/redeem/history" \
  -H "Authorization: Bearer $TOKEN"

쿼리 매개변수

필드	타입	필수	검증 / 설명
`page`	`integer`	아니요	; 기본값: 1; positive integer
`page_size`	`integer`	아니요	; 기본값: 20; positive; clamp to100

요청 본문은 필요하지 않습니다. 위 매개변수를 URL에 전달하세요.

응답

JSON 응답에는 code, message, data가 포함됩니다. data 내용은 아래 스키마를 참고하세요.

응답 데이터 스키마: RedeemCode. 필드와 유형은 «데이터 스키마» 페이지에서 확인하세요.

응답 스키마, 예시 값

{
  "code": 0,
  "message": "success",
  "data": {
    "items": [
      {
        "id": "PLACEHOLDER_ID (integer)",
        "code": "PLACEHOLDER_CODE (string)",
        "type": "PLACEHOLDER_TYPE (string)",
        "value": "PLACEHOLDER_VALUE (number)",
        "status": "PLACEHOLDER_STATUS (string)",
        "used_by": "PLACEHOLDER_USED_BY (integer)",
        "used_at": "PLACEHOLDER_USED_AT (string)",
        "created_at": "PLACEHOLDER_CREATED_AT (string)",
        "expires_at": "PLACEHOLDER_EXPIRES_AT (string)",
        "validity_days": "PLACEHOLDER_VALIDITY_DAYS (integer)",
        "notes": "PLACEHOLDER_NOTES (string)",
        "user": "PLACEHOLDER_USER (object)"
      }
    ],
    "total": "PLACEHOLDER_TOTAL (integer)",
    "page": "PLACEHOLDER_PAGE (integer)",
    "page_size": "PLACEHOLDER_PAGE_SIZE (integer)",
    "pages": "PLACEHOLDER_PAGES (integer)"
  }
}

특이 사항: 모든 개인정보와 객체는 JWT의 주체로 범위가 제한됩니다.

궁금한 점이 남았나요? Request ID와 설명을 보내 주시면 해결을 도와드리겠습니다.지원팀에 문의