Učitavanje kataloga za registraciju slanja poruka

Učitajte mogućnosti odabira prije izrade obrasca za registraciju

Upotrijebite trenutačni katalog za registraciju slanja poruka kako biste popunili mogućnosti odabira umjesto da vrijednosti registra izravno ugradite u kod. Za obrazac robne marke portal učitava kataloge vrsta poslovnih subjekata, djelatnosti, vrsta alternativnih poslovnih identifikatora, odnosa s robnom markom, država, saveznih država SAD-a i burzi. Za obrazac kampanje učitava namjene, valjane podnamjene i partnere za povezivanje. Svaku vraćenu strojnu vrijednost sačuvajte zajedno s njezinom prikaznom oznakom; pri sastavljanju kasnijeg zahtjeva upotrijebite vrijednost, a ne prevedenu oznaku.

Odaberite katalog

Katalozi koje portal upotrebljava
Naziv	Svrha
usecase	Definicije namjena kampanje. Dodajte validSubUsecase=true pri učitavanju mogućnosti odabira podnamjena.
entityType	Vrsta poslovnog subjekta ili organizacije za robnu marku.
vertical	Mogućnosti odabira djelatnosti za robnu marku.
altBusinessIdType	Kategorije alternativnih poslovnih identifikatora.
brandRelationship	Mogućnosti odabira odnosa koje upotrebljava obrazac za registraciju.
country	Mogućnosti odabira država u registru; odvojene su od država u kojima su dostupni telefonski brojevi.
usState	Mogućnosti odabira saveznih država SAD-a za adrese pri registraciji.
stockExchange	Mogućnosti odabira burze kada ih zahtijeva vrsta poslovnog subjekta robne marke.
cnp	Identifikatori partnera za povezivanje. Odaberite partnera kojeg podržava tijek rada s kampanjama na vašem računu.

Izravno obradite odgovor sustava TCR

Tijelo odgovora dolazi izravno iz sučelja TCR API. Za razliku od mnogih starijih krajnjih točaka /v3, nema dodani omotač status/response. Prije tumačenja tijela provjerite status HTTP. Katalog može sadržavati oznake u obliku nizova znakova ili strukturirane definicije, stoga nemojte pretpostaviti da svaka vrijednost ima ista polja. Ako zahtjev HTTP uspije, ali tijelo nije valjan JSON očekivane strukture, prijavite neuspjelo dohvaćanje umjesto da ga neprimjetno zamijenite praznim popisom.

Odvojite mogućnosti odabira iz kataloga od provjere prihvatljivosti i određivanja cijena

Opći katalog namjena ne govori za koje namjene pojedina robna marka ispunjava uvjete. Trenutačni portal prije izrade kampanje provjerava prihvatljivost konkretne robne marke i provjerava zahtjeve odabranog operatera. Isto tako, metapodaci o naknadama dobavljača nisu konačna maloprodajna cijena za račun. Zasebno pregledajte primjenjivu cijenu za račun i uvjete registracije. Učitavanjem kataloga ne odobravaju se robna marka, kampanja ni broj za slanje poruka.

Postupanje s nedostupnim katalozima

Sačuvajte podatke koje je korisnik unio u obrazac ako dohvaćanje ne uspije. Prikažite pogrešku, poštujte Retry-After kada se vrati i postupno povećavajte razmak između ponovnih pokušaja. Nemojte opetovano učitavati sve kataloge niti pogrešku ograničenja učestalosti zahtjeva ili prijenosa smatrati praznim valjanim katalogom. Ovaj zahtjev GET ne zahtijeva ključ idempotentnosti i ne reproducira se iz spremišta idempotentnosti za operacije izmjene.

Zahtjev

Upotrijebite omogućen račun za API putem protokola HTTPS s dopuštene izvorišne IP adrese. Trenutačna ruta podržava pravila autentifikacije računa, uključujući autentifikaciju Basic i omogućene račune za API s autentifikacijom nositeljskim tokenom. Nemojte upotrebljavati vjerodajnice pružatelja usluge.

Pošaljite GET s podržanim nazivom kataloga u putanji. Primjenjive filtre kataloga navedite u nizu upita. Tijelo zahtjeva nije potrebno.

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

Parametri putanje
Naziv	Vrsta	Obavezno	Opis
`type`	niz znakova	Da	Naziv kataloga, uz izvorni raspored velikih i malih slova. Portal upotrebljava usecase, entityType, vertical, altBusinessIdType, brandRelationship, country, usState, stockExchange i cnp. To su nazivi kataloga, a ne identifikatori robnih marki ili kampanja.

Parametri upita
Naziv	Vrsta	Obavezno	Opis
`validSubUsecase`	logička vrijednost	Ne	Za katalog usecase portal šalje vrijednost true kako bi učitao valjane mogućnosti odabira podnamjena. Izostavite parametar pri učitavanju običnog kataloga namjena. Registar pruža podatke o dostupnosti i definicije.

Odgovor

Ova ruta sustava TCR izravno vraća tijelo odgovora registra zajedno s njegovim statusom HTTP. Ne upotrebljava stariji omotač v3 status.code/status.msg/response. Strukture kataloga razlikuju se: neki preslikavaju vrijednosti u opisne objekte, a drugi u nizove znakova. Sačuvajte strojno čitljive ključeve pri kasnijem slanju obrasca. Skraćeni izmišljeni primjer za usecase prikazuje mapu čije su vrijednosti objekti, a ne aktualni katalog ili zajamčeno potpunu shemu. Provjerite i status HTTP i očekivanu strukturu JSON.

Ilustrativna struktura odgovora; nije riječ o stvarnim trenutačnim podacima računa ni o važećoj ponudi.

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

Pogreške

401: Autentifikacija računa nije uspjela. Provjerite vjerodajnicu za API, je li račun omogućen i primjenjiva ograničenja izvorišnih IP adresa.
400/404 i druge pogreške registra: Nevaljan ili nedostupan katalog ili filtar. Trenutačna ruta zadržava status HTTP i tijelo odgovora uzvodne usluge; ne postoji univerzalni v3 omotač pogreške.
429: Dosegnuto je ograničenje broja zahtjeva za račun ili zajedničko ograničenje pružatelja usluge. Poštujte Retry-After i pokušajte ponovno uz postupno povećavanje razmaka između pokušaja.
502: Nije moguće pristupiti registru. Dostupnost nije poznata; nemojte prikazati prazne mogućnosti odabira kao uspješan rezultat.
503: Sustav za ograničavanje zahtjeva ili uzvodna usluga nisu dostupni. Prije ponovnog pokušaja pregledajte tijelo odgovora i eventualno zaglavlje Retry-After.

Dostupnost i popratni učinci

Ovaj zahtjev GET za katalog u pregledanom toku ne stvara robnu marku ili kampanju, ne podnosi registraciju, ne rezervira resurs niti naplaćuje naknadu za registraciju. Kontaktira pružatelja usluge i zapisuje revizijske zapise zahtjeva.
Definicije kataloga i eventualni metapodaci o naknadama dobavljača nisu maloprodajna ponuda za korisnika. Trenutačni portal zasebno dohvaća maloprodajne cijene kampanja; naslijeđena pomoćna funkcija getCampaignPrice i stare oznake cijena uz enumerirane vrijednosti ne smiju se smatrati ugovorom o cijenama ove rute.
Podržana stavka kataloga nije dokaz da određena robna marka ispunjava uvjete za tu namjenu. Prije kasnijeg zahtjeva za registraciju dovršite provjeru prihvatljivosti konkretne robne marke, predajte izjave, pribavite privolu i pregledajte cijene za račun.