빠른 시작
QR Cake API를 사용하면 QR Cake 사용자가 자신의 계정에 있는 QR 코드를 관리할 수 있습니다.
기본 URL
https://api.qrcake.com/v1/product
인증
대시보드에서 API 키를 생성한 뒤 Authorization 헤더에 담아 보내세요.
Authorization: Bearer <API Key> Content-Type: application/json
API 키 관리 위치 대시보드 API 키.
API 요청 테스트
이 페이지에서 바로 엔드포인트를 테스트할 수 있습니다. API 키를 입력하고 엔드포인트를 선택한 뒤 실시간 응답을 확인하세요.
대화형 API 테스터
브라우저에서 선택한 QR Cake API 엔드포인트로 직접 요청을 실행하세요.
Authorization: Bearer <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 코드를 나열합니다.
경로: /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": {}
}제품 = QR 코드
GET
QR 코드 조회
하나의 QR 코드를 가져옵니다.
경로: /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
URL: https://api.qrcake.com/v1/product/product
요청 세부정보
헤더
Authorization: Bearer <API Key>Content-Type: application/jsonAccept: 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/{productId}
URL: https://api.qrcake.com/v1/product/product/{productId}
요청 세부정보
경로 매개변수
- productId (string)
헤더
Authorization: Bearer <API Key>Content-Type: application/jsonAccept: 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 코드를 삭제합니다.
경로: /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 키에 부여된 권한을 반환합니다.
경로: /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 코드를 먼저 살펴보세요.