Valige oma kontol olemasolev bränd
Alustage registri brändi ID-st, mis on juba teie MultiTEL-i kontoga seotud. See päring ei loo brändi ega seo kellegi teise brändi teie kontoga. Praegune kliendi töövoog kontrollib enne sobivusandmete küsimist omandiõigust. Kui päring tagastab 404, kontrollige valitud kontot ja brändi, selle asemel et asendada identifikaator kohaliku rea ID-ga.
Koostage kasutusjuhtumite valikud selle tulemuse põhjal
Üldine kasutusjuhtumite kataloog kirjeldab registri võimalusi. See brändipõhine päring annab valitud brändile saadaolevad valikud. Säilitage iga tagastatud usecase väärtus ning ühendage see kataloogis oleva kuvatava nimetuse ja kirjeldusega. Ärge pakkuge kõiki üldise kataloogi kirjeid nii, nagu bränd vastaks nende kõigi tingimustele.
Portaal eeldab, et see vastus on JSON-loend. Kui vastus puudub, on vigase struktuuriga või on veavastus, säilitage kliendi vorm ja näidake, et sobivusandmeid ei õnnestunud laadida. Ärge käsitage seda kasutajat teavitamata vaikimisi kasutusjuhtumi heakskiiduna. Register võib tagastada ka välju, mida lühendatud näites pole.
Laadige valitud kasutusjuhtumi nõuded
Kui klient on valinud tagastatud kasutusjuhtumi väärtuse, tehke päring aadressile /tcr/v2/campaignBuilder/brand/{brand_id}/usecase/{usecase} sama brändi kohta. See vastus annab alamkasutusjuhtumite piirangud ja operaatoripõhised nõuded. Kasutage seda sõnuminäidiste, nõusoleku ja muude nõutavate kinnituste kogumiseks. Üksnes sobivusloendist ei piisa täieliku kampaania registreerimistaotluse koostamiseks.
Vaadake konto hinnad eraldi üle
Teenusepakkuja väljad, näiteks monthlyFee, quarterlyFee või annualFee, kirjeldavad tagastamise korral teenusepakkuja tasude metaandmeid. Need ei asenda kliendi konto hinda ega registreerimistingimusi. Praegune portaal loeb kampaaniate jaehinnad eraldi ning ühendab need ülevaatekuval sobivusandmetega. Ärge tuletage kliendilt võetavat tasu vana loenditüübi abifunktsiooni koodi kirjutatud hindadest.
Värskendage andmeid brändi või kasutusjuhtumi muutumisel
Brändi vahetamisel eemaldage eelmise brändi valikud ja laadige uue valiku sobivusandmed. Enne esitamist värskendage valitud kasutusjuhtumi nõudeid. Need GET-päringud ei esita registreerimistaotlust, ei aktiveeri kampaaniat ega määra numbreid.
Päring
Kasutage lubatud lähte-IP-aadressilt HTTPS-ühenduse kaudu aktiveeritud API kontot. Praegune marsruut toetab konto autentimispoliitikat, sealhulgas Basic-autentimist ja aktiveeritud API kontosid, mis kasutavad esitaja pääsuloaga autentimist. Ärge kasutage teenusepakkuja autentimisandmeid.
GET-päring, mille URL-i teel on brändi identifikaator. Päringu sisu pole nõutav.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID"| Nimi | Tüüp | Kohustuslik | Kirjeldus |
|---|---|---|---|
brand_id | sõne | Jah | Registri brändi ID, mis on seotud teie autenditud MultiTEL-i kontoga. Kasutage brändi ID-d, mitte kohaliku andmebaasirea ID-d, kampaania ID-d ega ettevõtte maksukohustuslase numbrit. Kodeerige see ühe URL-i teesegmendina. |
Vastus
Praegune TCR marsruut tagastab registri JSON-sisu otse ja säilitab selle HTTP olekukoodi. See ei lisa varasemat v3 status/response ümbrist. Lühendatud väljamõeldud näide ei ole tegelik sobivuspäringu tulemus. Enne vastuse kasutamist kontrollige HTTP olekukoodi ja oodatud JSON-struktuuri. Praegune portaal eeldab sobivuskirjete loendit, milles iga kirje määratleb usecase väärtuse. Kuvatavate nimetuste saamiseks ühendab see kirjed usecase kataloogiga ja loeb jaehinnad eraldi. Vastuses võib olla teenusepakkuja lisavälju.
Näitlik vastuse struktuur; see ei ole konto tegelik andmestik ega kehtiv hinnapakkumine.
[
{
"usecase": "2FA"
}
]Vead
- 401: Konto autentimine ebaõnnestus. Kontrollige API autentimisandmeid, konto aktiveeritust ja kehtivaid lähte-IP-aadressi piiranguid.
- 404: Bränd ei ole autenditud kontoga seotud või teenusepakkuja ei leia taotletud brändi või valikut. Kohaliku omandiõiguse kontrolli keeldumine tagastatakse enne teenusepakkujale päringu saatmist.
- Muud registrivead: ülesvoolu teenuse HTTP olekukood ja vastuse sisu säilitatakse. Vigane või kättesaamatu kasutusjuhtum ei tähenda õnnestunud vastust tühja nõudekomplektiga.
- 429: Konto päringulimiit või teenusepakkuja jagatud päringulimiit on täis. Järgige Retry-After määratud ooteaega.
- 502/503: Andmeedastuse, teenusepakkuja või päringusageduse piiraja käideldavuse tõrge. Säilitage vorm ja proovige uuesti, suurendades katsete vahelist ooteaega.
Kättesaadavus ja kõrvalmõjud
- Üle vaadatud GET-päring kontrollib olemasoleva brändi omandiõigust, võtab registriga ühendust ja kirjutab päringu auditikirjeid. See ei loo brändi ega kampaaniat ega võta registreerimistasu.
- Teenusepakkuja tasude metaandmed ei ole MultiTEL-i kliendile mõeldud jaehinnapakkumine. Portaal vaatab konto hinnad eraldi üle enne hilisemat registreerimispäringut.
- Sobivus ja nõuded võivad muutuda. Värskendage neid enne esitamist valitud brändi ja kasutusjuhtumi jaoks. Õnnestunud päring ei tähenda kampaania heakskiitu, numbrite määramist ega luba sõnumite saatmist alustada.