Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.payven.com.tr/llms.txt

Use this file to discover all available pages before exploring further.

Payven API’leri URL tabanlı versiyonlama kullanır. Şu an aktif tek versiyon v1’dir.

​
URL formatı

https://vpos.payven.com.tr/api/v1/payments
                                ^^^
                            versiyon segmenti

​
Geriye dönük uyumluluk

Bir versiyon içinde aşağıdaki değişiklikler kırıcı (breaking) kabul edilmez ve önceden duyurulmadan yapılabilir:
  • Yeni opsiyonel alan eklenmesi (request veya response)
  • Yeni endpoint eklenmesi
  • Yeni opsiyonel header eklenmesi
  • Yeni hata kodu eklenmesi
  • Yeni webhook olayı eklenmesi
  • Yanıt alanlarının sıralamasının değişmesi
  • message alanlarındaki metin değişiklikleri
İstemcinizi bu tip değişikliklere toleranslı yazın:
Bilmediğiniz alanları yok sayın.
Yeni hata kodlarını genel code prefix’i (AUTH_*, VALIDATION_*) bazında yakalayın.
Webhook payload’unda bilmediğiniz eventType değerlerini yok sayın, hata fırlatmayın.

​
Kırıcı değişiklikler

Aşağıdaki değişiklikler kırıcı kabul edilir ve yalnızca yeni bir major versiyonda yapılır:
  • Mevcut alanın silinmesi veya isminin değişmesi
  • Mevcut alanın tipinin değişmesi
  • Mevcut endpoint’in URL’sinin değişmesi
  • Mevcut zorunlu alanın eklenmesi
  • Yanıt yapısının yeniden organize edilmesi

​
Versiyon yaşam döngüsü

AşamaSüreAçıklama
AktifSüresizYeni özellikler eklenir, üretimde tam destekle çalışır
DeprecationEn az 12 ayYeni versiyon yayınlandıktan sonra uyarı süresi
Sunset—Tamamen kapatılır (en az 12 aylık geçişten sonra)
Deprecation döneminde ilgili endpoint’ler Deprecation ve Sunset HTTP başlıkları döner: 
Deprecation: Sun, 01 Jan 2027 00:00:00 GMT
Sunset:      Sun, 01 Jan 2028 00:00:00 GMT

​
Yeni versiyon nasıl duyurulur?

1

Beta yayını

Yeni versiyon v2-beta olarak duyurulur, yorum/feedback toplanır.
2

GA yayını

Geri bildirim sonrası v2 GA olarak yayına alınır. v1 aktif kalmaya devam eder.
3

Migration rehberi

Tüm kırıcı değişikliklerin listesi ve göç adımları yayınlanır. Changelog takip edilir.
4

Deprecation süreci

v1 deprecation süresine alınır (minimum 12 ay).
Changelog sayfasını izleyin ve destek ekibinize güncel iletişim kanalı (e-posta, webhook bildirim listesi) bildirin — kritik değişikliklerde önceden uyarılırsınız.