Geliştiriciler

GET/v3/get_supporting_document_templates/{iso}

Destekleyici belge şablonlarını listeleme

Destekleyici belge hazırlamadan önce şablon kimliklerini, adlarını ve ülke ipuçlarını bulun.

Bu sayfada
  1. Şablon kataloğuna göz atın
  2. Gerekliliklere göre bir şablon seçin
  3. Hiçbir şablon döndürülmezse
  4. İndirdiğiniz kopyayı kullanmadan önce inceleyin
  5. İstek
  6. Yanıt
  7. Hatalar
  8. Kullanılabilirlik ve yan etkiler

Şablon kataloğuna göz atın

Hizmetin döndürdüğü şablonları listelemek için isteğe bağlı ISO yol bölümünü eklemeyin. Listeyi filtrelemek için bir ülke ISO kodu belirtin. Filtre, şablonun ülke ipucuyla eşleşir; bu ipucu addan çıkarılmış olabilir ve boş olabilir.

Gerekliliklere göre bir şablon seçin

Bir şablonun bulunması, o ülkedeki her numara için gerekli olduğu veya kabul edildiği anlamına gelmez. Şablon kimliğini geçerli destekleyici belge gereklilikleriyle eşleştirin. Bu liste, doldurulmuş bir belge oluşturmaz, imzalamaz, yüklemez veya onaylamaz.

Hiçbir şablon döndürülmezse

Filtrelenmiş listenin boş olması, eşleşen bir ülke ipucu bulunamadığı anlamına gelebilir. Filtrelenmemiş listenin boş olması da üst veri kaynağındaki verilerin kullanılamadığını gösterebilir. Bu sonuçların hiçbirini destekleyici belge gerekmediğinin kanıtı olarak değerlendirmeyin.

İndirdiğiniz kopyayı kullanmadan önce inceleyin

Katalogdaki bir indirme bağlantısı, biçimlendirmesi veya marka öğeleri değiştirilmiş bir kopya döndürebilir. Bunun değiştirilmemiş özgün sözleşme olduğunu veya indirilmesinin bir kayıt gerekliliğini yerine getirdiğini varsaymayın. Herhangi bir belgeyi doldurmadan veya imzalamadan önce içeriğini inceleyin.

Şu durumlarda: portal belge sihirbazı sözleşme hazırlama olanağı sunuyorsa, sihirbazın önizleme ve açıkça gönderim yapmanızı sağlayan iş akışını kullanın. Gerekli diğer formları doldurmadan önce güncel formu MultiTEL ile teyit edin. İndirilen bir şablon; imzalanmış bir ek, yüklenmiş bir kanıt belgesi veya bir numaranın onaylandığı anlamına gelmez.

İstek

Etkin API hesabınızın kimlik bilgilerini HTTPS üzerinden kullanın. Basic kimlik doğrulaması ve etkin API hesabına ait bearer belirteçleri desteklenir; hesap kısıtlamaları geçerlidir.

GET isteğini, belgelenmiş herhangi bir parametreyi URL yoluna ekleyerek gönderin.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_supporting_document_templates/$COUNTRY_ISO"
Yol parametreleri
AdTürZorunluAçıklama
isostringHayırİsteğe bağlı ülke ISO filtresi. Filtrelenmemiş liste için bu yol bölümünün tamamını çıkarın. Karşılaştırmada büyük/küçük harf ayrımı yapılmaz. Bilinmeyen veya eşleşmeyen değerler, açık bir geçersiz ülke hatası yerine boş liste döndürür.

Yanıt

HTTP durumunun yanı sıra JSON gövdesindeki status.code alanını da kontrol edin. response, id, name, permanent, iso ve url alanlarını içeren nesnelerden oluşan bir dizidir. permanent, boolean türündedir; iso boş olabilir ve şablon adından çıkarılmış olabilir. Ülke bilgisini bir uygunluk kararı olarak değil, bir ipucu olarak değerlendirin. Boş katalog, başarılı bir 200 yanıtıdır ve üst veri kaynağındaki sorgu veri döndürmediğinde de ortaya çıkabilir. URL hizmet tarafından oluşturulur; ana bilgisayar adı açıklayıcı örnektekinden farklı olabilir.

Yanıt yapısını gösteren örnektir; canlı hesap verisi veya güncel fiyat teklifi değildir.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "id": "TEMPLATE_ID_FROM_RESPONSE",
      "name": "Example supporting-document template",
      "permanent": false,
      "iso": "US",
      "url": "https://api.multitel.net/v3/supporting_document/TEMPLATE_ID_FROM_RESPONSE"
    }
  ]
}

Hatalar

  • Kimlik doğrulama veya hizmet hataları için status.code ve status.msg alanlarını kontrol edin. Başarılı bir boş katalog yanıtı, bir belgenin onaylandığı veya kayıt zorunluluğundan muafiyet sağlandığı anlamına gelmez.

Kullanılabilirlik ve yan etkiler

  • Bu katalog/gereklilik sorgusu bir kimlik oluşturmaz, kanıt belgesi yüklemez, numara kaydetmez veya sipariş vermez.
  • Başarılı bir katalog yanıtı, belgelerinizin onaylandığı veya seçilen bir numaranın etkinleştirilebileceğinin doğrulandığı anlamına gelmez.