Dokümanlar / Uç Noktalar

Mevzuata Abone Ol

POST /api/v1/subscriptions/regulations

Bu sayfada

Mevzuata Abone Ol
Gövde
Hangi fark?
Aynı mevzuatın nüshaları
Dönüş

Mevzuata Abone Ol

Belirli bir regülasyona manuel abonelik ekler. Regülasyonun boru hattı tamamlanmış olmalıdır (PipelineStatus = Completed) — aksi halde 404 alırsınız. Kiracınız bu mevzuata zaten aboneyse 400 döner; aynı mevzuatın başka bir nüshasına abonelik de buna dâhildir (aşağıda "Aynı mevzuatın nüshaları").

Gövde

{ "documentId": "7a3f9e2c-4b8d-11ef-8a3c-0242ac120002" }

Tek alan, zorunlu. Geçersiz UUID 400 döner.

Hangi fark?

Abonelik profili (/subscriptions/profile) — etiket tabanlı, gelecekteki regülasyonlar için tetiklenir.
Manuel abonelik (bu uç nokta) — mevcut bir regülasyonu takibe alır. Regülasyon sonradan güncellenirse webhook/bildirim almayı sağlayacaktır (webhook sistemi yayınlanınca).

İkisi birlikte kullanılabilir — otomatik profil + manuel istisnalar.

Aynı mevzuatın nüshaları

Aynı mevzuatın kütüphanede birden çok nüshası olabilir (bkz. Mevzuat Detayı, "İkiz nüshalar"). Abonelik mevzuata aittir ve mükerrer kontrolü mevzuatın bütün nüshalarına bakar: aynı documentId'yi ikinci kez gönderdiğinizde de, aynı mevzuatın başka bir nüshasının (sahibinin ya da bir ikizinin) id'siyle zaten aboneyken de 400 alırsınız. GET /library/{id} yanıtındaki isSubscribed aynı kuralla hesaplanır: true ise bu çağrı 400 döner.

Yeni abonelik gönderdiğiniz documentId ile kaydedilir; sahibin id'sine çevrilmez ve sonradan değiştirilmez. Aboneliklerim listesi o id'yi döner.

Dönüş

Oluşturulan abonelik kaydı ve ilgili regülasyonun başlık/özet snapshot'ı döner. Bu snapshot client'ınızın UI'ında hemen göstermek içindir; canonical veri için /library/{id} kullanın.

Parametreler

İsim	Konum	Tip	Zorunlu	Açıklama
`documentId`	Body	`uuid`	Evet	Regülasyon doküman ID'si.

Yanıtlar

200 — Oluşturulan abonelik.

400 — Kiracı bu mevzuata zaten abone (aynı mevzuatın başka bir nüshası dâhil).

404 — Regülasyon bulunamadı veya tenant bağlantısı yok.

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

curl -X POST \
  "https://api.regvion.com/api/v1/subscriptions/regulations" \
  -H "X-API-Key: rgv_live_REPLACE_WITH_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "documentId": "7a3f9e2c-4b8d-11ef-8a3c-0242ac120002"
}'

const url = 'https://api.regvion.com/api/v1/subscriptions/regulations';
const headers = {
  'X-API-Key': 'rgv_live_REPLACE_WITH_YOUR_KEY'
  , 'Content-Type': 'application/json'
};

const response = await fetch(url, {
  method: 'POST',
  headers,
  body: JSON.stringify({
  "documentId": "7a3f9e2c-4b8d-11ef-8a3c-0242ac120002"
})
});

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/subscriptions/regulations"
headers = {"X-API-Key": "rgv_live_REPLACE_WITH_YOUR_KEY"}
payload = {
  "documentId": "7a3f9e2c-4b8d-11ef-8a3c-0242ac120002"
}
response = requests.post(url, headers=headers, json=payload)
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 payload = new StringContent("""{
  "documentId": "7a3f9e2c-4b8d-11ef-8a3c-0242ac120002"
}""", Encoding.UTF8, "application/json");
var response = await client.PostAsync("https://api.regvion.com/api/v1/subscriptions/regulations", payload);
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',
    ],
    'json' => [
  "documentId" => "7a3f9e2c-4b8d-11ef-8a3c-0242ac120002"
],
];

$response = $client->request('POST', 'https://api.regvion.com/api/v1/subscriptions/regulations', $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/subscriptions/regulations"))
    .header("X-API-Key", "rgv_live_REPLACE_WITH_YOUR_KEY")
    .header("Content-Type", "application/json")
    .POST(BodyPublishers.ofString("{\n  \"documentId\": \"7a3f9e2c-4b8d-11ef-8a3c-0242ac120002\"\n}"));

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() {
    body := bytes.NewReader([]byte("{\n  \"documentId\": \"7a3f9e2c-4b8d-11ef-8a3c-0242ac120002\"\n}"))
    req, _ := http.NewRequest("POST", "https://api.regvion.com/api/v1/subscriptions/regulations", body)
    req.Header.Set("Content-Type", "application/json")
    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/subscriptions/regulations')
request = Net::HTTP::Post.new(uri)
request['X-API-Key'] = 'rgv_live_REPLACE_WITH_YOUR_KEY'
request['Content-Type'] = 'application/json'
request.body = '{\n  "documentId": "7a3f9e2c-4b8d-11ef-8a3c-0242ac120002"\n}'

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/subscriptions/regulations")
    .addHeader("X-API-Key", "rgv_live_REPLACE_WITH_YOUR_KEY")
    .post("{\n  \"documentId\": \"7a3f9e2c-4b8d-11ef-8a3c-0242ac120002\"\n}".toRequestBody("application/json".toMediaType()))

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/subscriptions/regulations")!)
request.httpMethod = "POST"
request.setValue("rgv_live_REPLACE_WITH_YOUR_KEY", forHTTPHeaderField: "X-API-Key")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
request.httpBody = "{\n  \"documentId\": \"7a3f9e2c-4b8d-11ef-8a3c-0242ac120002\"\n}".data(using: .utf8)

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.post("https://api.regvion.com/api/v1/subscriptions/regulations")
        .header("X-API-Key", "rgv_live_REPLACE_WITH_YOUR_KEY")
        .header("Content-Type", "application/json")
        .body("{\n  \"documentId\": \"7a3f9e2c-4b8d-11ef-8a3c-0242ac120002\"\n}")
        ;
    let res = req.send()?;
    println!("Status: {}", res.status());
    println!("{}", res.text()?);
    Ok(())
}

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

$body = @'
{
  "documentId": "7a3f9e2c-4b8d-11ef-8a3c-0242ac120002"
}
'@

$response = Invoke-RestMethod -Uri 'https://api.regvion.com/api/v1/subscriptions/regulations' -Method Post `
    -Headers $headers -Body $body -ContentType 'application/json'

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