Dokümanlar / Uç Noktalar

Hesap Kullanımı

GET /api/v1/account/usage

Bu sayfada

Hesap Kullanımı
Yanıt alanları
Genel
Endpoint kırılımı —
Ne zaman kullanmalı
Sayaç davranışları

Hesap Kullanımı

Aktif API anahtarına bağlı müşterinin mevcut tier bilgisini ve kullanım sayaçlarını döner. Bu uç nokta Api.Account.Usage izniyle korunur. İzin, mevcut tüm tier'lara varsayılan olarak tanımlanır; dolayısıyla pratikte her geçerli anahtar erişebilir. Tier'ınızdan kaldırılmışsa 403 FORBIDDEN alırsınız.

Yanıt alanları

Genel

customerName — müşteri organizasyonun adı
tierName — bağlı olduğunuz tier (Community, Business, Enterprise vb.)
globalRateLimit — tier'ınızın dakikalık istek hakkı (60 saniyelik kayan pencere üzerinden değerlendirilir)
requestsToday — UTC 00:00'dan bu yana sayaca işlenen istek sayısı (toplam)
requestsThisMonth — ayın başından bu yana sayaca işlenen istek sayısı (toplam)
monthResetAt — bu ayın aylık kotalarının sıfırlanacağı UTC zamanı (her ayın 1'i 00:00 UTC)

Endpoint kırılımı — `byEndpoint`

Tier'ınızın tanıdığı her permission için bir satır içerir. Sıralama "bu ay en çok kullanılan endpoint başta" şeklindedir.

Her satırda:

permissionKey — örn. Api.Documents.List, Api.Library.Semantic
label — Türkçe okunabilir etiket (Mevzuat — Anlamlı Arama vb.)
monthToDate — bu ay endpoint için sayaca işlenen istek sayısı
monthlyLimit — endpoint için aylık kota (null ise sınırsız)
remaining — monthlyLimit - monthToDate (null ise sınırsız)

Aylık kotalar tier yapılandırmasında endpoint başına override edilebilir. Bir endpoint için kota yoksa monthlyLimit ve remaining null döner; sadece global dakikalık limit (globalRateLimit) geçerlidir.

Ne zaman kullanmalı

Günlük/aylık kullanımı kendi dashboard'unuza beslemek için
Bir endpoint'in kotasının ne kadar kaldığını gerçek zamanlı görmek için (429 QUOTA_EXCEEDED'a yakalanmadan önce)
Tier yükseltme kararı almadan önce gerçek hacmi görmek için

Sayaç davranışları

Sayaçlara 429 (oran/kota aşımı) ve 5xx sunucu hataları dahil edilmez. Kimliği doğrulanamayan 401 istekleri de sayılmaz (kimlik bağlamı oluşmadığı için). Bunun dışındaki tüm yanıtlar — 2xx, 400, 403 ve 404 dâhil — istek sayacına işlenir; API çağrıyı doğrulayıp değerlendirdiği için bunlar da hacim tüketir.
/account/usage çağrılarının kendisi sayaçlara işlenmez. Bu nedenle byEndpoint içindeki Api.Account.Usage ("Hesap — Kullanım") satırı her zaman 0 görünür ve requestsToday/requestsThisMonth bu uç noktaya yaptığınız istekleri içermez.
Sayaç güncellemesi asenkrondur; çok son atılan istekler birkaç saniye gecikmeli görünebilir
Aylık kota hesabı UTC takvim ayını kullanır — monthResetAt ile sıfırlanır, lokal saat dilimini dikkate almaz
Endpoint başına monthToDate, bugünkü canlı sayaç ile geçmiş günlerin toplanmış (aggregate) değerlerinin birleşimidir. Bugünkü kısım anlıktır; geçmiş günler her 15 dakikada bir çalışan toplama işiyle yazılır ve 60 saniye önbelleklenir. Bu nedenle özellikle UTC gün dönümünden hemen sonra ~15 dakikaya kadar eksik raporlama görülebilir.

Yanıtlar

200 — Kullanım bilgileri.

{
  "success": true,
  "data": {
    "customerName": "Acme Finans",
    "tierName": "Business",
    "globalRateLimit": 1000,
    "requestsToday": 421,
    "requestsThisMonth": 12873,
    "monthResetAt": "2026-05-01T00:00:00Z",
    "byEndpoint": [
      {
        "permissionKey": "Api.Documents.List",
        "label": "Dokümanlar — Liste",
        "monthToDate": 8421,
        "monthlyLimit": 50000,
        "remaining": 41579
      }
    ]
  },
  "meta": { "requestId": "req_..." }
}

401 — X-API-Key eksik veya geçersiz.

403 — Tier'ınızda `Api.Account.Usage` izni tanımlı değil.

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

curl -X GET \
  "https://api.regvion.com/api/v1/account/usage" \
  -H "X-API-Key: rgv_live_REPLACE_WITH_YOUR_KEY"

const url = 'https://api.regvion.com/api/v1/account/usage';
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/account/usage"
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/account/usage");
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/account/usage', $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/account/usage"))
    .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/account/usage", 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/account/usage')
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/account/usage")
    .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/account/usage")!)
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/account/usage")
        .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/account/usage' -Method Get -Headers $headers

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

Yanıt (200)

{
  "success": true,
  "data": {
    "customerName": "Acme Finans",
    "tierName": "Business",
    "globalRateLimit": 1000,
    "requestsToday": 421,
    "requestsThisMonth": 12873,
    "monthResetAt": "2026-05-01T00:00:00Z",
    "byEndpoint": [
      {
        "permissionKey": "Api.Documents.List",
        "label": "Dokümanlar — Liste",
        "monthToDate": 8421,
        "monthlyLimit": 50000,
        "remaining": 41579
      }
    ]
  },
  "meta": { "requestId": "req_..." }
}

Hesap Kullanımı

Yanıt alanları

Genel

Endpoint kırılımı — byEndpoint

Ne zaman kullanmalı

Sayaç davranışları

Yanıtlar

200 — Kullanım bilgileri.

401 — X-API-Key eksik veya geçersiz.

403 — Tier'ınızda `Api.Account.Usage` izni tanımlı değil.

Endpoint kırılımı — `byEndpoint`