Sõnumside registreerimiskataloogide laadimine

Laadige valikud enne registreerimisvormi koostamist

Kasutage valikute täitmiseks praegust sõnumside registreerimiskataloogi, selle asemel et registri väärtused koodi sisse kirjutada. Kaubamärgi vormi jaoks laadib portaal ettevõtlusvormide, tegevusalade, alternatiivsete ettevõttetunnuste tüüpide, kaubamärgiga seoste, riikide, USA osariikide ja börside kataloogid. Kampaania vormi jaoks laadib see kasutusjuhud, kehtivad alamkasutusjuhud ja ühenduspartnerid. Säilitage iga tagastatud masinloetav väärtus koos selle kuvatava nimetusega; hilisema päringu koostamisel kasutage väärtust, mitte tõlgitud nimetust.

Valige kataloog

Portaalis kasutatavad kataloogid
Nimi	Otstarve
usecase	Kampaania kasutusjuhtude määratlused. Alamkasutusjuhtude valikute laadimisel lisage validSubUsecase=true.
entityType	Kaubamärgi ettevõtlusvorm või organisatsiooni tüüp.
vertical	Kaubamärgi tegevusala valikud.
altBusinessIdType	Alternatiivsete ettevõttetunnuste kategooriad.
brandRelationship	Registreerimisvormis kasutatavad seose valikud.
country	Registri riigivalikud; need on eraldi riikidest, kus telefoninumbrid on saadaval.
usState	USA osariikide valikud registreerimisaadresside jaoks.
stockExchange	Börside valikud, kui kaubamärgi ettevõtlusvorm neid nõuab.
cnp	Ühenduspartnerite tunnused. Valige partner, mida teie konto kampaania töövoog toetab.

Töödelge TCR vastust otse

Vastuse sisu pärineb otse TCR API liidesest. Erinevalt paljudest vanematest /v3 lõpp-punktidest puudub sellel lisatud status/response ümbris. Enne vastuse tõlgendamist kontrollige HTTP olekut. Kataloog võib sisaldada stringikujulisi nimetusi või struktureeritud määratlusi, seega ärge eeldage, et igal väärtusel on samad väljad. Kui HTTP päring õnnestub, kuid sisu ei ole oodatud struktuuriga kehtiv JSON, teatage päringu ebaõnnestumisest, selle asemel et tulemus märkamatult tühja loendiga asendada.

Käsitlege kataloogivalikuid sobivusest ja hinnastamisest eraldi

Üldine kasutusjuhtude kataloog ei näita, milliste kasutusjuhtude tingimustele konkreetne kaubamärk vastab. Praegune portaal teeb enne kampaania loomist kaubamärgipõhise sobivuspäringu ja kontrollib valitud sideoperaatori nõudeid. Samuti ei ole tarnija tasude metaandmed konto lõplik jaehind. Vaadake kontole kohaldatav hind ja registreerimistingimused eraldi üle. Kataloogi laadimine ei kinnita kaubamärki, kampaaniat ega sõnumside numbrit.

Toimige kättesaamatute kataloogide korral järgmiselt

Kui päring ebaõnnestub, säilitage kliendi vormisisestused. Kuvage viga, järgige Retry-After päist, kui see tagastatakse, ning pikendage korduskatsete vahelist ooteaega järk-järgult. Ärge laadige kõiki katalooge korduvalt uuesti ega käsitlege päringusageduse piirangu või andmeedastuse viga tühja kehtiva kataloogina. See GET päring ei vaja idempotentsusvõtit ja seda ei taasesitata muutmistoimingute idempotentsushoidlast.

Päring

Kasutage lubatud lähte-IP-aadressilt aktiveeritud API kontot HTTPS ühenduse kaudu. Praegune marsruut toetab konto autentimispoliitikat, sealhulgas Basic autentimist ja aktiveeritud API kontosid, mis kasutavad esitajatõendiga autentimist. Ärge kasutage teenusepakkuja autentimisandmeid.

Kasutage GET päringut, mille tees on toetatud kataloogi nimi. Edastage kohaldatavad kataloogifiltrid päringustringis. Päringu sisu ei ole vaja.

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

Teeparameetrid
Nimi	Tüüp	Kohustuslik	Kirjeldus
`type`	stringväärtus	Jah	Kataloogi nimi algse suur- ja väiketähtede kasutusega. Portaal kasutab nimesid usecase, entityType, vertical, altBusinessIdType, brandRelationship, country, usState, stockExchange ja cnp. Need on kataloogide nimed, mitte kaubamärkide või kampaaniate tunnused.

Päringuparameetrid
Nimi	Tüüp	Kohustuslik	Kirjeldus
`validSubUsecase`	tõeväärtus	Ei	Kataloogi usecase puhul kasutab portaal päringus väärtust true, et laadida kehtivate alamkasutusjuhtude valikud. Tavalise kasutusjuhtude kataloogi laadimisel jätke see parameeter välja. Kättesaadavuse teabe ja määratlused annab register.

Vastus

See TCR marsruut tagastab registri vastuse sisu otse koos selle HTTP olekuga. See ei kasuta vanemat v3 status.code/status.msg/response ümbrist. Kataloogide struktuurid erinevad: mõned seovad väärtused kirjeldavate objektidega, teised stringidega. Hilisema vormi esitamisel säilitage masinloetavad võtmed. Lühendatud väljamõeldud usecase näide illustreerib objektiväärtustega vastendust, mitte tegelikku kataloogi ega garanteeritult täielikku skeemi. Kontrollige nii HTTP olekut kui ka oodatud JSON struktuuri.

Vastuse näidisstruktuur; see ei sisalda tegelikke kontoandmeid ega kehtivat hinnapakkumist.

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

Vead

401: Konto autentimine ebaõnnestus. Kontrollige API autentimisandmeid, konto aktiveeritust ja kohaldatavaid lähte-IP-aadressi piiranguid.
400/404 ja muud registrivead: vigane või kättesaamatu kataloog või filter. Praegune marsruut säilitab ülesvooluteenuse HTTP oleku ja vastuse sisu; universaalset v3 veaümbrist ei ole.
429: Saavutatud on konto või teenusepakkuja jagatud päringulimiit. Järgige Retry-After päist ja proovige uuesti, pikendades korduskatsete vahelist ooteaega järk-järgult.
502: Registriga ei saadud ühendust. Kättesaadavus on teadmata; ärge asendage tulemust tühjade valikutega, esitades neid õnnestunud tulemusena.
503: Päringupiiraja või ülesvooluteenus ei ole kättesaadav. Enne uuesti proovimist kontrollige vastuse sisu ja Retry-After päist, kui see on olemas.

Kättesaadavus ja kõrvalmõjud

Üle vaadatud täitmisteel ei loo see kataloogi GET päring kaubamärki ega kampaaniat, ei esita registreerimistaotlust, ei reserveeri ressurssi ega võta registreerimistasu. See võtab ühendust teenusepakkujaga ja kirjutab päringute auditikirjed.
Kataloogide määratlused ja tarnija tasude metaandmed ei ole kliendile mõeldud jaehinnapakkumine. Praegune portaal hangib kampaaniate jaehinnad eraldi; pärandabifunktsiooni getCampaignPrice ja vanu loendite hinnamärkusi ei tohi käsitleda selle marsruudi hinnastamislepinguna.
Toetatud kataloogikirje ei tõenda, et konkreetne kaubamärk vastab selle kasutusjuhu tingimustele. Enne hilisemat registreerimispäringut viige lõpule kaubamärgipõhine sobivuskontroll, deklaratsioonide esitamine, nõusoleku saamine ja konto hinnastuse ülevaatus.