Dokümanlar / Uç Noktalar

Doküman Detayı

GET /api/v1/documents/{id}

Bu sayfada

Doküman Detayı
Yanıt alanları
Yükümlülükler için derinleşme
404 ne zaman döner

Doküman Detayı

Bir dokümanın tam detayını döner: başlık, yayım tarihi, kaynak, AI tarafından üretilen özet, sınıflandırma, yükümlülük listesi ve metadata. Yanıt 30 dakika boyunca sunucu tarafında önbelleklenir; çok yakın zamanlı bir güncelleme bu pencere boyunca yansımayabilir.

Yanıt alanları

summary — AI'ın ürettiği Türkçe özet (1-3 paragraf)
classification — dokümanın sınıfı (ör. "Yönetmelik", "Tebliğ", "Kanun")
obligations — çıkarılmış yükümlülüklerin özet şemalı listesi (id, başlık, kaynak referansı, aksiyon, ciddiyet, son tarih, departmanlar)
metadata — AI'ın serbest formdaki ek metadata'sı; JSON string
hasDownloadableFile — orijinal dosya (/documents/{id}/download) indirilebilir mi

Yükümlülükler için derinleşme

obligations dizisindeki her öğe yapılandırılmış bir özet nesnesidir. Tam detayı (tam açıklama, kaynak alıntısı, ceza tutarları, etiketler) almak için iki yol vardır:

/api/v1/documents/{id}/obligations — aynı listeyi ayrı bir endpoint olarak döner (önbelleklemeden bağımsız)
/api/v1/obligations/{id} — tek bir yükümlülüğün tam detayı

Bu uç nokta cevabında description, sourceExcerpt, penalty* alanları ve institutionTypeIds / topicIds etiketleri yer almaz — payload boyutunu küçük tutmak için liste-modunda kalır. (departmentIds istisnadır; özet şemada da bulunur.)

404 ne zaman döner

Geçersiz UUID formatı — istek daha yönlendirme (routing) aşamasında reddedilir; gövdesiz bir 404 döner (error.code ve meta.requestId yoktur). İstemcinizin bu yolda JSON ayrıştırmaya çalışmadığından emin olun.
DB'de var ancak boru hattı tamamlanmamış (PipelineStatus != Completed)
Hiç var olmayan ID

Son iki durum, boru hattını tamamlamamış dokümanların dolaylı olarak var olduğunu ortaya çıkarmamak için aynı NOT_FOUND zarfı ve aynı mesajla birleşir.

Parametreler

İsim	Konum	Tip	Zorunlu	Açıklama
`id`	Path	`uuid`	Evet	Doküman ID'si.

Yanıtlar

200 — Başarılı.

{
  "success": true,
  "data": {
    "id": "...",
    "title": "...",
    "sourceName": "Resmi Gazete",
    "publishedDate": "2026-03-28T00:00:00Z",
    "documentFormat": 0,
    "sourceUrl": "https://...",
    "summary": "AI tarafından üretilen özet...",
    "classification": "Regülasyon",
    "obligations": [
      {
        "id": "9b2c1d40-...",
        "documentId": "7a3f9e2c-...",
        "ordinal": 1,
        "title": "Lisans başvurusunda bulunulması",
        "sourceReference": "Madde 7",
        "actionType": 0,
        "severity": 2,
        "deadlineDate": "2026-06-30",
        "deadlineKind": 1,
        "deadlineRawText": "30 Haziran 2026 tarihine kadar",
        "departmentIds": [3]
      }
    ],
    "metadata": null,
    "hasDownloadableFile": true
  }
}

404 — Doküman bulunamadı veya henüz boru hattını tamamlamadı.

⚠️ 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" \
  -H "X-API-Key: rgv_live_REPLACE_WITH_YOUR_KEY"

const url = 'https://api.regvion.com/api/v1/documents/7a3f9e2c-4b8d-11ef-8a3c-0242ac120002';
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"
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");
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', $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"))
    .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", 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')
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")
    .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")!)
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")
        .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' -Method Get -Headers $headers

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

Yanıt (200)

{
  "success": true,
  "data": {
    "id": "...",
    "title": "...",
    "sourceName": "Resmi Gazete",
    "publishedDate": "2026-03-28T00:00:00Z",
    "documentFormat": 0,
    "sourceUrl": "https://...",
    "summary": "AI tarafından üretilen özet...",
    "classification": "Regülasyon",
    "obligations": [
      {
        "id": "9b2c1d40-...",
        "documentId": "7a3f9e2c-...",
        "ordinal": 1,
        "title": "Lisans başvurusunda bulunulması",
        "sourceReference": "Madde 7",
        "actionType": 0,
        "severity": 2,
        "deadlineDate": "2026-06-30",
        "deadlineKind": 1,
        "deadlineRawText": "30 Haziran 2026 tarihine kadar",
        "departmentIds": [3]
      }
    ],
    "metadata": null,
    "hasDownloadableFile": true
  }
}