Dokümanlar / Uç Noktalar

Paket Dosyası İndir

GET /api/v1/documents/{id}/files/{fileId}/download

Bu sayfada

Paket Dosyası İndir
Dosya kimliği nereden gelir
Yanıt başlıkları
Filigran
İzin ve kota
404 ne zaman döner

Paket Dosyası İndir

Zip paketi olarak yayımlanmış bir mevzuatın (documentFormat = 5, Archive) tek bir dosyasını paketten çıkarıp indirir. Paketin tamamı için Doküman İndir uç noktasını kullanın; o uç zip dosyasını olduğu gibi döner.

Dosya kimliği nereden gelir

fileId, GET /library/{id} yanıtındaki files[].id değeridir. Kimlik dosyanın paket içindeki yoluna bağlıdır: paket yeniden işlendiğinde (örneğin kaynakta güncellendiğinde) dosya aynı yolla pakette kaldıkça kimliği değişmez. Paketten çıkan ya da yolu değişen dosyanın kimliği geçersizleşir ve 404 döner; kimliği uzun süre saklamak yerine indirmeden önce detayı yeniden okuyun.

Uç nokta dosyayı yalnız kimliğiyle bulur ve kimlik bu belgenin dosya listesinde olmalıdır: başka bir paketin dosya kimliği bu belgede 404'tür. Paket içindeki yol hiçbir zaman istekten okunmaz.

Yanıt başlıkları

Content-Disposition: attachment; filename="…"; filename*=UTF-8''… — dosya her zaman ek olarak iner, tarayıcıda açılmaz. Türkçe karakterli adlar filename* (RFC 5987) ile taşınır; filename ASCII yedeğidir.
X-Content-Type-Options: nosniff.
Content-Type dosyanın türüdür ve önce dosyanın baytlarından okunur: PDF yalnız dosyanın baytları PDF ise application/pdf olur (adı .pdf olan ama PDF olmayan dosya application/octet-stream döner); Word (.doc, .docx, .rtf), Excel (.xls, .xlsx) ve zip dosyaları imzalarından tanınır. Baytları bir tür kanıtlamayan dosya adının uzantısıyla türünü alır: Word, Excel (.xlsm dâhil), .csv, .txt, .zip ile PNG, JPEG, GIF ve TIFF görüntüleri.
HTML, SVG, XML (XSD ve XSL dâhil) ile JavaScript dosyaları, baytları ne olursa olsun, her zaman application/octet-stream olarak verilir. Bu bir güvenlik kuralıdır: pakete konmuş böyle bir dosya kendi türüyle verilseydi tarayıcıda çalışabilirdi. Listede olmayan her uzantı da application/octet-stream'dir.
Cache-Control: private, max-age=86400 — PDF dosyalar müşteriye özel filigranlıdır; paylaşımlı bir önbellek bu yanıtı saklamamalıdır.

Filigran

Baytları PDF olan dosyalar, Doküman İndir'deki gibi müşteriye özel filigranla işaretlenir ve X-Regvion-Document-Fingerprint başlığı filigran kimliğini taşır. Kimlik belge başınadır: aynı paketin bütün PDF dosyaları aynı kimliği taşır. Diğer türler filigransız, paketteki hâliyle bayt bayt verilir. Her indirme — filigransız olanlar dâhil — indirme kaydına yazılır.

İzin ve kota

Api.Documents.Download iznini gerektirir ve paketin tamamını indirmekle aynı oran sınırı ve aylık kota kovasından düşer (/account/usage byEndpoint kırılımında Api.Documents.Download satırı).

404 ne zaman döner

Belge yok, işlenmesi tamamlanmamış ya da paket değil (isPackage = false).
fileId bu belgenin dosyalarından biri değil: başka bir paketin dosyası ya da paketten çıkmış bir dosyanın kimliği.
Dosya paketten tek başına çıkarılamıyor: şifreli (status = encrypted) ya da olağandışı sıkıştırma oranıyla güvenlik sınırını aşan (status = skippedRatio) dosyalar. Bu durumda mesaj paketin tamamını indirmenizi söyler.
Dosya saklanan pakette bulunamadı ya da açılmış boyutu 100 MB'ı aşıyor.

