Laai keuses voordat jy 'n registrasievorm opstel
Gebruik die huidige katalogus vir boodskapregistrasie om keuses in te vul, eerder as om registerwaardes vas in die kode te skryf. Vir 'n handelsmerkvorm laai die portaal katalogusse vir ondernemingstipe, bedryf, alternatiewe ondernemingsidentifiseerdertipe, handelsmerkverwantskap, land, Amerikaanse deelstaat en aandelebeurs. Vir 'n veldtogvorm laai dit gebruiksgevalle, geldige subgebruiksgevalle en verbindingsvennote. Hou elke teruggestuurde masjienwaarde saam met sy vertoonetiket; gebruik die waarde, en nie 'n vertaalde etiket nie, wanneer jy 'n latere versoek opstel.
Kies 'n katalogus
| Naam | Doel |
|---|---|
| usecase | Definisies van veldtoggebruiksgevalle. Voeg validSubUsecase=true by wanneer jy keuses vir subgebruiksgevalle laai. |
| entityType | Ondernemings- of organisasietipe vir 'n handelsmerk. |
| vertical | Bedryfskeuses vir 'n handelsmerk. |
| altBusinessIdType | Kategorieë vir alternatiewe ondernemingsidentifiseerders. |
| brandRelationship | Verwantskapkeuses wat die registrasievorm gebruik. |
| country | Landkeuses van die register; dit is afsonderlik van die lande waar telefoonnommers beskikbaar is. |
| usState | Keuses van Amerikaanse deelstate vir registrasieadresse. |
| stockExchange | Beurskeuses waar die handelsmerk se ondernemingstipe dit vereis. |
| cnp | Identifiseerders van verbindingsvennote. Kies die vennoot wat deur jou rekening se veldtogwerkvloei ondersteun word. |
Verwerk die TCR-antwoord direk
Die antwoordliggaam behoort direk aan die TCR-API. Anders as baie ouer /v3-eindpunte het dit geen bykomende status/response-omhulsel nie. Kontroleer die HTTP-status voordat jy dit interpreteer. 'n Katalogus kan teksetikette of gestruktureerde definisies bevat; moenie dus aanneem dat elke waarde dieselfde velde het nie. As die HTTP-versoek slaag maar die liggaam nie geldige JSON met die verwagte struktuur is nie, meld dat die opsoek misluk het eerder as om dit stilweg met 'n leë lys te vervang.
Hou kataloguskeuses apart van kwalifikasie en prysbepaling
'n Algemene katalogus van gebruiksgevalle sê nie vir watter gebruiksgevalle 'n individuele handelsmerk kwalifiseer nie. Die huidige portaal doen 'n handelsmerkspesifieke kwalifikasie-opsoek voordat 'n veldtog geskep word en kontroleer die vereistes van die gekose netwerkoperateur. Net so is 'n verskaffer se fooimetadata nie die rekening se finale kleinhandelprys nie. Gaan die toepaslike rekeningprys en registrasievoorwaardes afsonderlik na. Die laai van 'n katalogus keur nie 'n handelsmerk, veldtog of boodskapnommer goed nie.
Hanteer onbeskikbare katalogusse
Behou die kliënt se vorminskrywings as 'n opsoek misluk. Wys die fout en hou rekening met Retry-After wanneer dit teruggestuur word, en verleng die wagtyd tussen herpogings. Moenie elke katalogus herhaaldelik herlaai of 'n tempobeperkings- of vervoerfout as 'n leë, geldige katalogus beskou nie. Hierdie GET vereis nie 'n idempotensiesleutel nie en word nie vanuit die idempotensiestoor vir wysigings herhaal nie.
Versoek
Gebruik 'n geaktiveerde API-rekening oor HTTPS vanaf 'n toegelate bron-IP-adres. Die huidige roete ondersteun die rekening se stawingsbeleid, insluitend Basic-stawing en geaktiveerde API-rekeninge met draertokenstawing. Moenie die verskaffer se aanmeldbesonderhede gebruik nie.
Stuur 'n GET-versoek met 'n ondersteunde katalogusnaam in die pad. Gee toepaslike katalogusfilters in die navraagstring deur. Geen versoekliggaam is nodig nie.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/enum/usecase?validSubUsecase=true"| Naam | Tipe | Vereis | Beskrywing |
|---|---|---|---|
type | teksstring | Ja | Katalogusnaam, met die oorspronklike hoof- en kleinletters. Die portaal gebruik usecase, entityType, vertical, altBusinessIdType, brandRelationship, country, usState, stockExchange en cnp. Dit is katalogusname, nie handelsmerk- of veldtogidentifiseerders nie. |
| Naam | Tipe | Vereis | Beskrywing |
|---|---|---|---|
validSubUsecase | Boole-waarde | Nee | Vir die usecase-katalogus gebruik die portaal true in die versoek om geldige keuses vir subgebruiksgevalle te laai. Laat dit weg wanneer jy die gewone katalogus van gebruiksgevalle laai. Die register verskaf beskikbaarheidsinligting en definisies. |
Antwoord
Hierdie TCR-roete stuur die registerliggaam direk met sy HTTP-status terug. Dit gebruik nie die ouer v3-status.code/status.msg/response-omhulsel nie. Katalogusstrukture verskil: sommige koppel waardes aan beskrywende objekte; ander koppel waardes aan teksstringe. Behou die masjienleesbare sleutels wanneer jy 'n latere vorm indien. Die verkorte, fiktiewe usecase-voorbeeld illustreer 'n kartering met objekte as waardes, nie 'n lewendige katalogus of 'n gewaarborgde volledige skema nie. Kontroleer sowel die HTTP-status as die verwagte JSON-struktuur.
Illustrasie van die antwoordstruktuur; nie lewendige rekeningdata of 'n huidige kwotasie nie.
{
"2FA": {
"displayName": "Authentication",
"description": "Example authentication use case"
}
}Foute
- 401: Rekeningstawing het misluk. Kontroleer die API-aanmeldbesonderhede, of die rekening geaktiveer is en die toepaslike beperkings op bron-IP-adresse.
- 400/404 en ander registerfoute: Ongeldige of onbeskikbare katalogus of filter. Die huidige roete behou die stroomopdiens se HTTP-status en antwoordliggaam; daar is geen universele v3-foutomhulsel nie.
- 429: Die versoeklimiet vir die rekening of die gedeelde verskaffer is bereik. Hou rekening met Retry-After en probeer weer met toenemende wagtye tussen herpogings.
- 502: Die register kon nie bereik word nie. Beskikbaarheid is onbekend; moenie leë keuses as 'n suksesvolle resultaat teruggee nie.
- 503: Die versoekbeperker of stroomopdiens is onbeskikbaar. Ondersoek die liggaam en enige Retry-After-kopveld voordat jy weer probeer.
Beskikbaarheid en newe-effekte
- Hierdie katalogus-GET skep nie 'n handelsmerk of veldtog, dien nie 'n registrasie in, reserveer nie 'n hulpbron en hef nie 'n registrasiefooi in die nagegane pad nie. Dit kontak die verskaffer en skryf versoekouditrekords.
- Katalogusdefinisies en enige verskafferfooimetadata is nie 'n kleinhandelkwotasie vir die kliënt nie. Die huidige portaal verkry kleinhandelpryse vir veldtogte afsonderlik; die verouderde getCampaignPrice-hulpfunksie en ou prysaantekeninge by opsommingswaardes moet nie as hierdie roete se pryskontrak beskou word nie.
- 'n Ondersteunde katalogusinskrywing is nie bewys dat 'n bepaalde handelsmerk vir daardie gebruiksgeval kwalifiseer nie. Voltooi die handelsmerkspesifieke kwalifikasie, verklarings, toestemming en hersiening van rekeningpryse voordat jy 'n latere registrasieversoek indien.