URL
Link aramak için kullanılan endpoint ve http metod bilgisi aşağıda verilmiştir.
| HTTP Metod | URL |
|---|---|
GET |
/tokenlink/v1/products |
İstek Parametreleri
Link aramak için yapılacak isteklerde gönderilmesi beklenen URL parametreleri aşağıdaki tablo ve alt başlıklar altında listelenmiştir.
| Parametre Adı | Tipi | Zorunlu | Açıklama |
|---|---|---|---|
name |
string |
Hayır | Link'e verilen isim |
status |
Status |
Hayır | Linkin durumu |
token |
string |
Hayır | Link'e ait eşsiz token |
page |
number |
Hayır | Sayfalama yapmak için kullanılabilir, varsayılan 0. |
size |
number |
Hayır | Sayfalama yapmak için kullanılabilir, varsayılan 10. |
Dönüş Parametreleri
Link sorgulama işleminin sonucunda dönen parametreler de API dokümantasyonu giriş sayfasındaki Dönüş Formatları bölümünde belirtilen kurallara tabidir. Sistemsel ya da kurgusal bir hata bulunmadığı durumda data parametresinde dönen objenin alt parametreleri aşağıdaki gibidir:
| Parametre Adı | Tipi | Açıklama |
|---|---|---|
page |
number |
Sayfa numarası |
size |
number |
Toplam dönen sonuç sayısı |
totalSize |
number |
Toplam dönen sonuç sayısı |
items |
Link[] |
Link'e ait bilgiler bknz. Link dönüş parametreleri |
Link Dönüş Parametreleri
| Parametre Adı | Tipi | Her Zaman Mevcut | Açıklama |
|---|---|---|---|
id |
long |
Evet | Link ID değeri |
status |
Status |
Evet | Link durumunu gösteren değerdir. Aktif linkler için ACTIVE, pasif durumundakiler için PASSIVE döner. Link oluşturma işlemi sonrası oluşturulan link her zaman ACTIVE durumundadır. |
name |
string |
Evet | Link'e verilen isim |
description |
string |
Hayır | Link'e ait detaylı açıklama |
price |
decimal |
Hayır | Link fiyatı. |
stock |
number |
Hayır | Link'e ait stok miktarı. |
soldCount |
number |
Evet | Link üzerinden kaç kere ödeme alındığını ifade eder. |
enabledInstallments |
string |
Hayır | Link üzerinden yapılabilecek taksitleri ifade eder. Örnek; 1,2,3,6 |
expireDate |
date |
Hayır | Link'in geçerlilik süresi. |
token |
string |
Evet | Link'e verilen, 4 karekterden oluşan eşsiz bir anahtardır. |
url |
string |
Evet | Link'e url bilgisidir. Bu link'i paylaşabilir, kullanıcılarınızdan ödeme alabilirsiniz. |
qrCodeUrl |
string |
Evet | Link'e QR kod linkidir. QR kodu okutarak ödeme linkine gidebilirsiniz. |
Örnek Kodlar
Açık kaynak kodlu ÖderoPay API client'larındaki örnek kodları inceleyebilirsiniz
- .NET: https://github.com/TokenPayEng/tokenpay-dotnet-client/blob/master/Samples/LinkSample.cs
- PHP: https://github.com/TokenPayEng/tokenpay-php-client/blob/master/samples/search_links.php
- Java: https://github.com/TokenPayEng/tokenpay-java-client/blob/master/src/test/java/tr/com/tokenpay/sample/LinkSample.java
- Node.js: https://github.com/TokenPayEng/tokenpay-node-client/blob/master/samples/link/SearchLinks.js
Güncel arama page (varsayılan 0), size (varsayılan 100), status, name, token ve conversationId parametrelerini destekler. Sonuçlardaki her linkte paymentIdList ve paymentPhase alanları bulunabilir.