Pasirinkite jūsų paskyroje jau esantį prekės ženklą
Pradėkite nuo registro prekės ženklo identifikatoriaus, jau susieto su jūsų MultiTEL paskyra. Ši paieška nesukuria prekės ženklo ir nepriskiria svetimo prekės ženklo jūsų paskyrai. Dabartinėje kliento darbo eigoje prieš užklausant tinkamumo duomenų patikrinama nuosavybė. Jei paieška grąžina 404, patikrinkite pasirinktą paskyrą ir prekės ženklą, o ne pakeiskite identifikatorių vietinės eilutės identifikatoriumi.
Sudarykite naudojimo atvejų pasirinkimus pagal šį rezultatą
Bendrajame naudojimo atvejų kataloge aprašomi registro siūlomi variantai. Ši konkrečiam prekės ženklui skirta paieška pateikia pasirinktam prekės ženklui prieinamus variantus. Išsaugokite kiekvieną grąžintą usecase reikšmę ir susiekite ją su kataloge pateiktu rodomu pavadinimu bei aprašu. Nesiūlykite visų bendrojo katalogo įrašų taip, tarsi prekės ženklas atitiktų kiekvieno iš jų reikalavimus.
Portalas tikisi, kad šis atsakymas bus JSON sąrašas. Jei atsakymo nėra, jo formatas netinkamas arba grąžinta klaida, išsaugokite kliento formą ir parodykite, kad nepavyko įkelti tinkamumo duomenų. Nelaikykite to numatytojo naudojimo atvejo patvirtinimu nepranešę klientui. Registras gali grąžinti ir laukų, kurių nėra sutrumpintame pavyzdyje.
Įkelkite pasirinkto naudojimo atvejo reikalavimus
Klientui pasirinkus vieną iš grąžintų naudojimo atvejo reikšmių, pateikite užklausą adresu /tcr/v2/campaignBuilder/brand/{brand_id}/usecase/{usecase} tam pačiam prekės ženklui. Šis atsakymas pateikia naudojimo atvejų potipių ribas ir konkrečių operatorių reikalavimus. Remdamiesi juo surinkite pranešimų pavyzdžius, sutikimą ir kitus privalomus pareiškimus. Vien tinkamumo sąrašo nepakanka visai kampanijos registracijos užklausai parengti.
Atskirai peržiūrėkite paskyrai taikomas kainas
Teikėjo laukai, pavyzdžiui, monthlyFee, quarterlyFee arba annualFee, jei jie grąžinami, aprašo teikėjo mokesčių metaduomenis. Jie nepakeičia kliento paskyrai taikomos kainos ar registracijos sąlygų. Dabartinis portalas mažmenines kampanijų kainas nuskaito atskirai ir peržiūros ekrane sujungia jas su tinkamumo duomenimis. Nustatydami klientui taikomą mokestį nesiremkite senosios išvardijimo tipo pagalbinės priemonės kode įrašytomis kainomis.
Atnaujinkite duomenis pasikeitus prekės ženklui ar naudojimo atvejui
Keisdami prekės ženklą pašalinkite ankstesnio prekės ženklo pasirinkimus ir įkelkite naujo pasirinkimo tinkamumo duomenis. Prieš pateikdami registracijos užklausą atnaujinkite pasirinkto naudojimo atvejo reikalavimus. Šios GET užklausos nepateikia registracijos, neaktyvina kampanijos ir nepriskiria numerių.
Užklausa
Naudokite įjungtą API paskyrą per HTTPS iš leidžiamo šaltinio IP adreso. Dabartinis maršrutas palaiko paskyros autentifikavimo politiką, įskaitant Basic autentifikavimą ir įjungtas API paskyras, autentifikuojamas prieigos žetonu. Nenaudokite teikėjo prisijungimo duomenų.
GET užklausa su prekės ženklo identifikatoriumi URL kelyje. Užklausos turinio nereikia.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID"| Pavadinimas | Tipas | Privalomas | Aprašas |
|---|---|---|---|
brand_id | simbolių eilutė | Taip | Registro prekės ženklo identifikatorius, susietas su jūsų autentifikuota MultiTEL paskyra. Naudokite prekės ženklo identifikatorių, o ne vietinės duomenų bazės eilutės identifikatorių, kampanijos identifikatorių ar įmonės mokesčių mokėtojo numerį. Užkoduokite jį kaip vieną URL kelio segmentą. |
Atsakymas
Dabartinis TCR maršrutas tiesiogiai grąžina registro JSON turinį ir išsaugo jo HTTP būseną. Jis neprideda senojo v3 status/response apvalkalo. Sutrumpintas išgalvotas pavyzdys nėra tikrasis tinkamumo patikros rezultatas. Prieš naudodami atsakymą patikrinkite HTTP būseną ir numatomą JSON struktūrą. Dabartinis portalas tikisi tinkamumo įrašų sąrašo, kurio kiekviename įraše nurodytas usecase. Portalas sujungia šiuos įrašus su usecase katalogu, kad gautų rodomus pavadinimus, o mažmenines kainas nuskaito atskirai. Gali būti ir papildomų teikėjo laukų.
Iliustracinė atsakymo struktūra; tai nėra tikrieji paskyros duomenys ar aktualus kainos pasiūlymas.
[
{
"usecase": "2FA"
}
]Klaidos
- 401: Nepavyko autentifikuoti paskyros. Patikrinkite API prisijungimo duomenis, ar paskyra įjungta, ir taikomus šaltinio IP adreso apribojimus.
- 404: Prekės ženklas nesusietas su autentifikuota paskyra arba teikėjas negali rasti užklausto prekės ženklo ar pasirinkimo. Vietinis atsisakymas dėl nuosavybės patikros grąžinamas prieš siunčiant užklausą teikėjui.
- Kitos registro klaidos: Išsaugoma iš registro gauta HTTP būsena ir atsakymo turinys. Netinkamas arba neprieinamas naudojimo atvejis nereiškia sėkmingai gauto tuščio reikalavimų rinkinio.
- 429: Pasiekta paskyros arba bendra teikėjo užklausų riba. Laikykitės Retry-After nurodymo.
- 502/503: Ryšio sutrikimas arba teikėjo ar užklausų dažnio ribotuvo neprieinamumas. Išsaugokite formą ir bandykite dar kartą, didindami intervalus tarp bandymų.
Prieinamumas ir šalutiniai poveikiai
- Peržiūrėta GET užklausa patikrina esamo prekės ženklo nuosavybę, susisiekia su registru ir įrašo užklausų audito įrašus. Ji nesukuria prekės ženklo ar kampanijos ir nenuskaičiuoja registracijos mokesčio.
- Teikėjo mokesčių metaduomenys nėra MultiTEL klientui skirtas mažmeninės kainos pasiūlymas. Prieš vėliau pateikiamą registracijos užklausą portalas atskirai peržiūri paskyrai taikomas kainas.
- Tinkamumas ir reikalavimai gali keistis. Prieš pateikdami registracijos užklausą atnaujinkite pasirinkto prekės ženklo ir naudojimo atvejo duomenis. Sėkminga paieška nėra kampanijos patvirtinimas, numerio priskyrimas ar leidimas pradėti siųsti pranešimus.