1. Genel Bakış
Payoup API'sine (Uygulama Programlama Arayüzü) hoş geldiniz. Bu API Hizmet Şartları ("API Şartları"), Payoup'un API hizmetlerine, geliştirici araçlarına ve ilgili belgelere erişiminizi ve kullanımınızı yönetir (topluca "API Hizmetleri"). API Hizmetlerini kullanarak, bu API Şartlarına ve Payoup Hizmet Şartlarına bağlı kalmayı kabul edersiniz.
Önemli: Bu API Şartları, Payoup Hizmet Şartlarına ek niteliktedir. Çakışma durumunda, bu API Şartları API Hizmetlerinin kullanımını yönetecektir.
2. API Erişimi ve Kayıt
Payoup API'sine erişmek için şunları yapmalısınız:
- İyi durumda aktif bir Payoup hesabına sahip olmak
- Gerekli doğrulama ve uyum kontrollerini tamamlamak
- Geliştirici panelinizden API erişimi için kaydolmak
- Bu API Şartlarını ve geçerli ek şartları kabul etmek
- API kimlik bilgilerini (API anahtarları, jetonlar) güvenli bir şekilde elde etmek ve yönetmek
API Anahtarları: Yetkili uygulamalarınız tarafından gizli tutulması ve yalnızca kullanılması gereken benzersiz API kimlik bilgileri alacaksınız.
3. API Uç Noktaları ve Özellikler
Payoup API aşağıdaki temel işlevleri sağlar:
| Yöntem |
Uç Nokta |
Açıklama |
| POST |
/v1/payment-links |
Ödeme linki oluşturma |
| POST |
/v1/webhook/register |
Webhook kaydı |
| GET |
/v1/transaction/{id} |
İşlem sorgulama |
| POST |
/v1/transfer/initiate |
Transfer başlatma |
| GET |
/v1/balance |
Bakiye sorgulama |
4. Rate Limitleri ve Kota Kullanımı
API kullanımı abonelik planınıza dayalı rate limitlere tabidir:
- Başlangıç planı: Saatte 1.000 istek
- Profesyonel planı: Saatte 5.000 istek
- Ölçek planı: Saatte 20.000 istek
- Kurumsal plan: Sınırsız özel limitler mevcut
5. Kimlik Doğrulama ve Güvenlik
Tüm API istekleri aşağıdaki yöntemlerden biri kullanılarak kimlik doğrulanmalıdır:
- API Anahtarı Kimlik Doğrulaması: API anahtarınızı Authorization başlığına dahil edin
- OAuth 2.0: Kullanıcıya özel işlemler için erişim jetonlarını kullanın
- Webhook İmzaları: HMAC imzalarını kullanarak webhook isteklerini doğrulayın
5.1 Güvenlik Gereksinimleri
- Tüm API iletişimleri için HTTPS kullanın
- API anahtarlarını istemci tarafı kodunda asla göstermeyin
- Uygun hata işleme ve günlükleme uygulayın
- Tüm giriş verilerini ve API yanıtlarını doğrulayın
- API kimlik bilgileri için güvenli depolama kullanın
- Uçunuzda rate limiting uygulayın
Authorization: Bearer pk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx Content-Type: application/json X-Payoup-Version: 2024-02-23
6. Veri ve Gizlilik
API Hizmetlerini kullanımınız Payoup'un gizlilik uygulamalarına tabidir:
- Veri İşleme: API istekleri ve yanıtları güvenlik ve izleme amaçlarıyla günlüğe kaydedilebilir
- Veri Saklama: API günlükleri güvenlik analizi için 90 güne kadar saklanır
- Veri Paylaşımı: API verileri yasalar gerektirdiği durumlar hariç üçüncü taraflarla paylaşılmaz
- Veri Güvenliği: Tüm API iletişimleri TLS 1.2 veya üstü kullanılarak şifrelenir
- Kullanıcı Onayı: API üzerinden kullanıcı verilerini işlemek önce uygun onaya sahip olduğunuzdan emin olun
7. Webhook'lar
Payoup gerçek zamanlı olay güncellemeleri için webhook bildirimleri sağlar:
- Ödeme Olayları: payment.created, payment.completed, payment.failed
- Hesap Olayları: account.verified, account.suspended
- Ödeme Olayları: payout.initiated, payout.completed, payout.failed
- Anlaşmazlık Olayları: dispute.created, dispute.resolved
7.1 Webhook Gereksinimleri
- Webhook uç noktaları 10 saniye içinde HTTP 200 durumu ile yanıt vermeli
- Başarısız webhook teslimatları için yeniden deneme mantığı uygulayın
- Webhook sırlarınızı kullanarak webhook imzalarını doğrulayın
- Yinelenan webhook olaylarını zarafetle yönetin
- Tüm webhook uç noktaları için HTTPS kullanın
8. Yasaklı API Kullanımları
Aşağıdaki Payoup API kullanımları kesinlikle yasaktır:
- Ters Mühendislik: API'yi ters mühendislik yapmaya veya derlemeye çalışmak
- Aşırı Kullanım: Rate limitleri aşmak veya kötüye kullanım yeniden deneme desenleri uygulamak
- Veri Madenciliği: API'yi kullanıcı verilerini izinsiz toplamak için kullanmak
- Rekabetçi Hizmetler: Payoup'un temel platformunu kopyalayan rakip teknoloji veya ödeme altyapısı hizmetleri oluşturmak
- Güvenlik Sömürüsü: Güvenlik açıkları bulmaya veya sömürmeye çalışmak
- Spam ve Kötüye Kullanım: API'yi spam, dolandırıcılık veya kötü niyetli faaliyetler için kullanmak
- Yeniden Satış: API erişimini yeniden satmak veya API proxy hizmetleri oluşturmak
9. API Kullanılabilirliği ve SLA
Payoup yüksek API kullanılabilirliği sürdürmeye çalışır:
- Çalışma Hedefi: API hizmetleri için aylık %99.9 çalışma süresi
- Yanıt Süresi: 200ms altında ortalama yanıt süresi
- Bakım Pencereleri: Planlı bakım 24 saat önceden duyurulur
- Durum Sayfası: status.payoup.com adresinde gerçek zamanlı API durumu mevcuttur
- Olay Yanıtı: Kritik olaylar 1 saat içinde ele alınır
Not: Hizmet Seviyesi Anlaşması (SLA) kredileri Kurumsal müşteriler için uzun süreli kesintiler durumunda mevcut olabilir.
10. API Sürümleme ve Kullanımdan Kaldırma
Payoup API sürümleri için anlamsal sürümlemeyi takip eder:
- Sürüm Formatı: API sürümleri tarihle tanımlanır (örn. 2024-02-23)
- Geriye Uyumlu: Bozan değişiklikler yeni sürüm sürümlerini gerektirir
- Kullanımdan Kaldırma Bildirimi: Sürüm kullanımdan kaldırılmadan önce 6 ay bildirim
- Geçiş Desteği: Sürüm yükseltmeleri için belgelendirme ve destek sağlanır
- Eşzamanlı Sürümler: Birden çok API sürümü aynı anda desteklenir
11. Test ve Sandbox
Payoup test etmek için sandbox ortamı sağlar:
- Sandbox API: Ayrı sandbox uç noktası (api-sandbox.payoup.com)
- Test Verileri: Test ödeme yöntemlerini ve sahte verileri kullanın
- Gerçek İşlem Yok: Sandbox işlemleri gerçek ödemeleri işlemez
- Tam Özellik Erişimi: Tüm API özellikleri sandbox'da mevcuttur
- İzole Ortam: Sandbox verileri üretimden ayrıdır
12. Destek ve Belgelendirme
Payoup kapsamlı API desteği sağlar:
- API Belgelendirmesi: docs.payoup.com adresinde tam belgelendirme
- Kod Örnekleri: Popüler programlama dilleri için SDK'lar ve örnekler
- Geliştirici Desteği: support@payoup.com adresinde e-posta desteği
- Topluluk Forumu: Sorular ve tartışmalar için geliştirici topluluğu
- Durum İzleme: Gerçek zamanlı API durumu ve olay güncellemeleri
13. Uyum ve Yasal
API kullanımı tüm geçerli yasalara ve düzenlemelere uymalıdır:
- Finansal Düzenlemeler: AML, KYC ve finansal düzenlemelere uyun
- Veri Koruma: GDPR, CCPA ve gizlilik yasalarını takip edin
- İhracat Kontrolleri: İhracat kontrolü ve yaptırım düzenlemelerine uyun
- Sektör Standartları: PCI DSS ve güvenlik standartlarını takip edin
- Yerel Yasalar: Faaliyet gösterdiğiniz tüm yargı alanlarındaki yasalara uyun
14. Sonlandırma ve Askıya Alma
Payoup API erişimini aşağıdakiler için askıya alabilir veya sonlandırabilir:
- Bu API Şartlarını veya Payoup Hizmet Şartlarını ihlal etmek
- Şüpheli veya dolandırıcılık API kullanım desenleri
- Güvenlik ihlalleri veya tehlikeye atılmış API kimlik bilgileri
- Aşırı rate limit ihlalleri veya kötüye kullanım
- Uygulanabilir ücretlerin ödenmemesi
- Düzenleyici veya yasal uyum sorunları
Bildirim: Anlık güvenlik tehditleri veya yasal ihlaller durumları hariç, sonlandırmadan önce makul bildirim sağlayacağız.