Odaberite postojeću robnu marku na svojem računu
Počnite s ID-jem robne marke u registru koji je već povezan s vašim računom MultiTEL. Ovo pretraživanje ne stvara robnu marku niti povezuje tuđu robnu marku s vašim računom. Trenutačni korisnički postupak provjerava vlasništvo prije traženja podataka o prihvatljivosti. Ako pretraživanje vrati 404, provjerite odabrani račun i robnu marku umjesto da upotrijebite ID lokalnog retka.
Na temelju ovog rezultata sastavite izbor namjena
Opći katalog namjena opisuje mogućnosti registra. Ovo pretraživanje za određenu robnu marku daje mogućnosti za odabranu robnu marku. Zadržite svaku vraćenu vrijednost polja usecase i povežite je s nazivom za prikaz i opisom iz kataloga. Nemojte nuditi sve stavke općeg kataloga kao da robna marka ispunjava uvjete za njih.
Portal očekuje da ovaj odgovor bude popis u formatu JSON. Ako odgovor nedostaje, neispravno je oblikovan ili sadrži pogrešku, sačuvajte korisnikov obrazac i prikažite da se podaci o prihvatljivosti nisu mogli učitati. Nemojte to prešutno smatrati odobrenjem zadane namjene. Registar može vratiti i polja koja nisu prikazana u skraćenom primjeru.
Učitajte zahtjeve za odabranu namjenu
Nakon što korisnik odabere jednu od vraćenih vrijednosti namjene, pošaljite zahtjev na /tcr/v2/campaignBuilder/brand/{brand_id}/usecase/{usecase} za istu robnu marku. Taj odgovor daje granice za podnamjene i zahtjeve pojedinih operatora. Upotrijebite ga za prikupljanje primjera poruka, privole i drugih obveznih izjava. Sam popis prihvatljivih namjena nije dovoljan za sastavljanje potpune registracije kampanje.
Zasebno pregledajte cijene za račun
Polja pružatelja kao što su monthlyFee, quarterlyFee ili annualFee, kada su vraćena, opisuju metapodatke o naknadama pružatelja. Ona ne zamjenjuju cijenu za korisnikov račun ni uvjete registracije. Trenutačni portal zasebno dohvaća maloprodajne cijene kampanja i povezuje ih s podacima o prihvatljivosti na zaslonu za pregled. Nemojte izvoditi iznos naplate korisniku iz fiksno zadanih cijena u staroj pomoćnoj funkciji za enumeracije.
Osvježite podatke kada se promijeni robna marka ili namjena
Pri promjeni robne marke odbacite mogućnosti prethodne robne marke i učitajte podatke o prihvatljivosti za novi odabir. Prije slanja osvježite zahtjeve za odabranu namjenu. Ovi zahtjevi GET ne šalju registraciju, ne aktiviraju kampanju i ne dodjeljuju brojeve.
Zahtjev
Upotrijebite omogućen API račun putem protokola HTTPS s dopuštene izvorne IP adrese. Trenutačna ruta podržava pravila autentifikacije računa, uključujući autentifikaciju Basic i omogućene API račune s tokenom nositelja. Nemojte upotrebljavati vjerodajnice pružatelja.
GET s identifikatorom robne marke u URL putanji. Tijelo zahtjeva nije potrebno.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID"| Naziv | Vrsta | Obvezno | Opis |
|---|---|---|---|
brand_id | znakovni niz | Da | ID robne marke u registru povezan s vašim autentificiranim računom MultiTEL. Upotrijebite ID robne marke, a ne ID retka lokalne baze podataka, ID kampanje ili porezni broj poduzeća. Kodirajte ga kao jedan segment URL putanje. |
Odgovor
Trenutačna ruta TCR izravno vraća tijelo odgovora registra u formatu JSON i zadržava njegov HTTP status. Ne dodaje staru omotnicu status/response iz verzije v3. Skraćeni izmišljeni primjer nije rezultat stvarne provjere prihvatljivosti. Prije upotrebe provjerite HTTP status i očekivanu strukturu u formatu JSON. Trenutačni portal očekuje popis zapisa o prihvatljivosti, od kojih svaki identificira usecase. Te zapise povezuje s katalogom usecase radi naziva za prikaz, a maloprodajne cijene dohvaća zasebno. Mogu biti prisutna i dodatna polja pružatelja.
Primjer strukture odgovora; ne predstavlja stvarne podatke računa ni aktualnu ponudu cijene.
[
{
"usecase": "2FA"
}
]Pogreške
- 401: Autentifikacija računa nije uspjela. Provjerite API vjerodajnice, je li račun omogućen i primjenjiva ograničenja izvornih IP adresa.
- 404: Robna marka nije povezana s autentificiranim računom ili pružatelj ne može pronaći zatraženu robnu marku ili odabir. Lokalno odbijanje zbog nepostojanja vlasništva vraća se prije slanja zahtjeva pružatelju.
- Ostale pogreške registra: Zadržavaju se HTTP status i tijelo odgovora nadređenog sustava. Nevaljana ili nedostupna namjena ne predstavlja uspješan odgovor s praznim skupom zahtjeva.
- 429: Dosegnuto je ograničenje broja zahtjeva računa ili zajedničko ograničenje kod pružatelja. Poštujte Retry-After.
- 502/503: Pogreška prijenosa ili nedostupnost pružatelja ili sustava za ograničavanje učestalosti zahtjeva. Sačuvajte obrazac i pokušajte ponovno uz postupno povećavanje razmaka između pokušaja.
Dostupnost i popratni učinci
- Pregledani GET provjerava vlasništvo postojeće robne marke, kontaktira registar i upisuje revizijske zapise zahtjeva. Ne stvara robnu marku ni kampanju i ne naplaćuje naknadu za registraciju.
- Metapodaci o naknadama pružatelja nisu maloprodajna ponuda cijene za korisnika MultiTEL-a. Portal zasebno pregledava cijene za račun prije kasnijeg zahtjeva za registraciju.
- Prihvatljivost i zahtjevi mogu se promijeniti. Prije slanja osvježite ih za odabranu robnu marku i namjenu. Uspješno pretraživanje nije odobrenje kampanje, dodjela brojeva ni dopuštenje za početak slanja poruka.