GetQR API はベータ版で、一部のワークスペースでのみご利用いただけます。正式リリースまでに内容が変更される場合があります。
ファイルをアップロードする
1
ファイルを登録する
ファイルの
target、contentType、size を指定して ファイルのアップロードを登録する を呼び出します。target によって、受け付けるコンテンツタイプとサイズの上限が決まります。fileId と uploadUrl が返されます。2
ファイルを送る
uploadUrl に PUT リクエストでファイルを送ります。Content-Type と Content-Length は、登録した contentType と size に完全に一致する必要があり、一致しない場合は拒否されます。URL は署名付きなので、API キーは付けないでください。URL の有効期限は 10 分です。3
ファイル ID を使う
QR コードを作成する ときに
fileId を渡します。pdf、image、videoの QR コードのfileIdとして。対応する用途でアップロードします。vcard、social、multilink、eventの QR コードのプロフィール画像のfileIdとして。logo用途でアップロードします。- 独自のロゴには、
logoOptions.typeをuploadedにしてlogoOptions.fileIdとして。logo用途でアップロードします。カスタマイズ をご覧ください。
制限
- パラメータなしの MIME タイプ。
image/pngのように、小文字のタイプとサブタイプを 1 つだけ送ります。;charset=のようなパラメータやリストは拒否されます。 - SVG は不可。
image/svg+xmlのような XML ベースのタイプは受け付けません。image/pngやimage/jpegなどのラスター画像をアップロードしてください。
ヘッダー
string
必須
application/json。ファイルのアップロードを登録する
POST /api/v1/files
ファイルを登録し、アップロード先の署名付き URL を返します。この呼び出し自体はファイルをアップロードしません。
string
必須
ファイルの MIME タイプ（パラメータなし）。例：
application/pdf。アップロードのリクエストでは、これと完全に同じ Content-Type を送る必要があります。integer
必須
ファイルの正確なサイズ（バイト単位の正の整数）。用途ごとの上限と照らし合わせて確認されます。アップロードのリクエストでは、これと完全に同じ
Content-Length を送る必要があります。string
元のファイル名。最大 255 文字。ダッシュボードでの表示用に保持されます。
/ や \ を含むパスは拒否されます。string
fileId または logoOptions.fileId として渡す ID。string
ファイルを
PUT する署名付き URL。integer
uploadUrl の有効期限が切れるまでの秒数：600。string
アップロードに使う HTTP メソッド：
PUT。よくある問題
422 "Content type … is not allowed for target"
422 "Content type … is not allowed for target"
コンテンツタイプが用途と一致していません。たとえば、
pdf が受け付けるのは application/pdf だけです。制限 をご覧ください。422 "must be a single lowercase type/subtype"
422 "must be a single lowercase type/subtype"
コンテンツタイプは小文字で、パラメータを付けずに送ってください。
Image/PNG や image/png; charset=utf-8 ではなく image/png です。422 "File is too large for target"
422 "File is too large for target"
宣言した
size が用途の上限を超えています。登録する前にファイルを圧縮してください。uploadUrl へのアップロードが失敗する
uploadUrl へのアップロードが失敗する
URL の有効期限はファイルの登録から 10 分で、リクエストでは登録したとおりの
Content-Type と Content-Length を送る必要があります。新しい URL を取得するには、ファイルをもう一度登録してください。QR コードの作成時に 422 "is registered but its content was never uploaded"
QR コードの作成時に 422 "is registered but its content was never uploaded"
ファイルは登録されましたが、
uploadUrl への PUT が完了していません。ファイルをアップロードしてから QR コードを作成してください。QR コードの作成時に 422 "was uploaded to …"
QR コードの作成時に 422 "was uploaded to …"
ファイルが別の用途で登録されています。たとえば、
pdf の QR コードに image のファイルを使った場合です。対応する用途で新しくアップロードを登録してください。QR コードの作成時に 404 "File … was not found"
QR コードの作成時に 404 "File … was not found"
その
fileId は存在しません。ファイルのアップロードを登録する のレスポンスから取得してください。