Parametreler

İsim	Konum	Tip	Zorunlu	Açıklama
`id`	Path	`uuid`	Evet	Paket belgesinin ID'si.
`fileId`	Path	`uuid`	Evet	Dosyanın ID'si — /library/{id} yanıtındaki files[].id. Dosya aynı yolla pakette kaldıkça değişmez; paketten çıkan dosyanın kimliği 404 döner.

Yanıtlar

200 — Dosya akışı. Her zaman Content-Disposition: attachment (Türkçe ad filename*=UTF-8''… ile) ve X-Content-Type-Options: nosniff. Content-Type dosyanın türüdür; HTML, SVG, XML ve JavaScript dosyaları her zaman application/octet-stream. PDF dosyalarda X-Regvion-Document-Fingerprint başlığı filigran kimliğini taşır.

404 — Belge yok, tamamlanmamış ya da paket değil; dosya bu belgeye ait değil ya da artık pakette yok; şifreli veya güvenlik sınırını aşan dosya (paketin tamamını indirin); dosya saklanan pakette bulunamadı.

⚠️ Sunucudan sunucuya — API anahtarınızı tarayıcıda paylaşmayın. Neden?

curl -X GET \
  "https://api.regvion.com/api/v1/documents/7a3f9e2c-4b8d-11ef-8a3c-0242ac120002/files/5b1e7c2a-9d4f-4e1b-8a3c-2f6d0e9b7a14/download" \
  -H "X-API-Key: rgv_live_REPLACE_WITH_YOUR_KEY"

const url = 'https://api.regvion.com/api/v1/documents/7a3f9e2c-4b8d-11ef-8a3c-0242ac120002/files/5b1e7c2a-9d4f-4e1b-8a3c-2f6d0e9b7a14/download';
const headers = {
  'X-API-Key': 'rgv_live_REPLACE_WITH_YOUR_KEY'
};

