Ngarkoni opsionet përpara se të ndërtoni një formular regjistrimi
Përdorni katalogun aktual të regjistrimit për shërbimet e mesazheve për të plotësuar opsionet, në vend që t'i shkruani vlerat e regjistrit drejtpërdrejt në kod. Për një formular marke, portali ngarkon katalogët e llojit të biznesit, sektorit, llojit të identifikuesit alternativ të biznesit, marrëdhënies me markën, vendit, shtetit të SHBA-së dhe bursës. Për një formular fushate, ai ngarkon rastet e përdorimit, nënrastet e vlefshme të përdorimit dhe partnerët e lidhshmërisë. Ruajeni çdo vlerë të kthyer për përpunim nga makina së bashku me etiketën e saj të shfaqjes; kur ndërtoni një kërkesë të mëvonshme, përdorni vlerën, jo një etiketë të përkthyer.
Zgjidhni një katalog
| Emri | Qëllimi |
|---|---|
| usecase | Përkufizimet e rasteve të përdorimit të fushatave. Shtoni validSubUsecase=true kur ngarkoni opsionet e nënrasteve të përdorimit. |
| entityType | Lloji i biznesit ose i organizatës për një markë. |
| vertical | Opsionet e sektorit për një markë. |
| altBusinessIdType | Kategoritë e identifikuesve alternativë të biznesit. |
| brandRelationship | Opsionet e marrëdhënies që përdor formulari i regjistrimit. |
| country | Opsionet e vendeve në regjistër; këto janë të ndara nga vendet ku ofrohen numra telefoni. |
| usState | Opsionet e shteteve të SHBA-së për adresat e regjistrimit. |
| stockExchange | Opsionet e bursës kur kërkohen nga lloji i biznesit të markës. |
| cnp | Identifikuesit e partnerëve të lidhshmërisë. Zgjidhni partnerin që mbështetet nga rrjedha e punës së fushatave të llogarisë suaj. |
Përpunojeni drejtpërdrejt përgjigjen TCR
Trupi i përgjigjes vjen drejtpërdrejt nga API e TCR. Ndryshe nga shumë pika fundore më të vjetra /v3, ai nuk ka një mbështjellës shtesë status/response. Kontrolloni statusin HTTP përpara se ta interpretoni. Një katalog mund të përmbajë etiketa si vargje karakteresh ose përkufizime të strukturuara, prandaj mos supozoni se çdo vlerë ka të njëjtat fusha. Nëse kërkesa HTTP ka sukses, por trupi nuk është JSON i vlefshëm me strukturën e pritur, raportoni dështimin e kërkimit në vend që ta zëvendësoni në heshtje me një listë bosh.
Ndajini opsionet e katalogut nga kualifikimi dhe çmimet
Një katalog i përgjithshëm i rasteve të përdorimit nuk tregon se për cilat raste përdorimi kualifikohet një markë e caktuar. Portali aktual kryen një kërkim kualifikimi specifik për markën përpara krijimit të fushatës dhe kontrollon kërkesat e operatorëve të zgjedhur. Po kështu, metadatat e tarifave të një furnizuesi nuk janë çmimi përfundimtar i shitjes me pakicë për llogarinë. Shqyrtoni veçmas çmimin që zbatohet për llogarinë dhe kushtet e regjistrimit. Ngarkimi i një katalogu nuk miraton një markë, fushatë ose numër për mesazhe.
Menaxhoni katalogët e padisponueshëm
Ruajini të dhënat që klienti ka futur në formular nëse një kërkim dështon. Shfaqni gabimin, respektoni Retry-After kur kthehet dhe përdorni vonesa në rritje ndërmjet riprovimeve. Mos i ringarkoni vazhdimisht të gjithë katalogët dhe mos e trajtoni një gabim të kufirit të shpeshtësisë së kërkesave ose të transportit si një katalog bosh të vlefshëm. Kjo kërkesë GET nuk kërkon çelës idempotence dhe nuk riluhet nga depoja e idempotencës për veprimet që ndryshojnë të dhënat.
Kërkesa
Përdorni një llogari API të aktivizuar përmes HTTPS nga një adresë IP burimore 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ë bartësit. Mos përdorni kredencialet e ofruesit.
GET me një emër katalogu të mbështetur në shteg. Kaloni filtrat përkatës të katalogut në vargun e parametrave të pyetjes. Nuk nevojitet trup kërkese.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/enum/usecase?validSubUsecase=true"| Emri | Lloji | I detyrueshëm | Përshkrimi |
|---|---|---|---|
type | varg karakteresh | Po | Emri i katalogut, duke ruajtur shkronjat e mëdha dhe të vogla të origjinalit. Portali përdor usecase, entityType, vertical, altBusinessIdType, brandRelationship, country, usState, stockExchange dhe cnp. Këta janë emra katalogësh, jo identifikues markash ose fushatash. |
| Emri | Lloji | I detyrueshëm | Përshkrimi |
|---|---|---|---|
validSubUsecase | vlerë logjike | Jo | Për katalogun usecase, portali kërkon vlerën true për të ngarkuar opsionet e vlefshme të nënrasteve të përdorimit. Mos e përfshini parametrin kur ngarkoni katalogun e zakonshëm të rasteve të përdorimit. Disponueshmëria dhe përkufizimet sigurohen nga regjistri. |
Përgjigjja
Kjo rrugë TCR e kthen drejtpërdrejt trupin e përgjigjes së regjistrit me statusin e tij HTTP. Ajo nuk përdor mbështjellësin e vjetër v3 status.code/status.msg/response. Strukturat e katalogëve ndryshojnë: disa i lidhin vlerat me objekte përshkruese; të tjerë i lidhin vlerat me vargje karakteresh. Ruajini çelësat e lexueshëm nga makina kur dërgoni një formular të mëvonshëm. Shembulli i shkurtuar dhe i trilluar usecase ilustron një hartëzim me vlera objekt, jo një katalog të drejtpërdrejtë ose një skemë të garantuar si e plotë. Kontrolloni si statusin HTTP, ashtu edhe strukturën e pritur JSON.
Strukturë ilustruese e përgjigjes; nuk përfaqëson të dhëna të drejtpërdrejta të llogarisë ose një ofertë çmimi aktuale.
{
"2FA": {
"displayName": "Authentication",
"description": "Example authentication use case"
}
}Gabimet
- 401: Autentikimi i llogarisë dështoi. Kontrolloni kredencialin API, gjendjen e aktivizimit dhe kufizimet përkatëse të adresës IP burimore.
- 400/404 dhe gabime të tjera të regjistrit: katalog ose filtër i pavlefshëm ose i padisponueshëm. Rruga aktuale ruan statusin HTTP dhe trupin e përgjigjes nga shërbimi i sipërm; nuk ka një mbështjellës universal gabimesh v3.
- 429: Është arritur kufiri i kërkesave të llogarisë ose kufiri i përbashkët i ofruesit. Respektoni Retry-After dhe riprovoni me vonesa në rritje.
- 502: Nuk u arrit lidhja me regjistrin. Disponueshmëria nuk dihet; mos i paraqitni opsionet bosh si zëvendësim për një rezultat të suksesshëm.
- 503: Kufizuesi i kërkesave ose shërbimi i sipërm është i padisponueshëm. Shqyrtoni trupin e përgjigjes dhe çdo krye Retry-After përpara se të riprovoni.
Disponueshmëria dhe efektet anësore
- Kjo kërkesë GET për katalogun nuk krijon markë ose fushatë, nuk dërgon regjistrim, nuk rezervon burim dhe nuk ngarkon tarifë regjistrimi në rrugën e shqyrtuar. Ajo kontakton ofruesin dhe shkruan regjistrime auditimi të kërkesave.
- Përkufizimet e katalogëve dhe çdo metadatë e tarifave të furnizuesit nuk përbëjnë ofertë çmimi me pakicë për klientin. Portali aktual i merr veçmas çmimet me pakicë të fushatave; funksioni ndihmës i trashëguar getCampaignPrice dhe shënimet e vjetra të çmimeve në enumerime nuk duhet të trajtohen si kontrata e çmimeve e kësaj rruge.
- Një zë i mbështetur i katalogut nuk është provë se një markë e caktuar kualifikohet për atë rast përdorimi. Përfundoni kualifikimin specifik për markën, deklaratat, pëlqimin dhe shqyrtimin e çmimeve të llogarisë përpara një kërkese të mëvonshme regjistrimi.