Įkelti pranešimų siuntimo registracijos katalogus

Prieš kurdami registracijos formą įkelkite pasirinkimo reikšmes

Pasirinkimo laukus užpildykite iš dabartinio pranešimų siuntimo registracijos katalogo, užuot registro reikšmes įrašę tiesiai į programos kodą. Prekės ženklo formai portalas įkelia verslo tipo, veiklos srities, alternatyvaus verslo identifikatoriaus tipo, ryšio su prekės ženklu, šalies, JAV valstijos ir vertybinių popierių biržos katalogus. Kampanijos formai jis įkelia naudojimo atvejus, galiojančius jų potipius ir ryšio partnerius. Kiekvieną grąžintą mašininę reikšmę saugokite kartu su jos rodoma etikete; kurdami vėlesnę užklausą naudokite reikšmę, o ne išverstą etiketę.

Pasirinkite katalogą

Apdorokite TCR atsakymą tiesiogiai

Atsakymo turinį tiesiogiai pateikia TCR API. Kitaip nei daugelis senesnių /v3 galinių taškų, jis neturi papildomo status/response apvalkalo. Prieš interpretuodami turinį patikrinkite HTTP būseną. Kataloge gali būti tekstinių etikečių arba struktūrinių apibrėžčių, todėl nemanykite, kad visos reikšmės turi tuos pačius laukus. Jei HTTP užklausa sėkminga, bet turinys nėra tinkamas numatytos struktūros JSON, praneškite apie nepavykusią paiešką, užuot tyliai pakeitę rezultatą tuščiu sąrašu.

Atskirkite katalogo pasirinkimus nuo tinkamumo nustatymo ir kainodaros

Bendras naudojimo atvejų katalogas neparodo, kuriems naudojimo atvejams konkretus prekės ženklas atitinka reikalavimus. Dabartinis portalas prieš kurdamas kampaniją atlieka konkretaus prekės ženklo tinkamumo patikrą ir patikrina pasirinktų operatorių reikalavimus. Taip pat tiekėjo mokesčių metaduomenys nėra galutinė paskyrai taikoma mažmeninė kaina. Atskirai peržiūrėkite paskyrai taikomą kainą ir registracijos sąlygas. Katalogo įkėlimas nepatvirtina prekės ženklo, kampanijos ar pranešimų siuntimo numerio.

Tvarkykite atvejus, kai katalogai nepasiekiami

Jei paieška nepavyksta, išsaugokite kliento formoje įvestus duomenis. Parodykite klaidą, laikykitės Retry-After nurodymų, kai ši antraštė grąžinama, ir ilginkite intervalus tarp pakartotinių bandymų. Neįkelkite visų katalogų iš naujo pakartotinai ir nelaikykite užklausų dažnio ribojimo ar perdavimo klaidos tuščiu galiojančiu katalogu. Šiai GET užklausai nereikia idempotentiškumo rakto, o jos atsakymas neatkuriamas iš duomenis keičiančių operacijų idempotentiškumo saugyklos.

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 su prieigos žetono autentifikavimu. Nenaudokite teikėjo prisijungimo duomenų.

Siųskite GET užklausą, kelyje nurodydami palaikomą katalogo pavadinimą. Taikomus katalogo filtrus perduokite užklausos eilutėje. Užklausos turinio nereikia.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/enum/usecase?validSubUsecase=true"

Atsakymas

Šis TCR maršrutas tiesiogiai grąžina registro atsakymo turinį su jo HTTP būsena. Jis nenaudoja senesnio v3 status.code/status.msg/response apvalkalo. Katalogų struktūros skiriasi: vienuose reikšmės susiejamos su aprašomaisiais objektais, kituose – su simbolių eilutėmis. Vėliau pateikdami formą išsaugokite mašininiu būdu skaitomus raktus. Sutrumpintas išgalvotas usecase pavyzdys iliustruoja atvaizdį, kurio reikšmės yra objektai, o ne veikiantį katalogą ar garantuotai išsamią schemą. Patikrinkite ir HTTP būseną, ir numatytą JSON struktūrą.

Iliustracinė atsakymo struktūra; tai nėra tikrieji paskyros duomenys ar dabartinis kainos pasiūlymas.

{
  "2FA": {
    "displayName": "Authentication",
    "description": "Example authentication use case"
  }
}

Klaidos

• 401: Nepavyko autentifikuoti paskyros. Patikrinkite API prisijungimo duomenis, ar paskyra įjungta, ir taikomus šaltinio IP adresų apribojimus.
• 400/404 ir kitos registro klaidos: netinkamas arba nepasiekiamas katalogas ar filtras. Dabartinis maršrutas išsaugo aukštesnės grandies tarnybos HTTP būseną ir atsakymo turinį; universalaus v3 klaidų apvalkalo nėra.
• 429: Pasiektas paskyros arba bendras teikėjo užklausų limitas. Laikykitės Retry-After nurodymų ir kartokite bandymus ilgindami intervalus.
• 502: Nepavyko pasiekti registro. Prieinamumas nežinomas; nepateikite tuščio pasirinkimų sąrašo kaip sėkmingo rezultato.
• 503: Užklausų ribotuvas arba aukštesnės grandies tarnyba nepasiekiama. Prieš bandydami dar kartą patikrinkite atsakymo turinį ir Retry-After antraštę, jei ji pateikta.

Prieinamumas ir šalutinis poveikis

• Ši katalogo GET užklausa peržiūrėtame vykdymo kelyje nesukuria prekės ženklo ar kampanijos, nepateikia registracijos, nerezervuoja ištekliaus ir neapmokestina registracijos mokesčiu. Ji susisiekia su teikėju ir įrašo užklausos audito įrašus.
• Katalogų apibrėžtys ir bet kokie tiekėjo mokesčių metaduomenys nėra klientui skirtas mažmeninės kainos pasiūlymas. Dabartinis portalas kampanijų mažmenines kainas gauna atskirai; pasenusi pagalbinė funkcija getCampaignPrice ir senos išvardijamųjų reikšmių kainų anotacijos neturi būti laikomos šio maršruto kainodaros sutartimi.
• Palaikomas katalogo įrašas neįrodo, kad konkretus prekės ženklas atitinka to naudojimo atvejo reikalavimus. Prieš vėliau pateikdami registracijos užklausą atlikite konkretaus prekės ženklo tinkamumo patikrą, užpildykite deklaracijas, gaukite sutikimą ir peržiūrėkite paskyrai taikomą kainodarą.