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.

Yeni anahtarlar konsol veya programatik olarak oluşturulabilir. Her iki durumda da apiSecret yalnızca yanıtta bir kez döner — sonradan tekrar erişilemez.

Konsoldan oluşturma

1

API Anahtarları sayfası

Konsol → Ayarlar → API Anahtarları.
2

Yeni Anahtar Oluştur

Sağ üstteki butona basın.
3

Bilgileri girin

  • İsim: hangi servis için kullanılacağı (örn. “Production - Ödeme Servisi”).
  • Ortam: Sandbox veya Production.
  • IP Whitelist: production için zorunlu kabul edin.
4

Secret'i kopyalayın

Üretilen apiSecret değerini güvenli bir yere kopyalayın. Bu pencere kapatıldıktan sonra bir daha gösterilmez.

API ile oluşturma

POST /api/v1/tenants/me/api-keys
curl -X POST https://identity.payven.com.tr/api/v1/tenants/me/api-keys \
  -H "Authorization: Bearer ..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production - Ödeme Servisi",
    "environment": "Production",
    "ipWhitelist": ["52.18.42.10", "52.18.42.11/32"],
    "expiresAt": null
  }'
AlanTipZorunluAçıklama
namestringAnahtar için açıklayıcı isim
environmentenumSandbox veya Production
ipWhiteliststring[]⚠️IP veya CIDR listesi. Boş bırakılırsa tüm IP’ler kabul edilir.
expiresAtstring (ISO-8601)Anahtarın otomatik pasifleşeceği tarih. Geçici anahtarlar için faydalı.

Yanıt

{
  "isSuccess": true,
  "code": "201",
  "data": {
    "id": "key_8e3f5c12",
    "apiKey": "pvk-prod-MaVpaXii",
    "secret": "ZQVHx6fpBJa4BMVggVR6xm9C9wrRDTmaGi5jgD7a",
    "name": "Production - Ödeme Servisi",
    "environment": "Production",
    "status": "Active",
    "ipWhitelist": ["52.18.42.10", "52.18.42.11/32"],
    "createdAt": "2026-05-03T12:34:56Z",
    "expiresAt": null
  }
}
secret alanı yalnızca bu yanıtta dönecek. Listeleme veya detay endpoint’lerinde her zaman null olur. Hemen secret manager’ınıza kaydedin.

Hemen kullanmaya başlama

Aldığınız apiKey ve secret ile ürün servislerine istek atabilirsiniz:
curl https://vpos.payven.com.tr/api/v1/transactions \
  -H "X-API-Key: pvk-prod-MaVpaXii" \
  -H "X-API-Secret: ZQVHx6fpBJa4..." \
  -H "X-Merchant-Id: 3fa85f64-..."

Hata yanıtları

HTTPcodeAnlam
403PERMISSION_DENIEDAnahtar oluşturma yetkiniz yok (TenantAdmin gerekir)
409API_KEY_LIMIT_REACHEDPlan kotanız aktif anahtar sayısı için doldu
400VALIDATION_INVALID_IPIP whitelist formatı hatalı