GetQR API는 베타 버전이며 일부 워크스페이스에서만 사용할 수 있습니다. 정식 출시 전에 세부 사항이 변경될 수 있습니다.
시작하기 전에
- 역할. 규칙 설정, 일시 중지, 재활성화, 삭제에는 워크스페이스 QR 코드에 대한 쓰기 권한이 필요합니다. 인증을 참조하세요.
- 구독. 이 요청을 포함한 모든 API 요청에는 워크스페이스 소유자의 활성 구독이 필요합니다.
access 객체
QR 코드를 생성하거나 업데이트할 때access 객체를 보내세요.
생략한 필드는 변경되지 않습니다. 규칙을 지우려면
null을 보내세요. 일부만 담은 access 객체를 보내도 언급하지 않은 규칙은 초기화되지 않습니다.
시작과 종료 예약
activeAt과 pauseAt은 서로 독립적이므로 하나만 설정하거나 둘 다 설정할 수 있습니다. 둘 다 Z 또는 UTC 오프셋이 붙은 ISO 8601 날짜·시각을 받습니다.
null을 보내세요. QR 코드가 즉시 활성화되고 종료일이 제거됩니다.
스캔 제한
전체 스캔 횟수를 제한합니다. 한도에 도달하면 QR 코드가 더 이상 목적지로 연결되지 않습니다.- 제한을 높이면 정확히 (새 제한 − 전체 스캔 수)만큼 스캔이 더 허용됩니다.
- 제한을 낮춰 현재 합계보다 작아지면 QR 코드가 즉시 차단됩니다.
- 나중에 제한을 설정하면 제한이 없던 동안의 스캔도 계산에 포함됩니다.
scanLimit은 2147483647 이하의 양의 정수여야 합니다. 무제한으로 하려면 null을 보내세요.
비밀번호 보호
비밀번호는 같은access 객체로 설정합니다. 보호를 꺼도 저장된 비밀번호는 유지되므로 비밀번호를 다시 보내지 않고도 보호를 다시 켤 수 있습니다.
1
비밀번호 설정 또는 변경
이렇게 하면 보호도 켜집니다.
2
보호 끄기
저장된 비밀번호는 유지됩니다.
3
보호 다시 켜기
비밀번호를 다시 보낼 필요가 없습니다. 비밀번호가 한 번이라도 설정된 경우에만 작동하며, 그렇지 않으면
422를 반환합니다.- 생성 시. 보호를 켜려면
password를 보내세요. 비밀번호가 없는 동안에는passwordProtected만 보내도 효과가 없습니다. - 비밀번호 제거.
"password": null을 보내세요. 보호도 함께 꺼집니다. - 조회. 응답은 비밀번호를 반환하지 않고
access.passwordProtected만 반환합니다.
일시 중지와 재활성화와 삭제
일시 중지와 재활성화는access 필드가 아니라 별도의 엔드포인트입니다. 일정에 따르지 않고 즉시 적용되기 때문입니다.
일시 중지와 활성화는 요청 본문이 없으며 업데이트된 QR 코드를 반환합니다.
PUT /api/v1/qrs/{qrId}와 { "archived": true }로, 또는 PATCH에서 archived로 일시 중지 상태를 설정할 수도 있습니다. 일시 중지 상태 설정을 참조하세요.
삭제하면 QR 코드와 단축 링크가 함께 제거됩니다.
변경 사항이 적용되는 시점
- 다음 스캔부터. 규칙은 코드를 스캔할 때 확인되므로 변경 사항은 다음 스캔부터 적용되며 소급 적용되지 않습니다.
- 일시 중지 페이지. 일정, 스캔 제한, 일시 중지로 차단된 QR 코드는 일시 중지 페이지를 표시합니다. 스캔은 리디렉션되지 않습니다.
- 비밀번호. 이미 비밀번호를 입력한 방문자는 비밀번호가 바뀌거나 보호를 껐다가 다시 켤 때까지 접근 권한을 유지합니다.
- 시계. 일정은 방문자의 현지 시각이 아니라 UTC 서버 시계를 사용합니다.
- 규칙 조합. QR 코드는 일시 중지되지 않았고, 일정 기간 안에 있으며, 스캔 제한에 도달하지 않았을 때만 목적지로 연결됩니다.
자주 발생하는 문제
link 아래에 규칙을 설정하면 422가 반환됩니다
link 아래에 규칙을 설정하면 422가 반환됩니다
규칙은
link가 아니라 access 아래에 보내세요.비밀번호 보호를 켜면 422가 반환됩니다
비밀번호 보호를 켜면 422가 반환됩니다
QR 코드에 아직 비밀번호가 없습니다.
passwordProtected: true 대신 password를 보내세요.재활성화한 후에도 QR 코드가 일시 중지 페이지를 표시합니다
재활성화한 후에도 QR 코드가 일시 중지 페이지를 표시합니다
일정이나 스캔 제한이 아직 적용되고 있습니다. QR 코드의
access.activeAt, access.pauseAt, access.scanLimit을 확인하고 scans를 제한과 비교하세요.링크가 만료되도록 하고 싶습니다
링크가 만료되도록 하고 싶습니다
이 API에서는
link.expiresAt을 사용할 수 없습니다. 대신 access.pauseAt을 사용하세요.