Atlasiet savā kontā jau esošu zīmolu
Sāciet ar reģistra zīmola ID, kas jau ir saistīts ar jūsu MultiTEL kontu. Šī uzmeklēšana neizveido zīmolu un nepiesaista jūsu kontam citas personas zīmolu. Pašreizējā klienta darbplūsma pārbauda īpašumtiesības, pirms pieprasa datus par atbilstību lietojuma veidiem. Ja uzmeklēšana atgriež 404, pārbaudiet atlasīto kontu un zīmolu, nevis aizstājiet identifikatoru ar lokālas rindas ID.
Veidojiet lietojuma veidu izvēles iespējas no šī rezultāta
Vispārīgais lietojuma veidu katalogs apraksta reģistra piedāvātās iespējas. Šī konkrētā zīmola uzmeklēšana sniedz atlasītajam zīmolam pieejamās izvēles iespējas. Saglabājiet katru atgriezto usecase vērtību un apvienojiet to ar katalogā norādīto attēlojamo nosaukumu un aprakstu. Nepiedāvājiet visus vispārīgā kataloga ierakstus tā, it kā zīmols atbilstu katram no tiem.
Portāls sagaida, ka šī atbilde būs JSON saraksts. Ja atbildes nav, tā ir nepareizi strukturēta vai ir kļūdas atbilde, saglabājiet klienta veidlapu un parādiet, ka datus par atbilstību neizdevās ielādēt. Neuzskatiet to bez brīdinājuma par noklusējuma lietojuma veida apstiprinājumu. Reģistrs var atgriezt arī laukus, kas nav parādīti saīsinātajā piemērā.
Ielādējiet atlasītā lietojuma veida prasības
Kad klients izvēlas kādu no atgrieztajām lietojuma veida vērtībām, pieprasiet /tcr/v2/campaignBuilder/brand/{brand_id}/usecase/{usecase} tam pašam zīmolam. Šī atbilde sniedz lietojuma apakšveidu ierobežojumus un konkrēto operatoru prasības. Izmantojiet to, lai apkopotu ziņojumu paraugus, piekrišanu un citus obligātos apliecinājumus. Ar atbilstības sarakstu vien nepietiek, lai sagatavotu pilnīgu kampaņas reģistrācijas pieteikumu.
Atsevišķi pārskatiet kontam piemērotās cenas
Pakalpojumu sniedzēja lauki, piemēram, monthlyFee, quarterlyFee vai annualFee, ja tie tiek atgriezti, apraksta pakalpojumu sniedzēja maksu metadatus. Tie neaizstāj klienta kontam piemēroto cenu vai reģistrācijas noteikumus. Pašreizējais portāls atsevišķi nolasa kampaņu mazumtirdzniecības cenas un pārskatīšanas ekrānā apvieno tās ar atbilstības datiem. Neizseciniet klientam piemērojamo maksu no vecās uzskaitījuma tipa palīgfunkcijas kodā fiksētajām cenām.
Atjauniniet datus, mainoties zīmolam vai lietojuma veidam
Mainot zīmolu, atmetiet iepriekšējā zīmola izvēles iespējas un ielādējiet jaunajai atlasei atbilstošos atbilstības datus. Pirms iesniegšanas atjauniniet atlasītā lietojuma veida prasības. Šie GET pieprasījumi neiesniedz reģistrācijas pieteikumu, neaktivizē kampaņu un nepiešķir numurus.
Pieprasījums
Izmantojiet iespējotu API kontu, savienojoties ar HTTPS no atļautas avota IP adreses. Pašreizējais maršruts atbalsta konta autentifikācijas politiku, tostarp Basic autentifikāciju un iespējotus API kontus ar uzrādītāja pilnvaras autentifikāciju. Neizmantojiet pakalpojumu sniedzēja akreditācijas datus.
GET pieprasījums ar zīmola identifikatoru URL ceļā. Pieprasījuma pamatdaļa nav nepieciešama.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID"| Nosaukums | Tips | Obligāts | Apraksts |
|---|---|---|---|
brand_id | virkne | Jā | Reģistra zīmola ID, kas saistīts ar jūsu autentificēto MultiTEL kontu. Izmantojiet zīmola ID, nevis lokālas datubāzes rindas ID, kampaņas ID vai uzņēmuma nodokļu maksātāja numuru. Kodējiet to kā vienu URL ceļa segmentu. |
Atbilde
Pašreizējais TCR maršruts tieši atgriež reģistra JSON pamatdaļu un saglabā tās HTTP statusu. Tas nepievieno mantoto v3 status/response ietvaru. Saīsinātais izdomātais piemērs nav faktisks atbilstības pārbaudes rezultāts. Pirms atbildes izmantošanas pārbaudiet HTTP statusu un paredzēto JSON struktūru. Pašreizējais portāls sagaida atbilstības ierakstu sarakstu, kurā katrs ieraksts norāda usecase. Lai iegūtu attēlojamos nosaukumus, tas apvieno šos ierakstus ar usecase katalogu un atsevišķi nolasa mazumtirdzniecības cenas. Var būt iekļauti papildu pakalpojumu sniedzēja lauki.
Ilustratīva atbildes struktūra; tie nav faktiski konta dati vai aktuāls cenas piedāvājums.
[
{
"usecase": "2FA"
}
]Kļūdas
- 401: Konta autentifikācija neizdevās. Pārbaudiet API akreditācijas datus, vai konts ir iespējots, un piemērojamos avota IP adreses ierobežojumus.
- 404: Zīmols nav saistīts ar autentificēto kontu vai pakalpojumu sniedzējs nevar atrast pieprasīto zīmolu vai atlasi. Lokāls īpašumtiesību pārbaudes atteikums tiek atgriezts pirms pieprasījuma nosūtīšanas pakalpojumu sniedzējam.
- Citas reģistra kļūdas: tiek saglabāts augšupējā pakalpojuma HTTP statuss un pamatdaļa. Nederīgs vai nepieejams lietojuma veids nenozīmē veiksmīgu atbildi ar tukšu prasību kopu.
- 429: Sasniegts konta vai koplietojamais pakalpojumu sniedzēja pieprasījumu limits. Ievērojiet Retry-After norādīto gaidīšanas laiku.
- 502/503: Transporta, pakalpojumu sniedzēja vai pieprasījumu biežuma ierobežotāja pieejamības kļūme. Saglabājiet veidlapu un atkārtojiet pieprasījumu, pakāpeniski palielinot gaidīšanas laiku.
Pieejamība un blakusefekti
- Pārskatītais GET pieprasījums pārbauda esošā zīmola īpašumtiesības, sazinās ar reģistru un ieraksta pieprasījuma audita ierakstus. Tas neizveido zīmolu vai kampaņu un neiekasē reģistrācijas maksu.
- Pakalpojumu sniedzēja maksu metadati nav MultiTEL klientam paredzēts mazumtirdzniecības cenas piedāvājums. Pirms vēlākā reģistrācijas pieprasījuma portāls atsevišķi pārskata kontam piemērotās cenas.
- Atbilstība un prasības var mainīties. Pirms iesniegšanas atjauniniet šos datus atlasītajam zīmolam un lietojuma veidam. Veiksmīga uzmeklēšana nav kampaņas apstiprinājums, numuru piešķiršana vai atļauja sākt ziņojumu sūtīšanu.