ダウンロード URL の取得 (Get Download URL)
GET/apiv3/pub/documents/{docID}/download-urldocuments_read
ドキュメントファイルをダウンロードするための、有効期限付きの事前署名済み S3 URL を生成します。この URL は、認証ヘッダーなしで使用できます。
リクエスト
パスパラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
docID | integer | ドキュメント ID です。 |
クエリパラメータ
| パラメータ | 型 | デフォルト | 説明 |
|---|---|---|---|
linked_file_id | integer | — | 特定のファイルバージョンです。省略すると最新版になります。 |
pdf | boolean | false | PDF 変換版の URL を取得する場合は true にします。 |
expiry | integer | 3600 | URL の有効期間（秒）です。 |
レスポンス
200 OK| フィールド | 型 | 説明 |
|---|---|---|
url | string | 事前署名済み S3 URL です。指定した expiry の期間だけ有効です。使用に認証ヘッダーは不要です。 |
エラー
| ステータス | 理由 |
|---|---|
| 400 | docID が無効です |
| 401 | トークンが無効または期限切れです |
| 404 | ドキュメントが見つからないか、ファイルが添付されていません |
| 500 | S3 の署名生成に失敗しました |
cURL
curl -i -X GET "https://portal.docwize.com/apiv3/pub/documents/1542/download-url" \
-H "Authorization: Bearer <ACCESS_TOKEN>"
{
"url": "https://s3.amazonaws.com/bucket/company/1542_a7f2c.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=3600&X-Amz-Signature=..."
}