Hazır Api Kütüphanesi

Hedef Kitle

Bu bölüm online ödeme sistemlerine aşina olan geliştiriciler için hazırlanmış olup, eticaret ve ERP sistemlerine entegrasyon konusunda yol gösterecek şekilde hazırlanmıştır.

Müşteri Destek Hattı

Yaşanılan problemler ve anlaşılamayan bölümler için lütfen destek hattı ile ileşim içerisine geçiniz.

Cevap Formatı

Bütün api cevapları varsayılan olaran JSON formatında gelicektir. JSON ayrıştırma işlemi için çeşitli araçlar yada frameworkler kullanılabilir.

Test Ortamı

Test ortamı api bağlantılarını test etmeniz ve problemsiz çalıştığından emin olmanız çin oluşturulmuş bir sanal ortamdır. Kişisel payfull hesabınızdan test modunu aktif ederek test ortamında çalışabilir, dilerseniz canlı ortama geçiş yapıp gerçek işlemler gerçekleştirebilirsiniz.

API İstekleri

Bir istek Payfull API Endpoint'ine gönderilen POST HTTP bilgisi demektir. Bir api isteği belirlenmiş olan parametreler ve değerlerden oluşan şifrelenmiş şekilde, belirlenen Endpoint Url'ine yapılan HTTP POST isteğinden oluşur.

TLS / SSL Güvenlik Protokolü

Servislerimiz PCI-DSS kuralları gereği sadece TLS 1.1 ve TLS 1.2 protokollerinin kullanımına izin vermektedir. Lütfen uygulamanızın bu protokoller üzerinden Payfull URL’ sine POST attığından emin olunuz. Aksi taktirde “Bağlantı kapatılacaktır veya Connection Closed” şeklinde hatalar alınacaktır.

API Cevapları

Api cevapları json formatından oluşur. Her cevap işlemin tipinden bağımsız olarak status (0/1) değeri dönerek işlemin akıbeti hakkında bilgi verir.
ErrorCode and ErrorMSG parametreleri işlemin akıbetine göre belirlenmiş olan hata kodu ve hata mesajı dönmektedir.
ErrorCode and ErrorMSG parametreleri başarılı(hatasız) işlem sonrası sırası ile "00" , "" mesajları dönerek bir hata yaşanmadığını, işlemin başarıyla gerçekleştirildiğini belirtir.

Doğrulanma

Doğrulama işlemi için istek içerisinde ihtiyaç duyulan 2 parametre kişisel Payfull hesabınız içerisinde(ayarlar->api hesapları) oluşturulmaktadır. Konu ile ilgili destek hattı ile iletişime geçebilirsiniz.
Her api kullanıcısı kendi api hesabını oluşturup o hesap üzerinden işlemlerini gerçekleştirmelidir.

Bütün api istekleri HTTPS düzerinden yapılmalıdır. HTTP üzerinden yapılan istekler güvenlik protokolleri gereği başarısız olacaktır.

‍

Güvenlik Kodu Oluşturma

Her istek için "Üye İşyeri Şifresi" (Payful hesabınız içerisinde geçen isim) kullanılarak aşağıda belirtilen işlemlerden sonra bir güvenlik kodu(hash) oluşturulmalıdır.
Bu güvenlik kodu parametreler arasına eklenerek istek gönderilmelidir.
İstek işleme merkezimiz aynı işlemi kendi tarafında gerçekleştirerek aynı güvenlik kodu(hash) değerine ulaşınca doğrulama işlemi başarıyla sonuçlanmış olacaktır.

Güvenlik kodu (hash) değerini oluşturmak için aşağıdaki işlemler sırası ile gerçekleştirilmelidir;

• - Bütün parametrelerin oluşturulduğundan emin olun. Her senaryo için Güvenlik kodu (hash) oluşturma işlemi son işlem ve son parametreniz olmalıdır.
• - Parametreleri alfabetik olarak A'dan Z'ye sıralayınız.
• - Bir string değeri($siraliParametreler) oluşturup teker teker her parametrenizin uzunluğunu ve kendisini yanyana ekleyiniz.
• - sha256 hash kodu üretici fonksiyon ile parametrelerinizden oluşturduğunuz ($siraliParametreler) string değerinizi ve Payfull hesabınızda belirlenen "Üye İşyeri Şifresi" ni kullanarak bir Güvenlik kodu üretiniz.
• - Parametreleriniz içerisine parametre ismi "hash", değeri ise şimdi oluştuduğunuz Güvenlik kodunu yerleştirerek Api isteğinizi Endpoint Url'inize gönderiniz.

Örnek olarak:
Varsayalım ki aşağıda belirtilen 3 parametreyi göndermek istemektesiniz. Bunun için ihtiyacınız olan hash kodu şu şekilde oluşturulmalıdır.

• paramB = '4111'
• paramA = '6632009'
• paramC = 'AXCVF'
• parametre string'i = "7" . "6632009" . "4" . "4111" . "5" . "AXCVF";
• parametre string'i = "76632009441115AXCVF";

‍