Ana içeriğe geç

Kimlik Doğrulama

2.1 AccessToken Oluşturma​

VPWS servisleri üzerinden yapılacak tüm isteklerden önce geçerli bir AccessToken alınması zorunludur.

AccessToken Nedir?​

API'ye istek göndermeden önce alınması gereken ve bayi kimliğini doğrulayan güvenlik anahtarıdır.

Süresi dolduğunda yenilenmesi gerekir. Aksi halde istekler 401 Unauthorized hatası alır.

Ön Koşullar​

Lisans Tanımı

VPWS API lisansı, Müşteri ve Bayiler → Bayi Ödeme Servis Bilgileri sekmesinde aktif olmalıdır.

Servis Yetkileri

  • "Bayi Ödeme Servis Bilgileri" sekmesinde ilgili endpoint'ler aktif olmalıdır.
  • Dakika ve İstek limitleri 0 ise sınırsız kullanım anlamına gelir.

API Anahtarları

AlanAçıklama
ApiKeyBayi bazlı verilen anahtar
SecretKeyBayi yetkilisine özel iletilen gizli anahtar

AccessToken Alma Servisi​

  • Adres: /auth/api/token/connect
  • Metot: POST
{
"apiKey": "BAYI_API_KEY",
"secretKey": "BAYI_SECRET_KEY"
}

2.2 Token Süresi ve Yenileme​

Token Geçerlilik Süresi​

  • AccessToken 24 saat boyunca geçerlidir.
  • Süresi dolan token ile yapılan tüm istekler 401 Unauthorized döner.

Token Yenileme​

Token süresi dolduğunda aynı ApiKey ve SecretKey ile yeniden token alınmalıdır.

VPWS çağrılarında sistemin

  • Token süresini kontrol etmesi
  • Süresi dolmuşsa otomatik olarak yenilemesi
  • Ardından isteği tekrar göndermesi önerilir.

Kullanım Formatı​

Her istekte token aşağıdaki formatta gönderilmelidir

Authorization: Bearer {AccessToken}