Zamanlanmış sorgular - Tahsil Dokümantasyon

Her banka bağlantısı en fazla bir schedule taşır. Schedule, hedefi accountId ile bulur; bankCode sunucu tarafından bağlantıdan alınır. Yazma işlemleri bank:operate kapsamı ve x-company-id ister.

Periyodik schedule oluşturun

Mavi Rota’nın Aktifbank bağlantısını 30 dakikada bir, en fazla 45 saniyelik jitter ile çalıştırmak için:

curl --request POST \
  --url https://api.tahsil.dev/banks/account-query-schedules \
  --header "x-api-key: $TAHSIL_API_KEY" \
  --header "x-api-secret: $TAHSIL_API_SECRET" \
  --header "x-company-id: 66b0f09a8f10000000000001" \
  --header "content-type: application/json" \
  --data '{"accountId":"66b0f09a8f10000000000101","mode":"interval","timezone":"Europe/Istanbul","intervalMinutes":30,"jitterSeconds":45,"status":true}'

{
  "status": true,
  "result": {
    "id": "66b0f09a8f10000000000301",
    "accountId": "66b0f09a8f10000000000101",
    "bankCode": "aktifbank",
    "mode": "interval",
    "timezone": "Europe/Istanbul",
    "intervalMinutes": 30,
    "jitterSeconds": 45,
    "status": true,
    "nextRunAt": "2026-07-15T11:00:32.000Z"
  }
}

intervalMinutes 1–1440, jitterSeconds 0–300 aralığındadır.

Çalışma penceresi tanımlayın

windowed modunda günler 0 pazar, 1 pazartesi olacak şekilde 0–6 aralığındadır. Her pencere kendi sorgu aralığını taşır.

{
  "mode": "windowed",
  "timezone": "Europe/Istanbul",
  "windowRules": [
    {
      "days": [1, 2, 3, 4, 5],
      "startTime": "08:00",
      "endTime": "20:00",
      "intervalMinutes": 15
    }
  ],
  "jitterSeconds": 30
}

Schedule yaşam döngüsü

GET /banks/account-query-schedules ile bütün schedule’ları okuyun.
GET /banks/account-query-schedules/{id} ile son çalışma sonucunu inceleyin.
PUT /banks/account-query-schedules/{id} ile çalışma kuralını değiştirin.
PATCH /banks/account-query-schedules/{id}/pause ile duraklatın.
PATCH /banks/account-query-schedules/{id}/resume ile yeni nextRunAt hesaplayarak devam ettirin.
DELETE /banks/account-query-schedules/{id} ile schedule’ı kaldırın.

Bir banka bağlantısı pasife alındığında aktif schedule otomatik durur. Bağlantı yeniden etkinleştirilince yalnız bu nedenle durmuş schedule yeniden planlanır. lastResult.inserted ve lastResult.duplicates değerlerini bağlantı sağlığıyla birlikte izleyin.