Ielādēt ziņojumapmaiņas reģistrācijas katalogus

Ielādējiet izvēles iespējas pirms reģistrācijas veidlapas izveides

Izvēles iespēju aizpildīšanai izmantojiet aktuālo ziņojumapmaiņas reģistrācijas katalogu, nevis iekodējiet reģistra vērtības programmā. Zīmola veidlapai portāls ielādē uzņēmējdarbības veidu, nozaru, alternatīvo uzņēmuma identifikatoru veidu, saistības ar zīmolu, valstu, ASV štatu un biržu katalogus. Kampaņas veidlapai tas ielādē lietojuma veidus, derīgus lietojuma apakšveidus un savienojamības partnerus. Saglabājiet katru atgriezto mašīnvērtību kopā ar tās attēlojamo nosaukumu; veidojot vēlāku pieprasījumu, izmantojiet vērtību, nevis tulkoto nosaukumu.

Izvēlieties katalogu

Apstrādājiet TCR atbildi tieši

Atbildes saturs nāk tieši no TCR API. Atšķirībā no daudziem vecākiem /v3 galapunktiem tai nav pievienots status/response ietvars. Pirms atbildes interpretēšanas pārbaudiet HTTP statusu. Katalogā var būt nosaukumi virkņu veidā vai strukturētas definīcijas, tādēļ nepieņemiet, ka katrai vērtībai ir vienādi lauki. Ja HTTP pieprasījums ir veiksmīgs, bet saturs nav derīgs JSON ar paredzēto struktūru, ziņojiet par neveiksmīgu uzmeklēšanu, nevis nemanāmi aizstājiet rezultātu ar tukšu sarakstu.

Nošķiriet kataloga izvēles iespējas no atbilstības un cenu noteikšanas

Vispārīgs lietojuma veidu katalogs nenorāda, kuriem lietojuma veidiem konkrētais zīmols atbilst. Pašreizējais portāls pirms kampaņas izveides veic konkrētā zīmola atbilstības uzmeklēšanu un pārbauda izvēlētā operatora prasības. Tāpat piegādātāja maksu metadati nav konta galīgā mazumtirdzniecības cena. Atsevišķi pārskatiet kontam piemērojamo cenu un reģistrācijas noteikumus. Kataloga ielāde neapstiprina zīmolu, kampaņu vai ziņojumapmaiņas numuru.

Rīcība, ja katalogi nav pieejami

Ja uzmeklēšana neizdodas, saglabājiet klienta veidlapā ievadītos datus. Parādiet kļūdu, ievērojiet Retry-After norādi, ja tā ir atgriezta, un pakāpeniski palieliniet intervālu starp atkārtotiem mēģinājumiem. Neielādējiet visus katalogus atkal un atkal un neuzskatiet pieprasījumu biežuma ierobežojuma vai transporta kļūdu par tukšu, derīgu katalogu. Šim GET pieprasījumam nav nepieciešama idempotences atslēga, un tas netiek atkārtoti izpildīts no izmaiņu operāciju idempotences krātuves.

Pieprasījums

Izmantojiet iespējotu API kontu ar HTTPS savienojumu 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 nesējmarķiera autentifikāciju. Neizmantojiet pakalpojuma sniedzēja akreditācijas datus.

Izmantojiet GET ar atbalstītu kataloga nosaukumu ceļā. Piemērojamos kataloga filtrus nododiet vaicājuma virknē. Pieprasījuma saturs nav nepieciešams.

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

Atbilde

Šis TCR maršruts atgriež reģistra atbildes saturu tieši kopā ar tā HTTP statusu. Tas neizmanto vecāko v3 status.code/status.msg/response ietvaru. Katalogu struktūras atšķiras: daži saista vērtības ar aprakstošiem objektiem, bet citi — ar virknēm. Iesniedzot vēlāku veidlapu, saglabājiet mašīnlasāmās atslēgas. Saīsinātais, izdomātais usecase piemērs ilustrē kartējumu ar objektiem kā vērtībām, nevis reālu katalogu vai garantēti pilnīgu shēmu. Pārbaudiet gan HTTP statusu, gan paredzēto JSON struktūru.

Ilustratīva atbildes struktūra; tie nav reāli konta dati vai aktuāls cenas piedāvājums.

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

Kļūdas

• 401: Konta autentifikācija neizdevās. Pārbaudiet API akreditācijas datus, konta iespējoto stāvokli un piemērojamos avota IP adreses ierobežojumus.
• 400/404 un citas reģistra kļūdas: nederīgs vai nepieejams katalogs vai filtrs. Pašreizējais maršruts saglabā augšupējā pakalpojuma HTTP statusu un atbildes saturu; universāla v3 kļūdu ietvara nav.
• 429: Sasniegts konta vai pakalpojuma sniedzēja koplietojamais pieprasījumu ierobežojums. Ievērojiet Retry-After un atkārtojiet mēģinājumu, pakāpeniski palielinot gaidīšanas intervālu.
• 502: Neizdevās sazināties ar reģistru. Pieejamība nav zināma; neaizstājiet rezultātu ar tukšām izvēles iespējām, pasniedzot tās kā veiksmīgu rezultātu.
• 503: Pieprasījumu ierobežotājs vai augšupējais pakalpojums nav pieejams. Pirms atkārtota mēģinājuma pārbaudiet atbildes saturu un Retry-After galveni, ja tā ir norādīta.

Pieejamība un blakusefekti

• Pārskatītajā izpildes ceļā šis kataloga GET pieprasījums neizveido zīmolu vai kampaņu, neiesniedz reģistrāciju, nerezervē resursu un neiekasē reģistrācijas maksu. Tas sazinās ar pakalpojuma sniedzēju un veido pieprasījumu audita ierakstus.
• Katalogu definīcijas un jebkādi piegādātāja maksu metadati nav klientam paredzēts mazumtirdzniecības cenas piedāvājums. Pašreizējais portāls kampaņu mazumtirdzniecības cenas iegūst atsevišķi; mantoto palīgfunkciju getCampaignPrice un vecās uzskaitījumu cenu anotācijas nedrīkst uzskatīt par šī maršruta cenu noteikšanas līgumu.
• Atbalstīts kataloga ieraksts nepierāda, ka konkrētais zīmols atbilst attiecīgajam lietojuma veidam. Pirms vēlāka reģistrācijas pieprasījuma pabeidziet konkrētā zīmola atbilstības pārbaudi, deklarāciju aizpildīšanu, piekrišanas iegūšanu un konta cenu pārskatīšanu.