동적 QR 코드 API 문서 | QR Cake

QR Cake API로 동적 QR 코드를 만들고, 업데이트하고, 관리해 보세요. API 키 발급부터 요청 테스트, 워크플로 연동까지 한 페이지에서 안내해 드려요.

JSON REST API동적 QR 생성Bearer 인증

빠른 시작

QR Cake API를 사용하면 QR Cake 사용자가 자신의 계정에 있는 QR 코드를 직접 관리할 수 있어요.

기본 URL

https://api.qrcake.com/v1/product

엔드포인트

/user/product

/product/{productId}

/product

/product/{productId}

/product/{productId}

/permission

인증

대시보드에서 API 키를 만든 뒤 Authorization 헤더에 담아 보내 주세요.

Authorization: Bearer <API Key>
Content-Type: application/json

API 키 관리: 대시보드 API 키.

API 요청 테스터

이 페이지에서 바로 엔드포인트를 테스트해 볼 수 있어요. API 키를 입력하고 엔드포인트를 골라서 실시간 응답을 확인해 보세요.

API 인터랙티브 테스터

브라우저에서 선택한 QR Cake API 엔드포인트로 바로 요청을 보내 볼 수 있어요.

GET

엔드포인트

API 키

Authorization: Bearer YOUR_API_KEY

최종 URL

https://api.qrcake.com/v1/product/user/product

요청을 실행하면 응답 상태와 결과가 여기에 표시돼요.

용어

제품

QR 코드

사용자

QR Cake 계정

요청 본문 (POST/PUT)

POST와 PUT 요청은 본문을 문자열로 직렬화해서 보내야 해요. JSON을 보낸다면 JSON 문자열로 전달해 주세요 (예: JSON.stringify(payload)).

const payload = { redirect: "https://example.com", metadata: {} };

await fetch(url, {
  method: "POST",
  body: JSON.stringify(payload),
});

GET

QR 코드 목록 조회

이 API 키로 접근할 수 있는 QR 코드를 모두 보여줘요.

GitBook에서 열기

경로: /user/product

URL: https://api.qrcake.com/v1/product/user/product

요청 세부 정보

헤더

Authorization: Bearer <API Key>
Accept: application/json

응답

200 OK

[
  {
    "accountId": "string",
    "productId": "string",
    "userId": "string",
    "redirect": "string",
    "state": "ACTIVE",
    "metadata": {},
    "createdAt": 0,
    "updatedAt": 0
  }
]

401 Unauthorized

{
  "message": {}
}

Products = QR 코드예요.

GET

QR 코드 단일 조회

QR 코드 하나를 가져와요.

GitBook에서 열기

경로: /product/{productId}

URL: https://api.qrcake.com/v1/product/product/{productId}

요청 세부 정보

경로 파라미터

productId (string)

헤더

Authorization: Bearer <API Key>
Accept: application/json

응답

200 OK

{
  "accountId": "string",
  "productId": "string",
  "userId": "string",
  "redirect": "string",
  "state": "ACTIVE",
  "metadata": {},
  "createdAt": 0,
  "updatedAt": 0
}

401 Unauthorized

{
  "message": {}
}

POST

QR 코드 생성

새 QR 코드(Product)를 만들어요.

GitBook에서 열기

경로: /product

URL: https://api.qrcake.com/v1/product/product

요청 세부 정보

헤더

Authorization: Bearer <API Key>
Content-Type: application/json
Accept: application/json

본문 템플릿

{
  "redirect": "https://example.com",
  "metadata": {},
  "state": "ACTIVE"
}

응답

200 OK

{
  "accountId": "string",
  "productId": "string",
  "userId": "string",
  "redirect": "string",
  "state": "ACTIVE",
  "metadata": {},
  "createdAt": 0,
  "updatedAt": 0
}

401 Unauthorized

{
  "message": {}
}

POST 요청 본문은 문자열로 직렬화해 주세요 (예: JSON.stringify(payload)).

PUT

QR 코드 업데이트

기존 QR 코드(Product)를 업데이트해요.

GitBook에서 열기

경로: /product/{productId}

URL: https://api.qrcake.com/v1/product/product/{productId}

요청 세부 정보

경로 파라미터

productId (string)

헤더

Authorization: Bearer <API Key>
Content-Type: application/json
Accept: application/json

본문 템플릿

{
  "redirect": "https://example.com",
  "metadata": {},
  "state": "ACTIVE"
}

응답

200 OK

{
  "accountId": "string",
  "productId": "string",
  "userId": "string",
  "redirect": "string",
  "state": "ACTIVE",
  "metadata": {},
  "expiresAt": 0,
  "createdAt": 0,
  "updatedAt": 0
}

401 Unauthorized

{
  "message": {}
}

PUT 요청 본문은 문자열로 직렬화해 주세요.

DELETE

QR 코드 삭제

QR 코드를 삭제해요.

GitBook에서 열기

경로: /product/{productId}

URL: https://api.qrcake.com/v1/product/product/{productId}

요청 세부 정보

경로 파라미터

productId (string)

헤더

Authorization: Bearer <API Key>
Accept: application/json

응답

200 OK

{
  "productId": "string"
}

401 Unauthorized

{
  "message": {}
}

GET

권한

이 API 키에 부여된 권한을 돌려줘요.

GitBook에서 열기

경로: /permission

URL: https://api.qrcake.com/v1/product/permission

요청 세부 정보

헤더

Authorization: Bearer <API Key>
Accept: application/json

응답

200 OK

{
  "success": true,
  "result": {
    "analytics": true,
    "productLimit": 100,
    "tier": "subscriber",
    "productTotal": 3,
    "productActiveLimit": 100,
    "productActiveTotal": 3
  }
}

401 Unauthorized

{
  "message": {}
}

지원되는 QR 유형

QR 제품을 만들거나 업데이트할 때 아래 메타데이터 유형을 사용해 주세요.

redirect, link, image, video, file, pdf, audio, app, event, vCard

홈페이지에서 동적 QR 코드와 변경 가능한 QR 코드부터 시작해 보세요.