Bayi API v1 dokümantasyonu
Kendi uygulamanızdan ürün sorgulayın, bayi bakiyenizle sipariş oluşturun ve sertifika sürecini uçtan uca takip edin.
Başlangıç
Temel adres:
API yalnızca HTTPS ve JSON kullanır. Anahtarınızı müşteri panelindeki Bayi API Merkezi üzerinden oluşturun.
Kimlik doğrulama
Her istekte API anahtarını Bearer başlığı ile gönderin:
Anahtar bir kez gösterilir. Tarayıcı JavaScript koduna, mobil uygulamaya veya Git deposuna eklemeyin.
Ürünleri listeleme
/productsBakiye sorgulama
/balanceSipariş oluşturma
/ordersHer sipariş için benzersiz bir Idempotency-Key gönderilmelidir. Bağlantı kesildiğinde aynı anahtarla tekrar göndermek ikinci sipariş veya ikinci bakiye kesintisi oluşturmaz.
Alanlar
| Alan | Zorunlu | Açıklama |
|---|---|---|
| product_code | Evet | /products yanıtındaki ürün kodu |
| years | Evet | 1 ile 5 yıl |
| csr | Evet | PEM biçiminde geçerli CSR |
| dcv_method | Evet | DNS, HTTP veya EMAIL |
| dcv_email | EMAIL için | Standart domain doğrulama adresi |
| customer_reference | Hayır | Kendi sisteminizdeki sipariş referansı |
Sipariş durumu ve DCV
/orders/{id}Yanıtta sipariş durumu ile CNAME/TXT veya HTTP doğrulama bilgileri bulunur. Önerilen sorgulama aralığı 60 saniyedir.
Sertifikayı indirme
/orders/{id}/certificateSertifika hazır değilse 409 certificate_not_ready döner. Hazır olduğunda PEM zinciri JSON yanıtındaki data.pem alanındadır.
Hata kodları
| HTTP | Kod | Anlamı |
|---|---|---|
| 400 | invalid_json | JSON veya parametre biçimi hatalı |
| 401 | unauthorized | Anahtar eksik/geçersiz |
| 402 | insufficient_balance | Kullanılabilir bakiye yetersiz |
| 403 | dealer_inactive / ip_not_allowed | Bayi veya IP erişimi kapalı |
| 409 | idempotency_conflict | Anahtar farklı gövdeyle kullanıldı |
| 409 | certificate_not_ready | Sertifika henüz hazır değil |
| 422 | invalid_csr / invalid_product | İş kuralı doğrulaması başarısız |
| 429 | rate_limit | Dakikalık sınır aşıldı |
Canlı kullanım güvenliği
- API anahtarını yalnızca sunucu tarafında ve şifreli secret kasasında saklayın.
- Mümkünse Bayi API Merkezi’nden sabit IP izin listesi tanımlayın.
- Her siparişte benzersiz ve kalıcı Idempotency-Key kullanın.
- Hata kayıtlarında Authorization başlığını veya CSR içeriğini tutmayın.
- 401/403 hatalarında otomatik sonsuz tekrar yapmayın; anahtarı ve yetkiyi kontrol edin.
- 429 ve geçici 5xx yanıtlarında artan bekleme süresiyle yeniden deneyin.