Hesabınızda mevcut bir markayı seçin
MultiTEL hesabınızla zaten ilişkilendirilmiş olan kayıt sistemi marka kimliğiyle başlayın. Bu sorgulama bir marka oluşturmaz veya başkasının markasını hesabınıza bağlamaz. Mevcut müşteri iş akışı, uygunluk bilgilerini istemeden önce sahipliği kontrol eder. Sorgulama 404 döndürürse yerel bir satır kimliği kullanmak yerine seçili hesabı ve markayı doğrulayın.
Kullanım senaryosu seçeneklerini bu sonuçtan oluşturun
Genel kullanım senaryosu kataloğu, kayıt sistemindeki seçenekleri açıklar. Markaya özgü bu sorgulama, seçili markanın seçeneklerini sağlar. Döndürülen her usecase değerini koruyun ve katalogdaki görüntüleme etiketi ve açıklamayla birleştirin. Genel katalogdaki her kaydı, marka o kayıt için uygunmuş gibi sunmayın.
Portal, bu yanıtın bir JSON listesi olmasını bekler. Yanıt eksikse, hatalı biçimlendirilmişse veya bir hata yanıtıysa müşterinin formunu koruyun ve uygunluk bilgilerinin yüklenemediğini gösterin. Bunu hiçbir uyarı vermeden varsayılan bir kullanım senaryosunun onayı olarak değerlendirmeyin. Kayıt sistemi, kısaltılmış örnektekilerin dışında alanlar da döndürebilir.
Seçili kullanım senaryosunun gereksinimlerini yükleyin
Müşteri döndürülen kullanım senaryosu değerlerinden birini seçtikten sonra şu adrese istek gönderin: /tcr/v2/campaignBuilder/brand/{brand_id}/usecase/{usecase}; isteği aynı marka için yapın. Bu yanıt, alt kullanım senaryosu sınırlarını ve operatöre özgü gereksinimleri sağlar. Mesaj örneklerini, rızayı ve diğer zorunlu beyanları toplamak için bu yanıttan yararlanın. Uygunluk listesi tek başına eksiksiz bir kampanya kayıt başvurusu hazırlamaya yetmez.
Hesap fiyatlandırmasını ayrıca inceleyin
Sağlayıcının monthlyFee, quarterlyFee veya annualFee gibi alanları, yanıtta yer aldıklarında sağlayıcı ücretlerine ilişkin üst verileri açıklar. Müşterinin hesabına ait fiyatın veya kayıt koşullarının yerine geçmezler. Mevcut portal, perakende kampanya fiyatlarını ayrıca okur ve inceleme ekranı için uygunluk verileriyle birleştirir. Eski numaralandırma türü yardımcı işlevinin koda sabitlenmiş fiyatlarından müşteriye yansıtılacak ücreti çıkarmayın.
Marka veya kullanım senaryosu değiştiğinde yenileyin
Marka değiştirirken önceki markanın seçeneklerini temizleyin ve yeni seçim için uygunluk bilgilerini yükleyin. Göndermeden önce seçili kullanım senaryosunun gereksinimlerini yenileyin. Bu GET istekleri kayıt başvurusu göndermez, kampanya etkinleştirmez veya numara atamaz.
İstek
İzin verilen bir kaynak IP adresinden, HTTPS üzerinden etkin bir API hesabı kullanın. Mevcut yol, Basic kimlik doğrulaması ve bearer belirteci kullanan etkin API hesapları dahil olmak üzere hesabın kimlik doğrulama politikasını destekler. Sağlayıcının kimlik bilgilerini kullanmayın.
URL yolunda marka tanımlayıcısıyla GET isteği gönderin. İstek gövdesi gerekmez.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID"| Ad | Tür | Zorunlu | Açıklama |
|---|---|---|---|
brand_id | dize | Evet | Kimliği doğrulanmış MultiTEL hesabınızla ilişkilendirilmiş kayıt sistemi marka kimliği. Yerel veritabanı satır kimliği, kampanya kimliği veya işletmenin vergi numarası yerine marka kimliğini kullanın. Bunu tek bir URL yol bölümü olarak kodlayın. |
Yanıt
Mevcut TCR yolu, kayıt sisteminin JSON gövdesini doğrudan döndürür ve HTTP durumunu korur. Eski v3 status/response sarmalayıcısını eklemez. Kısaltılmış kurgusal örnek, canlı bir uygunluk sonucu değildir. Kullanmadan önce HTTP durumunu ve beklenen JSON yapısını kontrol edin. Mevcut portal, her biri bir usecase tanımlayan uygunluk kayıtlarından oluşan bir liste bekler. Görüntüleme etiketleri için bu kayıtları usecase kataloğuyla birleştirir ve perakende fiyatlarını ayrıca okur. Ek sağlayıcı alanları bulunabilir.
Açıklayıcı yanıt yapısıdır; canlı hesap verisi veya güncel fiyat teklifi değildir.
[
{
"usecase": "2FA"
}
]Hatalar
- 401: Hesabın kimlik doğrulaması başarısız oldu. API kimlik bilgilerini, hesabın etkinlik durumunu ve geçerli kaynak IP kısıtlamalarını kontrol edin.
- 404: Marka, kimliği doğrulanmış hesapla ilişkili değil veya sağlayıcı istenen markayı ya da seçimi bulamıyor. Yerel sahiplik kontrolünden kaynaklanan ret yanıtı, sağlayıcıya istek gönderilmeden önce döndürülür.
- Diğer kayıt sistemi hataları: Üst hizmetten gelen HTTP durumu ve gövdesi korunur. Geçersiz veya kullanılamayan bir kullanım senaryosu, başarıyla alınmış boş bir gereksinim kümesi anlamına gelmez.
- 429: Hesaba ait veya paylaşılan sağlayıcı istek sınırına ulaşıldı. Retry-After başlığında belirtilen bekleme süresine uyun.
- 502/503: İletim hatası ya da sağlayıcının veya istek hızı sınırlayıcısının erişilebilirlik sorunu. Formu koruyun ve bekleme süresini artırarak yeniden deneyin.
Erişilebilirlik ve yan etkiler
- İncelenen GET isteği mevcut markanın sahipliğini kontrol eder, kayıt sistemiyle iletişim kurar ve istek denetim kayıtları yazar. Marka veya kampanya oluşturmaz ve kayıt ücreti tahsil etmez.
- Sağlayıcı ücretlerine ilişkin üst veriler, MultiTEL müşterisine yönelik bir perakende fiyat teklifi değildir. Portal, daha sonra gönderilecek bir kayıt isteğinden önce hesap fiyatlandırmasını ayrıca inceler.
- Uygunluk ve gereksinimler değişebilir. Göndermeden önce bunları seçili marka ve kullanım senaryosu için yenileyin. Başarılı bir sorgulama, kampanya onayı, numara ataması veya mesaj göndermeye başlama izni anlamına gelmez.