API Kullanımı

Kimlik Doğrulama

Payantis API'lerini çağırabilmek için OAuth2.0 protokolü ile kimlik doğrulaması yapılarak Access Token alınması gerekir. Kimlik doğrulaması sırasında kullanılacak kullanıcı adı ve şifre Payantis ekibi tarafından kurumlar ile özel olarak paylaşılır ve bu bilgiler ile token alınarak ve her isteğin headerındaki Authorization bölümüne eklenir.

Access Token Oluşturma ve API Çağrıları

Token Parametreleri

Parametre	Değeri
grant_type	password
scope	profile
client_id	Integration_API_Client
user_name	Payantis tarafından verilen API kullanıcı adı
password	Payantis tarafından verilen API şifresi

Token almak için Get Token methodu kullanılabilir.

Header Bilgilerinin Eklenmesi

API çağrılarında gerekli yetkilendirmeyi sağlamak için alınan token, her isteğin Authorization başlığına şu şekilde eklenir:

Authorization: Bearer token

Token Refresh

Test ortamında tokenlar 2 saat için geçerli olacak şekilde üretilir. Token'ın daha uzun süre kullanılması için bu süre bitiminden önce kullanıcı ve şifre verilmeden refresh token kullanılarak yeniden token alınması gerekir. Böylelikle bir token en fazla 24 saat kullanılabilir. 24 saatin sonunda mutlaka yeni bir token alınması gereklidir. Token Refresh için Refresh Token methodu kullanılabilir.

.NET Kod Örneği: Access Token Alma

Aşağıdaki kod örneğinde, kullanıcı adı ve şifre bilgileriyle bir erişim token'ı alınmaktadır.

Idempotency ve Correlation ID

Platform API'lerini çağıran client'ların her API çağrısı için unique bir Correlation ID göndermesi beklenmektedir.

Payantis Platform'da idempotency, istemciden gelen her isteğe özel bir correlation-id gönderilerek sağlanır. Sistem, aynı correlation id ile yapılan tekrar eden istekleri algılar ve sadece ilkini işleyerek yinelenen işlemleri engeller.

Kurum servis çağrılarında her isteğe özel atanan correlation-id ile:

İstek akışı izlenir, hangi servislerin çağrıldığı ve nasıl işlendiği görülür.

Hata ayıklama süreci hızlanır, belirli bir isteğe bağlı hatalar daha kolay tespit edilir.

Günlük (log) analizi daha verimli hale gelir, tüm işlem zinciri uçtan uca takip edilir.

Request Dili

API çağrılarında header'da Accept-Language gönderilmesi tavsiye edilmektedir. Response mesajlarındaki cevap ve hata açıklamaları burada gönderilen dile göre oluşturulmaktadır. Öte yandan küçük-büyük harf dönüşümleri (Örneğin requestte gönderilen müşteri adı/soyadı gibi alanlar kaydedilirken büyük harfe dönüştürülmektedir) de Accept-Language alanında belirtilen dile göre yapılmaktadır.

Kimlik Doğrulama#

Access Token Oluşturma ve API Çağrıları#

.NET Kod Örneği: Access Token Alma#

Idempotency ve Correlation ID#

Request Dili#

Kimlik Doğrulama

Access Token Oluşturma ve API Çağrıları

.NET Kod Örneği: Access Token Alma

Idempotency ve Correlation ID

Request Dili