Kies 'n bestaande handelsmerk op jou rekening
Begin met die register se handelsmerk-ID wat reeds aan jou MultiTEL-rekening gekoppel is. Hierdie opsoek skep nie 'n handelsmerk of koppel iemand anders se handelsmerk aan jou rekening nie. Die huidige kliëntewerkvloei kontroleer eienaarskap voordat kwalifikasies aangevra word. As die opsoek 404 terugstuur, kontroleer die gekose rekening en handelsmerk eerder as om 'n plaaslike ry-ID in die plek daarvan te gebruik.
Stel die gebruiksgevalkeuses uit hierdie resultaat saam
Die algemene gebruiksgevalkatalogus beskryf die register se opsies. Hierdie handelsmerkspesifieke opsoek verskaf die keuses vir die gekose handelsmerk. Behou elke teruggestuurde usecase-waarde en kombineer dit met die katalogus se vertoonetiket en beskrywing. Moenie elke inskrywing in die algemene katalogus aanbied asof die handelsmerk daarvoor kwalifiseer nie.
Die portaal verwag dat hierdie antwoord 'n JSON-lys is. As dit ontbreek, verkeerd gevorm is of 'n fout is, behou die kliënt se vorm en wys dat die kwalifikasie nie gelaai kon word nie. Moenie dit sonder kennisgewing as goedkeuring vir 'n verstekgebruiksgeval behandel nie. Die register kan ook velde terugstuur wat nie in die verkorte voorbeeld voorkom nie.
Laai die vereistes vir die gekose gebruiksgeval
Nadat 'n kliënt 'n teruggestuurde gebruiksgevalwaarde gekies het, vra /tcr/v2/campaignBuilder/brand/{brand_id}/usecase/{usecase} vir dieselfde handelsmerk aan. Daardie antwoord verskaf die grense vir subgebruiksgevalle en netwerkoperateurspesifieke vereistes. Gebruik dit om boodskapvoorbeelde, toestemming en ander vereiste verklarings in te samel. Die kwalifikasielys alleen is nie genoeg om 'n volledige veldtogregistrasie saam te stel nie.
Hersien rekeningpryse afsonderlik
Verskaffervelde soos monthlyFee, quarterlyFee of annualFee beskryf, wanneer dit teruggestuur word, metadata oor die verskaffer se fooie. Dit vervang nie die kliënt se rekeningprys of die registrasievoorwaardes nie. Die huidige portaal lees kleinhandelpryse vir veldtogte afsonderlik en kombineer dit met kwalifikasiedata vir die hersieningskerm. Moenie 'n kliënt se heffing aflei uit die pryse wat in die ou hulptoepassing vir opsommingstipes se kode vasgelê is nie.
Verfris wanneer die handelsmerk of gebruiksgeval verander
Verwyder die vorige handelsmerk se keuses wanneer jy na 'n ander handelsmerk oorskakel en laai kwalifikasies vir die nuwe keuse. Verfris die gekose gebruiksgeval se vereistes voor indiening. Hierdie GET-versoeke dien nie 'n registrasie in, aktiveer nie 'n veldtog of ken nommers toe nie.
Versoek
Gebruik 'n geaktiveerde API-rekening oor HTTPS vanaf 'n toegelate bron-IP-adres. Die huidige roete ondersteun die rekening se outentiseringsbeleid, insluitend Basic-outentisering en geaktiveerde API-rekeninge met draertokenoutentisering. Moenie die verskaffer se aanmeldbesonderhede gebruik nie.
GET met die handelsmerkidentifiseerder in die URL-pad. Geen versoekliggaam word vereis nie.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID"| Naam | Tipe | Vereis | Beskrywing |
|---|---|---|---|
brand_id | tekenreeks | Ja | Die register se handelsmerk-ID wat aan jou geoutentiseerde MultiTEL-rekening gekoppel is. Gebruik die handelsmerk-ID, nie 'n plaaslike databasisry-ID, veldtog-ID of besigheidsbelastingnommer nie. Enkodeer dit as een URL-padsegment. |
Antwoord
Die huidige TCR-roete stuur die register se JSON-liggaam direk terug en behou die HTTP-status daarvan. Dit voeg nie die ou v3-omhulsel vir status/response by nie. Die verkorte fiktiewe voorbeeld is nie 'n lewendige kwalifikasieresultaat nie. Kontroleer die HTTP-status en die verwagte JSON-struktuur voordat jy dit gebruik. Die huidige portaal verwag 'n lys kwalifikasierekords wat elk 'n usecase identifiseer. Dit kombineer daardie rekords met die usecase-katalogus vir vertoonetikette en lees kleinhandelpryse afsonderlik. Bykomende verskaffervelde kan voorkom.
Illustratiewe antwoordstruktuur; nie lewendige rekeningdata of 'n huidige kwotasie nie.
[
{
"usecase": "2FA"
}
]Foute
- 401: Rekeningoutentisering het misluk. Kontroleer die API-aanmeldbesonderhede, of die rekening geaktiveer is en die toepaslike beperkings op bron-IP-adresse.
- 404: Die handelsmerk is nie aan die geoutentiseerde rekening gekoppel nie, of die verskaffer kan nie die aangevraagde handelsmerk of keuse vind nie. 'n Weiering op grond van die plaaslike eienaarskapkontrole word teruggestuur voordat 'n versoek aan die verskaffer gestuur word.
- Ander registerfoute: Die stroomopdiens se HTTP-status en liggaam word behou. 'n Ongeldige of onbeskikbare gebruiksgeval is nie 'n suksesvolle antwoord met 'n leë stel vereistes nie.
- 429: Die rekening se versoeklimiet of die gedeelde verskafferversoeklimiet is bereik. Volg Retry-After.
- 502/503: Beskikbaarheidsfaling van die vervoerverbinding, verskaffer of versoektempobeperker. Behou die vorm en probeer weer met toenemende wagtye tussen pogings.
Beskikbaarheid en newe-effekte
- Die nagegane GET kontroleer bestaande handelsmerkeienaarskap, kontak die register en skryf versoekouditrekords. Dit skep nie 'n handelsmerk of veldtog of hef 'n registrasiefooi nie.
- Metadata oor die verskaffer se fooie is nie 'n kleinhandelkwotasie vir 'n MultiTEL-kliënt nie. Die portaal hersien rekeningpryse afsonderlik voor 'n latere registrasieversoek.
- Kwalifikasie en vereistes kan verander. Verfris dit vir die gekose handelsmerk en gebruiksgeval voor indiening. 'n Suksesvolle opsoek is nie veldtoggoedkeuring, nommertoekenning of toestemming om boodskappe te begin stuur nie.