Link ve QR Kod ile ödeme almak için Craftgate üzerinde link oluşturabilir, bu linki paylaşabilir ve herhangi bir teknik entegrasyona ihtiyaç duymadan kolayca ödeme alabilirsiniz.
Link oluşturmak için gerekli bilgilere aşağıda yer verilmiştir.
| HTTP Metod | URL |
|---|---|
POST |
/craftlink/v1/products |
Link oluşturmak için yapılacak isteklerde gönderilmesi beklenen parametreler aşağıdaki tablo ve alt başlıklar altında listelenmiştir.
| Parametre Adı | Tipi | Zorunlu | Açıklama |
|---|---|---|---|
name |
string |
Evet | Oluşturmak istediğiniz link'e isim vermek için kullanılabilir. |
description |
string |
Evet | Oluşturmak istediğiniz link'e ait detay vermek için kullanılabilir. |
orderId |
string |
Hayır | Bankaya iletilecek olan sipariş numarası. Sipariş numarası gönderildi ise stok değeri 1 gönderilmelidir. |
price |
number |
Evet | Link'e ait fiyat. |
currency |
Currency |
Evet | Ödemenin alınacağı para birimini ifade eder. |
stock |
number |
Hayır | Sınırlı sayıda yada stok durumu varsa bu alan kullanılabilir. |
channel |
string |
Hayır | Farklı kanallardan ödeme alıyorsanız bu alan üzerinden gruplayabilirsiniz. |
enabledInstallments |
number[] |
Evet | Ödeme adımında gösterilecek taksitleri ifade eder. |
Ödeme 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 |
|---|---|---|
id |
number |
Link'e ait ID değeri |
name |
string |
Link adı |
description |
string |
Link açıklaması |
channel |
string |
Link kanalı |
orderId |
string |
Banka sipariş no |
status |
Status |
Link durumu |
price |
number |
Link fiyatı |
currency |
Currency |
Link para birimi |
stock |
number |
Link'e ait stock bilgisi. |
soldCount |
number |
Link üzerinden kaç defa ödeme alındığını ifade eder. |
token |
string |
Link'e ait token değeri. |
enabledInstallments |
number[] |
Link ödemesinde kullanılabilecek taksit değerleri. |
url |
string |
Link'e erişebileceğiniz url adresi. |
qrCodeUrl |
string |
QR Kod'a erişebileceğiniz url adresi. |
Açık kaynak kodlu Craftgate API client'larındaki örnek kodları inceleyebilirsiniz.
Link güncellemek için gerekli bilgilere aşağıda yer verilmiştir.
| HTTP Metod | URL |
|---|---|
PUT |
/craftlink/v1/products/:id |
| Parametre Adı | Tipi | Zorunlu | Açıklama |
|---|---|---|---|
id |
number |
Evet | Link'e ait ID değeri |
Link oluşturmak için yapılacak isteklerde gönderilmesi beklenen parametreler aşağıdaki tablo ve alt başlıklar altında listelenmiştir.
| Parametre Adı | Tipi | Zorunlu | Açıklama |
|---|---|---|---|
status |
Status |
Evet | Link durumu |
name |
string |
Evet | Oluşturmak istediğiniz link'e isim vermek için kullanılabilir. |
description |
string |
Evet | Oluşturmak istediğiniz link'e ait detay vermek için kullanılabilir. |
orderId |
string |
Hayır | Bankaya iletilecek olan sipariş numarası. Sipariş numarası gönderildi ise stok değeri 1 gönderilmelidir. |
price |
number |
Evet | Link'e ait fiyat. |
currency |
Currency |
Evet | Ödemenin alınacağı para birimini ifade eder. |
stock |
number |
Hayır | Sınırlı sayıda yada stok durumu varsa bu alan kullanılabilir. |
channel |
string |
Evet | Farklı kanallardan ödeme alıyorsanız bu alan üzerinden gruplayabilirsiniz. |
enabledInstallments |
number[] |
Evet | Ödeme adımında gösterilecek taksitleri ifade eder. |
Ödeme 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:
Dönüş değeri için link cevabına bakabilirsiniz.
Açık kaynak kodlu Craftgate API client'larındaki örnek kodları inceleyebilirsiniz.
Link sorgulama için gerekli bilgilere aşağıda yer verilmiştir.
| HTTP Metod | URL |
|---|---|
GET |
/craftlink/v1/products/:id |
| Parametre Adı | Tipi | Zorunlu | Açıklama |
|---|---|---|---|
id |
number |
Evet | Link'e ait ID değeri |
Ödeme 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:
Dönüş değeri için link cevabına bakabilirsiniz.
Açık kaynak kodlu Craftgate API client'larındaki örnek kodları inceleyebilirsiniz.
Link silmek için gerekli bilgilere aşağıda yer verilmiştir.
| HTTP Metod | URL |
|---|---|
DELETE |
/craftlink/v1/products/:id |
| Parametre Adı | Tipi | Zorunlu | Açıklama |
|---|---|---|---|
id |
number |
Evet | Link'e ait ID değeri |
Açık kaynak kodlu Craftgate API client'larındaki örnek kodları inceleyebilirsiniz.
Link aramak için gerekli bilgilere aşağıda yer verilmiştir.
| HTTP Metod | URL |
|---|---|
GET |
/craftlink/v1/products |
| Parametre Adı | Tipi | Zorunlu | Açıklama |
|---|---|---|---|
name |
string |
Hayır | Link ismi |
minPrice |
number |
Hayır | Link fiyatı |
maxPrice |
number |
Hayır | Link fiyatı |
currency |
Currency |
Hayır | Link para birimi |
channel |
string |
Hayır | Link kanalı |
page |
number |
Hayır | Sayfalama için sayfa numarası |
size |
number |
Hayır | Sayfalama için sayfa büyüklüğü |
Ödeme 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 |
Link'e ait ID değeri |
size |
string |
Link adı |
totalSize |
string |
Link açıklaması |
items |
Link[] |
Link listesi. Dönüş değeri için link cevabına bakabilirsiniz. |
Açık kaynak kodlu Craftgate API client'larındaki örnek kodları inceleyebilirsiniz.