A sablonkatalógus böngészése
A szolgáltatás által visszaadott sablonok listázásához hagyja el az opcionális ISO útvonalszegmenst. A lista szűréséhez adjon meg egy ISO országkódot. A szűrő a sablon országra utaló adatát veszi alapul, amely a névből is származhat, és üres is lehet.
Sablon kiválasztása a követelmények alapján
Egy sablon jelenléte nem jelenti azt, hogy az adott ország minden telefonszámához kötelező vagy elfogadott. Vesse össze a sablon azonosítóját az igazoló dokumentumokra vonatkozó követelményekkel. Ez a lista nem hoz létre, nem ír alá, nem tölt fel és nem hagy jóvá kitöltött dokumentumot.
Ha nem érkezik vissza egyetlen sablon sem
Az üres szűrt lista azt jelentheti, hogy nem található egyező, országra utaló adat. Az üres, szűrés nélküli lista azt is jelezheti, hogy a háttérben használt adatforrás adatai nem érhetők el. Egyik eredményt se tekintse annak bizonyítékának, hogy nincs szükség igazoló dokumentumra.
Használat előtt ellenőrizze a letöltött példányt
A katalógusban található letöltési hivatkozás olyan példányt is visszaadhat, amelynek formázása vagy arculati elemei módosultak. Ne feltételezze, hogy ez az eredeti megállapodás változatlan példánya, vagy hogy a letöltés teljesít egy regisztrációs követelményt. Bármely dokumentum kitöltése vagy aláírása előtt ellenőrizze annak tartalmát.
Ha a portál dokumentumvarázslója lehetővé teszi megállapodás előkészítését, használja az előnézeti funkcióját és a kifejezett beküldést igénylő munkafolyamatát. Más kötelező űrlapok esetén kitöltés előtt egyeztesse a MultiTEL-lel, hogy melyik űrlap az aktuális. A letöltött sablon nem minősül aláírt mellékletnek, feltöltött igazolásnak vagy telefonszám jóváhagyásának.
Kérés
Használja engedélyezett API-fiókjának hitelesítő adatait HTTPS-en keresztül. A Basic hitelesítés és az engedélyezett API-fiókhoz tartozó bearer tokenek támogatottak; a fiókra vonatkozó korlátozások érvényesek.
GET kérés, amelynek URL-útvonalában bármely dokumentált paraméter megadható.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/get_supporting_document_templates/$COUNTRY_ISO"| Név | Típus | Kötelező | Leírás |
|---|---|---|---|
iso | string | Nem | Opcionális szűrő ISO országkód alapján. A szűrés nélküli listához hagyja el ezt a teljes útvonalszegmenst. Az összehasonlítás nem tesz különbséget kis- és nagybetűk között. Ismeretlen vagy egyezés nélküli értékek esetén üres lista érkezik vissza, nem pedig az érvénytelen országot kifejezetten jelző hiba. |
Válasz
A HTTP-állapot mellett ellenőrizze a JSON-törzsben a status.code értékét is. A response olyan objektumok tömbje, amelyek mezői: id, name, permanent, iso és url. A permanent típusa boolean; az iso üres is lehet, és a sablon nevéből is származhat. Az országra vonatkozó információt támpontként kezelje, ne a jogosultságról hozott döntésként. Az üres katalógus sikeres, 200 állapotú válasznak minősül, és akkor is előfordulhat, ha a háttérben használt adatforrás lekérdezése nem ad vissza adatot. Az URL-t a szolgáltatás állítja elő; a benne szereplő gépnév eltérhet a szemléltető példában megadottól.
A válasz szerkezetét szemléltető példa; nem élő fiókadat és nem aktuális árajánlat.
{
"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"
}
]
}Hibák
- Hitelesítési vagy szolgáltatási hibák esetén ellenőrizze a status.code és a status.msg értékét. A sikeresen visszaadott üres katalógus nem jelenti dokumentum jóváhagyását vagy a regisztráció alóli mentességet.
Elérhetőség és mellékhatások
- Ez a katalógus- és követelmény-lekérdezés nem hoz létre személyazonossági profilt, nem tölt fel igazolást, nem regisztrál telefonszámot és nem ad le megrendelést.
- A sikeres katalógusválasz nem jelenti dokumentumai jóváhagyását, és nem igazolja, hogy egy kiválasztott telefonszám aktiválható.