Zgjidhni një markë ekzistuese në llogarinë tuaj
Nisuni nga identifikuesi i markës në regjistër që është tashmë i lidhur me llogarinë tuaj MultiTEL. Ky kërkim nuk krijon një markë dhe as nuk lidh markën e dikujt tjetër me llogarinë tuaj. Rrjedha aktuale e punës për klientin kontrollon pronësinë përpara se të kërkojë të dhënat e kualifikimit. Nëse kërkimi kthen 404, verifikoni llogarinë dhe markën e zgjedhur në vend që të përdorni identifikuesin e një rreshti lokal.
Ndërtoni zgjedhjet e rasteve të përdorimit nga ky rezultat
Katalogu i përgjithshëm i rasteve të përdorimit përshkruan opsionet e regjistrit. Ky kërkim specifik për markën jep zgjedhjet për markën e përzgjedhur. Ruani çdo vlerë të kthyer për usecase dhe bashkojeni me etiketën e shfaqjes dhe përshkrimin nga katalogu. Mos ofroni çdo zë të katalogut të përgjithshëm sikur marka të kualifikohej për të.
Portali pret që kjo përgjigje të jetë një listë JSON. Nëse mungon, ka format të pasaktë ose përmban një gabim, ruani formularin e klientit dhe tregoni se të dhënat e kualifikimit nuk mund të ngarkoheshin. Mos e trajtoni në heshtje si miratim për një rast përdorimi të parazgjedhur. Regjistri mund të kthejë edhe fusha të tjera përveç atyre në shembullin e shkurtuar.
Ngarkoni kërkesat për rastin e zgjedhur të përdorimit
Pasi klienti të zgjedhë një nga vlerat e kthyera të rastit të përdorimit, kërkoni /tcr/v2/campaignBuilder/brand/{brand_id}/usecase/{usecase} për të njëjtën markë. Ajo përgjigje jep kufijtë për nënrastet e përdorimit dhe kërkesat specifike të operatorëve. Përdoreni për të mbledhur shembuj mesazhesh, pëlqimin dhe deklaratat e tjera të kërkuara. Vetëm lista e kualifikimit nuk mjafton për të përgatitur një kërkesë të plotë regjistrimi të fushatës.
Shqyrtoni veçmas çmimet e llogarisë
Fushat e ofruesit, si monthlyFee, quarterlyFee ose annualFee, kur kthehen, përshkruajnë metadatat e tarifave të ofruesit. Ato nuk zëvendësojnë çmimin për llogarinë e klientit ose kushtet e regjistrimit. Portali aktual lexon veçmas çmimet me pakicë të fushatave dhe i bashkon me të dhënat e kualifikimit për ekranin e shqyrtimit. Mos nxirrni përfundime për një tarifë ndaj klientit nga çmimet e përcaktuara drejtpërdrejt në kodin e funksionit të vjetër ndihmës për numërimet.
Rifreskoni të dhënat kur ndryshon marka ose rasti i përdorimit
Kur ndërroni markën, hiqni zgjedhjet e markës së mëparshme dhe ngarkoni të dhënat e kualifikimit për përzgjedhjen e re. Rifreskoni kërkesat e rastit të zgjedhur të përdorimit përpara dorëzimit. Këto kërkesa GET nuk dorëzojnë një kërkesë regjistrimi, nuk aktivizojnë një fushatë dhe nuk caktojnë numra.
Kërkesa
Përdorni një llogari API të aktivizuar përmes HTTPS, nga një adresë IP burimi e lejuar. Rruga aktuale mbështet politikën e autentikimit të llogarisë, përfshirë autentikimin Basic dhe llogaritë API të aktivizuara me autentikim përmes tokenit të tipit bearer. Mos përdorni kredencialet e ofruesit.
GET me identifikuesin e markës në shtegun e URL-së. Nuk kërkohet trup i kërkesës.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID"| Emri | Lloji | I detyrueshëm | Përshkrimi |
|---|---|---|---|
brand_id | varg karakteresh | Po | Identifikuesi i markës në regjistër i lidhur me llogarinë tuaj të autentikuar MultiTEL. Përdorni identifikuesin e markës, jo identifikuesin e një rreshti në bazën lokale të të dhënave, identifikuesin e fushatës ose numrin tatimor të biznesit. Kodojeni si një segment të vetëm të shtegut të URL-së. |
Përgjigjja
Rruga aktuale TCR kthen drejtpërdrejt trupin JSON të regjistrit dhe ruan kodin e tij të statusit HTTP. Ajo nuk shton strukturën mbështjellëse status/response të versionit të vjetër v3. Shembulli imagjinar i shkurtuar nuk është një rezultat kualifikimi në kohë reale. Kontrolloni kodin e statusit HTTP dhe strukturën e pritshme JSON përpara se ta përdorni. Portali aktual pret një listë regjistrimesh kualifikimi, secili prej të cilave identifikon një usecase. Ai i bashkon këto regjistrime me katalogun usecase për etiketat e shfaqjes dhe lexon veçmas çmimet me pakicë. Mund të jenë të pranishme edhe fusha shtesë të ofruesit.
Strukturë ilustruese e përgjigjes; nuk përfaqëson të dhëna të llogarisë në kohë reale ose një ofertë çmimi aktuale.
[
{
"usecase": "2FA"
}
]Gabimet
- 401: Autentikimi i llogarisë dështoi. Kontrolloni kredencialet API, gjendjen e aktivizimit dhe kufizimet e zbatueshme për adresat IP të burimit.
- 404: Marka nuk është e lidhur me llogarinë e autentikuar, ose ofruesi nuk mund të gjejë markën apo përzgjedhjen e kërkuar. Nëse kontrolli lokal i pronësisë sjell refuzim, ky refuzim kthehet përpara se t'i dërgohet një kërkesë ofruesit.
- Gabime të tjera të regjistrit: ruhen kodi i statusit HTTP dhe trupi i përgjigjes nga sistemi burimor. Një rast përdorimi i pavlefshëm ose i padisponueshëm nuk përbën një rezultat të suksesshëm me një grup bosh kërkesash.
- 429: Është arritur kufiri i kërkesave të llogarisë ose kufiri i përbashkët i ofruesit. Respektoni Retry-After.
- 502/503: Dështim i transportit ose i disponueshmërisë së ofruesit apo të mekanizmit kufizues të shpeshtësisë së kërkesave. Ruani formularin dhe riprovoni me intervale pritjeje gjithnjë e më të gjata.
Disponueshmëria dhe efektet anësore
- Kërkesa GET e shqyrtuar kontrollon pronësinë e markës ekzistuese, kontakton regjistrin dhe shkruan regjistrime auditimi të kërkesës. Ajo nuk krijon një markë ose fushatë dhe nuk ngarkon tarifë regjistrimi.
- Metadatat e tarifave të ofruesit nuk janë një ofertë çmimi me pakicë për klientin e MultiTEL. Portali shqyrton veçmas çmimet e llogarisë përpara një kërkese të mëvonshme regjistrimi.
- Kualifikimi dhe kërkesat mund të ndryshojnë. Rifreskojini për markën dhe rastin e zgjedhur të përdorimit përpara dorëzimit. Një kërkim i suksesshëm nuk përbën miratim të fushatës, caktim numrash ose leje për të filluar dërgimin e mesazheve.