Pengembang

GET/v3/get_supporting_document_templates/{iso}

Daftar templat dokumen pendukung

Temukan ID templat, nama, dan petunjuk negara sebelum menyiapkan dokumen pendukung.

Di halaman ini
  1. Jelajahi katalog templat
  2. Gunakan persyaratan untuk memilih templat
  3. Jika tidak ada templat yang dikembalikan
  4. Tinjau salinan yang diunduh sebelum menggunakannya
  5. Permintaan
  6. Respons
  7. Kesalahan
  8. Ketersediaan dan efek samping

Jelajahi katalog templat

Hilangkan segmen jalur ISO opsional untuk menampilkan daftar templat yang dikembalikan oleh layanan. Sertakan kode ISO negara untuk memfilter daftar. Filter mencocokkan petunjuk negara pada templat, yang dapat disimpulkan dari nama dan dapat kosong.

Gunakan persyaratan untuk memilih templat

Adanya suatu templat tidak berarti templat tersebut diwajibkan atau diterima untuk setiap nomor di negara tersebut. Cocokkan ID templat dengan persyaratan dokumen pendukung yang berlaku. Daftar ini tidak membuat, menandatangani, mengunggah, atau menyetujui dokumen yang telah diisi.

Jika tidak ada templat yang dikembalikan

Daftar terfilter yang kosong dapat berarti tidak ditemukan petunjuk negara yang cocok. Daftar tanpa filter yang kosong juga dapat mencerminkan tidak tersedianya data dari sistem hulu. Jangan menganggap salah satu hasil tersebut sebagai bukti bahwa dokumen pendukung tidak diperlukan.

Tinjau salinan yang diunduh sebelum menggunakannya

Tautan unduhan katalog dapat mengembalikan salinan dengan perubahan format atau identitas merek. Jangan berasumsi bahwa salinan tersebut merupakan perjanjian asli yang tidak diubah atau bahwa mengunduhnya memenuhi suatu persyaratan pendaftaran. Tinjau isinya sebelum mengisi atau menandatangani dokumen apa pun.

Jika panduan dokumen di portal menyediakan penyiapan perjanjian, gunakan pratinjau dan alur pengajuannya yang memerlukan tindakan pengajuan secara eksplisit. Untuk formulir lain yang diwajibkan, konfirmasikan formulir yang berlaku saat ini kepada MultiTEL sebelum mengisinya. Templat yang diunduh bukanlah lampiran yang telah ditandatangani, bukti yang telah diunggah, atau persetujuan atas suatu nomor.

Permintaan

Gunakan kredensial akun API Anda yang telah diaktifkan melalui HTTPS. Autentikasi Basic dan token bearer akun API yang telah diaktifkan didukung; pembatasan akun berlaku.

Gunakan GET dengan parameter apa pun yang didokumentasikan pada jalur URL.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_supporting_document_templates/$COUNTRY_ISO"
Parameter jalur
NamaTipeWajibDeskripsi
isostringTidakFilter ISO negara opsional. Hilangkan seluruh segmen jalur ini untuk mendapatkan daftar tanpa filter. Perbandingan tidak membedakan huruf besar dan kecil. Nilai yang tidak dikenal atau tidak cocok mengembalikan daftar kosong, bukan kesalahan eksplisit yang menyatakan bahwa negara tidak valid.

Respons

Periksa status.code dalam isi JSON serta status HTTP. response adalah larik objek dengan bidang id, name, permanent, iso, dan url. permanent bertipe boolean; iso dapat kosong dan mungkin telah disimpulkan dari nama templat. Perlakukan informasi negara sebagai petunjuk, bukan keputusan kelayakan. Katalog kosong merupakan respons berhasil dengan kode 200 dan juga dapat terjadi ketika pencarian di sistem hulu tidak menghasilkan data. URL dibuat oleh layanan; nama host-nya dapat berbeda dari contoh ilustratif.

Contoh struktur respons untuk ilustrasi; bukan data akun langsung atau penawaran harga terkini.

{
  "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"
    }
  ]
}

Kesalahan

  • Periksa status.code dan status.msg untuk mengetahui kesalahan autentikasi atau layanan. Katalog kosong yang berhasil dikembalikan bukanlah persetujuan atas suatu dokumen atau pembebasan dari kewajiban pendaftaran.

Ketersediaan dan efek samping

  • Pencarian katalog/persyaratan ini tidak membuat identitas, mengunggah bukti, mendaftarkan nomor, atau melakukan pemesanan.
  • Respons katalog yang berhasil bukanlah persetujuan atas dokumen Anda atau konfirmasi bahwa nomor yang dipilih dapat diaktifkan.