DOC소개
워크스페이스 소유 QR 코드, 단축 링크, 페이지, 폼, GS1 링크를 중심으로 작업을 구축하세요. API에도 사용자 센터와 동일한 소유권 검사, 입력 검증 및 할당량이 적용됩니다. 일괄 자동화 전에 테스트 자산 하나부터 시작하세요.
기본 URL
https://qrcodetransfer.com/api/v1/데이터는 비공개로 유지되며 요청마다 워크스페이스와 사용자 또는 API 키 권한을 확인합니다.
AUTH인증
API 지원 요금제에서는 키를 만들고 서버에 보관하세요. 각 키는 하나의 워크스페이스에 속하며 읽기 또는 쓰기 범위를 갖습니다.
Authorization: Bearer YOUR_API_KEYQRQR 코드
동적 코드는 목적지를 바꿔도 인쇄 주소를 유지합니다. 정적 코드는 원본 내용을 직접 저장하여 목적지를 변경할 수 없습니다.
POST /api/v1/workspaces/WORKSPACE_ID/assets
{
"kind": "QRCODE",
"name": "Spring campaign",
"payload": {
"type": "LINK",
"url": "https://example.com/campaign",
"dynamic": true
}
}PDFPDF 코드
PDF를 먼저 업로드하고 파일 ID로 코드를 만드세요. 리소스를 업데이트할 때까지 이전 파일도 유지됩니다. 미게시 파일 다운로드에는 인증이 필요합니다.
POST /api/v1/workspaces/WORKSPACE_ID/files
Content-Type: multipart/form-data
POST /api/v1/workspaces/WORKSPACE_ID/assets
{ "kind": "QRCODE", "name": "Product guide",
"payload": { "type": "PDF", "fileId": 123, "dynamic": true } }LINK단축 링크
SHORTLINK 유형과 HTTP 또는 HTTPS 목적지로 링크를 만드세요. 맞춤 경로는 선택이며 휴지통으로 이동해도 예약이 유지됩니다.
POST /api/v1/workspaces/WORKSPACE_ID/assets
{ "kind": "SHORTLINK", "name": "Product launch",
"payload": { "url": "https://example.com/launch" } }PAGE랜딩 페이지
페이지는 초안으로 시작합니다. 제목과 링크를 추가해 게시하세요. 초안 변경은 다시 게시할 때까지 공개 버전에 반영되지 않습니다.
POST /api/v1/workspaces/WORKSPACE_ID/assets
{ "kind": "PAGE", "name": "Our links", "payload": {
"title": "Our links",
"links": [{ "label": "Website", "url": "https://example.com" }]
} }
POST /api/v1/workspaces/WORKSPACE_ID/assets/ASSET_ID/actions/publishFORM양식
각 응답은 게시된 필드 정의를 보관합니다. 필드 ID로 답변을 제출하고 멱등 키로 중복을 방지하세요. 양식을 닫아도 페이지는 남지만 새 응답은 중단됩니다.
POST /api/public/forms/FORM_SLUG/submissions
{ "answers": { "email": "[email protected]" },
"idempotencyKey": "submission-unique-id" }GS1GS1 Digital Link
제품 코드 URI에는 응용 식별자가 포함됩니다. 인쇄 전에 검증하고 소매 및 포장 흐름에서 최종 코드를 테스트하세요. 목적지를 바꿔도 제품 식별은 유지됩니다.
POST /api/v1/workspaces/WORKSPACE_ID/assets
{ "kind": "GS1", "name": "Product", "payload": {
"identifierType": "01", "identifierValue": "09506000134369",
"destinationUrl": "https://example.com/product"
} }BULK일괄 생성
일괄 생성 전 각 행을 확인하세요. 잘못된 URL과 예약 경로가 표시됩니다. 재시도할 때 같은 Idempotency-Key를 사용해 중복 생성을 방지하세요.
POST /api/v1/workspaces/WORKSPACE_ID/bulk/preview
POST /api/v1/workspaces/WORKSPACE_ID/bulk/execute
Idempotency-Key: unique-batch-id
{ "kind": "SHORTLINK", "rows": [
{ "name": "Launch", "url": "https://example.com/launch" }
] }HOOK웹훅
지원 요금제의 소유자는 Webhook을 관리할 수 있습니다. 전송을 활성화하고 설정해야 합니다. 기록에서 실제 결과를 확인할 수 있으며 엔드포인트 저장만으로 알림이 전송되지는 않습니다.
HTTP오류 및 상태
오류에는 code, message와 필드 오류가 포함됩니다. 401은 인증, 403은 권한 제한, 409는 상태·버전·경로·한도·멱등 충돌, 422는 잘못된 입력, 503은 서비스 불가입니다. 정지 또는 차단된 공개 코드는 410을 반환합니다.
MCPMCP 연동
같은 API 키로 HTTP MCP 클라이언트를 연결하세요. 상태 없는 API는 JSON과 목록, 조회, 생성, 수정, 분석 도구를 제공하며 쓰기에는 해당 권한이 필요합니다. 호스팅 클라이언트와 직접 로그인은 확인 중입니다.
POST /api/mcp
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
{ "jsonrpc": "2.0", "id": 1, "method": "tools/list", "params": {} }