Genel katalogu özel alımdan ayırın
Genel veriler hizmet, ülke, fiyat ve süreyi açıklar. Tahsis edilmiş telefon numarası veya kod içermez. Aktivasyonlar ayrı özel takiple bir hesap ve siparişe aittir.
Hizmet ve ülke dizini ticari tekliflerden ayrıdır. Entegrasyon sözleşmesi, siparişler için yetkili fiyat ve kullanılabilirlik içeren bir API kataloğu gerektirir.
Katalog ve sipariş
Mevcut sözleşme GET /catalog/products ve GET /catalog/products/:slug'u belirtir. Arka uç yetkili fiyat, süre ve açık kullanılabilirlik sağlar; stok yoksa bilinmez kalır.
Siparişler, idempotans anahtarıyla bir ürün tanımlayıcı gönderir. Sunucu, rezervasyon veya tahsis öncesi fiyatı ve stoğu kontrol eder. Bir sayfa okumak hassas işlemleri tetiklemez.
Alım durumları
Modül tahsis, bekleme, alındı, tamamlandı, iptal edildi, süresi doldu ve başarısız durumlarını ayırt eder. Tahsis numarasız beklemede olabilir; gerçek bekleme ve alım arka uç numarası ve süresi gerektirir.
Her mesajın sabit bir tanımlayıcısı, zaman damgası ve metni vardır. Arka uç çıkarılmış bir kod sağlayabilir; arayüz bir OTP tahmin etmemelidir. Genel dizinde tahsis edilmiş telefon numarası veya özel kod yoktur.
Yetkili işlemler ve güncellemeler
GET /activations ve GET /activations/:id özel okumalardır. POST /activations/:id/actions, iptal, bitir veya yeniden gönder işlemlerini idempotent anahtarla gönderir. Arka uç izin verilen işlemleri bildirir ve yeniden kontrol eder.
Özel okumalar oturum, arayüz dili ve uygun önbellekleme kullanır. İzleme aralıkları sözleşmeye uyar; sunucu süresi dolması ve durum, tarayıcı zamanlayıcısından önceliklidir.
Ödeme, tahsis ve sağlayıcı sırları
Fatura varlık, ağ, tutar, adres ve son kullanma tarihini belirler. Ödeme onayı ve numara tahsisi ayrı olaylardır. Arka uç hataları ve yeniden denemeleri çift tahsis olmadan yönetir.
Sağlayıcı anahtarları ve ödeme sırları sunucuda kalır. API her hesap okumasını yetkilendirir, mesaj saklamayı tanımlar ve dahili sağlayıcı tanımlayıcılarını gizli tutar. Bu sayfa entegrasyon sözleşmesini belgeleyip, operasyonel bir genel API duyurmaz.
Sözleşme uç noktası referansı
| Yöntem | Uç nokta | Rol |
|---|---|---|
GET | /catalog/products | Herkese açık katalog |
GET | /activations | Hesap aktivasyonları |
GET | /activations/:id | Özel alım takibi |
POST | /activations/:id/actions | Yetkili işlem |
Bunlar mevcut ön uç sözleşme yollarıdır, yayımlanmış üretim uç noktaları değildir. Sağlayıcı, kimlik doğrulama ve ödeme entegrasyonu bağlanmayı bekliyor.