Shfletoni katalogun e modeleve
Hiqni segmentin opsional ISO nga shtegu për të listuar modelet e kthyera nga shërbimi. Jepni kodin ISO të një shteti për të filtruar listën. Filtri kërkon përputhje me treguesin e shtetit të modelit, i cili mund të jetë nxjerrë nga një emër dhe mund të jetë bosh.
Përdorni kërkesat për të zgjedhur një model
Prania e një modeli nuk do të thotë se ai kërkohet ose pranohet për çdo numër në atë shtet. Përputhni ID-në e modelit me kërkesat përkatëse për dokumentet mbështetëse. Kjo listë nuk gjeneron, nënshkruan, ngarkon apo miraton një dokument të plotësuar.
Nëse nuk kthehet asnjë model
Një listë e filtruar bosh mund të nënkuptojë se nuk u gjet asnjë tregues shteti që përputhet. Një listë e pafiltruar bosh mund të pasqyrojë gjithashtu mungesën e të dhënave nga sistemi burimor. Mos e trajtoni asnjërin rezultat si provë se nuk kërkohet asnjë dokument mbështetës.
Shqyrtoni një kopje të shkarkuar përpara se ta përdorni
Një lidhje shkarkimi nga katalogu mund të kthejë një kopje me ndryshime në formatim ose në elementet e markës. Mos supozoni se ajo është një marrëveshje origjinale e pandryshuar ose se shkarkimi i saj përmbush një kërkesë regjistrimi. Shqyrtoni përmbajtjen përpara se të plotësoni ose nënshkruani çfarëdo dokumenti.
Kur asistenti i dokumenteve në portal ofron përgatitjen e marrëveshjes, përdorni pamjen paraprake dhe rrjedhën e tij të punës me dorëzim të shprehur qartë. Për formularët e tjerë të kërkuar, konfirmoni me MultiTEL formularin aktual përpara se ta plotësoni. Një model i shkarkuar nuk është një bashkëngjitje e nënshkruar, një dëshmi e ngarkuar apo miratim i një numri.
Kërkesa
Përdorni kredencialet e llogarisë suaj të aktivizuar të API-së përmes HTTPS. Mbështeten autentikimi Basic dhe tokenët bearer të aktivizuar të llogarisë së API-së; zbatohen kufizimet e llogarisë.
GET me çdo parametër të dokumentuar në shtegun e URL-së.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/get_supporting_document_templates/$COUNTRY_ISO"| Emri | Lloji | I detyrueshëm | Përshkrimi |
|---|---|---|---|
iso | string | Jo | Filtër opsional sipas kodit ISO të shtetit. Hiqni të gjithë këtë segment të shtegut për të marrë listën e pafiltruar. Krahasimi nuk bën dallim mes shkronjave të mëdha dhe të vogla. Vlerat e panjohura ose pa përputhje kthejnë një listë bosh në vend të një gabimi të shprehur qartë për shtet të pavlefshëm. |
Përgjigjja
Kontrolloni status.code në trupin JSON, si dhe statusin HTTP. response është një varg objektesh me fushat id, name, permanent, iso dhe url. permanent është një vlerë e tipit boolean; iso mund të jetë bosh dhe mund të jetë nxjerrë nga emri i modelit. Trajtojeni informacionin për shtetin si tregues, jo si vendim për përmbushjen e kushteve. Një katalog bosh është një përgjigje e suksesshme 200 dhe mund të rezultojë edhe kur kërkimi në sistemin burimor nuk jep të dhëna. URL-ja gjenerohet nga shërbimi; emri i hostit të saj mund të ndryshojë nga ai në shembullin ilustrues.
Strukturë ilustruese e përgjigjes; nuk përmban të dhëna të drejtpërdrejta të llogarisë apo një ofertë çmimi aktuale.
{
"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"
}
]
}Gabimet
- Kontrolloni status.code dhe status.msg për gabime autentikimi ose shërbimi. Një katalog bosh i kthyer me sukses nuk përbën miratim të një dokumenti apo përjashtim nga regjistrimi.
Disponueshmëria dhe efektet anësore
- Ky kërkim në katalog ose në kërkesa nuk krijon një identitet, nuk ngarkon një dëshmi, nuk regjistron një numër dhe nuk bën një porosi.
- Një përgjigje e suksesshme e katalogut nuk përbën miratim të dokumenteve tuaja apo konfirmim se një numër i zgjedhur mund të aktivizohet.