const response = await fetch(url, {
  method: 'GET',
  headers,
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const body = await response.json();
console.log(body.data);
console.log('Request ID:', body.meta.requestId);

import requests

url = "https://api.regvion.com/api/v1/documents/7a3f9e2c-4b8d-11ef-8a3c-0242ac120002/files/5b1e7c2a-9d4f-4e1b-8a3c-2f6d0e9b7a14/download"
headers = {"X-API-Key": "rgv_live_REPLACE_WITH_YOUR_KEY"}
response = requests.get(url, headers=headers)
response.raise_for_status()
body = response.json()
print(body["data"])
print("Request ID:", body["meta"]["requestId"])

using System.Net.Http;
using System.Net.Http.Json;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("X-API-Key", "rgv_live_REPLACE_WITH_YOUR_KEY");

var response = await client.GetAsync("https://api.regvion.com/api/v1/documents/7a3f9e2c-4b8d-11ef-8a3c-0242ac120002/files/5b1e7c2a-9d4f-4e1b-8a3c-2f6d0e9b7a14/download");
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadFromJsonAsync<JsonElement>();
Console.WriteLine(body.GetProperty("meta").GetProperty("requestId").GetString());

<?php
require 'vendor/autoload.php';

$client = new GuzzleHttp\Client();

$options = [
    'headers' => [
        'X-API-Key' => 'rgv_live_REPLACE_WITH_YOUR_KEY',
    ],
];

$response = $client->request('GET', 'https://api.regvion.com/api/v1/documents/7a3f9e2c-4b8d-11ef-8a3c-0242ac120002/files/5b1e7c2a-9d4f-4e1b-8a3c-2f6d0e9b7a14/download', $options);
$body = json_decode($response->getBody(), true);
echo 'Request ID: ' . $body['meta']['requestId'];

import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();

HttpRequest.Builder b = HttpRequest.newBuilder()
    .uri(URI.create("https://api.regvion.com/api/v1/documents/7a3f9e2c-4b8d-11ef-8a3c-0242ac120002/files/5b1e7c2a-9d4f-4e1b-8a3c-2f6d0e9b7a14/download"))
    .header("X-API-Key", "rgv_live_REPLACE_WITH_YOUR_KEY")
    .GET();

HttpResponse<String> response = client.send(b.build(), HttpResponse.BodyHandlers.ofString());
System.out.println("Status: " + response.statusCode());
System.out.println(response.body());

package main

import (
    "bytes"
    "encoding/json"
    "fmt"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://api.regvion.com/api/v1/documents/7a3f9e2c-4b8d-11ef-8a3c-0242ac120002/files/5b1e7c2a-9d4f-4e1b-8a3c-2f6d0e9b7a14/download", nil)
    req.Header.Set("X-API-Key", "rgv_live_REPLACE_WITH_YOUR_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil { panic(err) }
    defer resp.Body.Close()

    var envelope struct {
        Data interface{} `json:"data"`
        Meta struct { RequestId string `json:"requestId"` } `json:"meta"`
    }
    json.NewDecoder(resp.Body).Decode(&envelope)
    fmt.Println("Request ID:", envelope.Meta.RequestId)
}

require 'net/http'
require 'json'
require 'uri'

uri = URI('https://api.regvion.com/api/v1/documents/7a3f9e2c-4b8d-11ef-8a3c-0242ac120002/files/5b1e7c2a-9d4f-4e1b-8a3c-2f6d0e9b7a14/download')
request = Net::HTTP::Get.new(uri)
request['X-API-Key'] = 'rgv_live_REPLACE_WITH_YOUR_KEY'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end

body = JSON.parse(response.body)
puts "Request ID: #{body['meta']['requestId']}"

import okhttp3.*
import okhttp3.MediaType.Companion.toMediaType
import okhttp3.RequestBody.Companion.toRequestBody

val client = OkHttpClient()

val builder = Request.Builder()
    .url("https://api.regvion.com/api/v1/documents/7a3f9e2c-4b8d-11ef-8a3c-0242ac120002/files/5b1e7c2a-9d4f-4e1b-8a3c-2f6d0e9b7a14/download")
    .addHeader("X-API-Key", "rgv_live_REPLACE_WITH_YOUR_KEY")

client.newCall(builder.build()).execute().use { response ->
    println("Status: ${'$'}{response.code}")
    println(response.body?.string())
}

import Foundation

var request = URLRequest(url: URL(string: "https://api.regvion.com/api/v1/documents/7a3f9e2c-4b8d-11ef-8a3c-0242ac120002/files/5b1e7c2a-9d4f-4e1b-8a3c-2f6d0e9b7a14/download")!)
request.httpMethod = "GET"
request.setValue("rgv_live_REPLACE_WITH_YOUR_KEY", forHTTPHeaderField: "X-API-Key")

let (data, response) = try await URLSession.shared.data(for: request)
if let http = response as? HTTPURLResponse { print("Status: \(http.statusCode)") }
print(String(data: data, encoding: .utf8) ?? "")

use reqwest::blocking::Client;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let mut req = client.get("https://api.regvion.com/api/v1/documents/7a3f9e2c-4b8d-11ef-8a3c-0242ac120002/files/5b1e7c2a-9d4f-4e1b-8a3c-2f6d0e9b7a14/download")
        .header("X-API-Key", "rgv_live_REPLACE_WITH_YOUR_KEY")
        ;
    let res = req.send()?;
    println!("Status: {}", res.status());
    println!("{}", res.text()?);
    Ok(())
}

$headers = @{
    'X-API-Key' = 'rgv_live_REPLACE_WITH_YOUR_KEY'
}

$response = Invoke-RestMethod -Uri 'https://api.regvion.com/api/v1/documents/7a3f9e2c-4b8d-11ef-8a3c-0242ac120002/files/5b1e7c2a-9d4f-4e1b-8a3c-2f6d0e9b7a14/download' -Method Get -Headers $headers

$response.data
Write-Host "Request ID:" $response.meta.requestId