Kaptan Partner API
Kaptan Partner API, entegratörlerin Kaptan ödeme motorunu dış dünyadan güvenli biçimde çağırabilmesi için HMAC imzalı bir veri düzlemi sunar.
Genel Bakış
- Base URL:
https://<host>/partner/1.0/...— tüm çağrılar POST + JSON. - Kimlik Doğrulama: Per-request HMAC-SHA256 imzası. Üç header:
X-Api-Key,X-Timestamp,X-Signature. Detay için bkz. Kimlik Doğrulama. - Entegrasyon anahtarı: Entegrasyonlar merchant panelinden oluşturulur. Oluşturma anında bir API anahtarı (
ok_live_/ok_test_), bir secret (yalnızca bir kez gösterilir) ve bir dizi scope üretilir. - Scope: Her endpoint bir scope gerektirir. Bkz. Scope Kataloğu.
- Sandbox:
ok_test_önekli anahtarla yapılan işlem sandbox olarak etiketlenir; yönlendirmeyi değiştirmez. Test trafiği için işletmenizde bir test sağlayıcısı tanımlı olmalıdır. Bkz. Test Kartları.
Kapsam
| Grup | Uç noktalar |
|---|---|
| POS | Kart ödemesi, komisyon önizleme, taksit listeleme, işlem arama/detay, provizyon kapatma, iptal, iade |
| Ödeme Linki | Tahsilat linki oluşturma, detay, listeleme, iptal |
| QR | Kurumsal tahsilat karekodu |
| Kayıtlı Kart | Kart saklama, listeleme, detay, varsayılan, iptal |
| Tekrarlayan Tahsilat | Abonelik planı kurma ve yönetimi |
| Raporlama | Dönem özeti |
| İşletme | Profil doğrulama |
İşletme Kapsamı
İşlemler, API anahtarınızın tanımlı olduğu işletme kapsamında gerçekleşir. İstek gövdesinde ayrıca bir işletme bilgisi göndermenize gerek yoktur; kapsam API anahtarınızdan belirlenir.
Hızlı Başlangıç
curl -X POST https://<host>/partner/1.0/pos/card/pay \
-H "X-Api-Key: ..." \
-H "X-Timestamp: ..." \
-H "X-Signature: ..." \
-H "Idempotency-Key: pay-ORD-1001" \
-H "Content-Type: application/json" \
-d '{
"orderNumber": "ORD-1001",
"paymentMethod": "CARD",
"amount": 100.00,
"currency": "TRY",
"cardNumber": "5406681122223338",
"cardHolderName": "Test User",
"expMonth": 12,
"expYear": 2030,
"cvv": "000"
}'Uçları tarayıcıda denemek için her endpoint sayfasındaki İsteği Dene panelini, entegrasyon araçları için Araçlar bölümünü kullanın.