Hae valintavaihtoehdot ennen rekisteröintilomakkeen rakentamista
Täytä valintavaihtoehdot viestipalvelujen ajantasaisesta rekisteröintiluettelosta sen sijaan, että kovakoodaisit rekisteriarvot. Brändilomaketta varten portaali hakee yritystyypin, toimialan, vaihtoehtoisen yritystunnisteen tyypin, brändisuhteen, maan, Yhdysvaltain osavaltion ja pörssin luettelot. Kampanjalomaketta varten se hakee käyttötapaukset, kelvolliset alikäyttötapaukset ja yhteyskumppanit. Säilytä jokainen palautettu koneellinen arvo yhdessä sen näyttötekstin kanssa; käytä arvoa, älä käännettyä näyttötekstiä, kun muodostat myöhemmän pyynnön.
Valitse luettelo
| Nimi | Tarkoitus |
|---|---|
| usecase | Kampanjoiden käyttötapausten määritelmät. Lisää validSubUsecase=true, kun haet alikäyttötapausten valintavaihtoehtoja. |
| entityType | Brändin yritys- tai organisaatiotyyppi. |
| vertical | Brändin toimialavaihtoehdot. |
| altBusinessIdType | Vaihtoehtoisten yritystunnisteiden luokat. |
| brandRelationship | Rekisteröintilomakkeessa käytettävät suhdevaihtoehdot. |
| country | Rekisterin maavaihtoehdot; nämä ovat erillisiä maista, joissa puhelinnumeroita on saatavilla. |
| usState | Yhdysvaltain osavaltiovaihtoehdot rekisteröintiosoitteita varten. |
| stockExchange | Pörssivaihtoehdot silloin, kun brändin yritystyyppi edellyttää niitä. |
| cnp | Yhteyskumppanien tunnisteet. Valitse tilisi kampanjatyönkulun tukema kumppani. |
Käsittele TCR-vastaus suoraan
Vastauksen runko tulee suoraan TCR-API-rajapinnasta. Toisin kuin monissa vanhemmissa /v3-päätepisteissä, siinä ei ole lisättyä status/response-käärettä. Tarkista HTTP-tilakoodi ennen vastauksen tulkitsemista. Luettelo voi sisältää merkkijonomuotoisia näyttötekstejä tai rakenteisia määritelmiä, joten älä oleta, että kaikilla arvoilla on samat kentät. Jos HTTP-pyyntö onnistuu mutta runko ei ole kelvollista, odotetun rakenteen mukaista JSON-dataa, ilmoita haun epäonnistumisesta sen sijaan, että korvaisit vastauksen huomaamatta tyhjällä luettelolla.
Pidä luettelon valintavaihtoehdot erillään kelpoisuuden tarkistamisesta ja hinnoittelusta
Yleinen käyttötapausluettelo ei kerro, mihin käyttötapauksiin yksittäinen brändi on kelpoinen. Nykyinen portaali tekee brändikohtaisen kelpoisuushaun ennen kampanjan luomista ja tarkistaa valitun operaattorin vaatimukset. Vastaavasti toimittajan maksujen metatiedot eivät ole tilin lopullinen asiakashinta. Tarkista sovellettava tilikohtainen hinta ja rekisteröintiehdot erikseen. Luettelon hakeminen ei hyväksy brändiä, kampanjaa tai viestinumeroa.
Käsittele tilanteet, joissa luetteloita ei ole saatavilla
Säilytä asiakkaan lomakkeeseen syöttämät tiedot, jos haku epäonnistuu. Näytä virhe ja noudata otsaketta Retry-After silloin, kun se palautetaan, ja pidennä odotusaikaa uudelleenyritysten välillä. Älä hae kaikkia luetteloita toistuvasti uudelleen äläkä tulkitse pyyntörajoitus- tai tiedonsiirtovirhettä tyhjäksi kelvolliseksi luetteloksi. Tämä GET-pyyntö ei edellytä idempotenssiavainta, eikä sitä toisteta muutospyyntöjen idempotenssivarastosta.
Pyyntö
Käytä käytössä olevaa API-tiliä HTTPS-yhteydellä sallitusta lähde-IP-osoitteesta. Nykyinen reitti tukee tilin todennuskäytäntöä, mukaan lukien Basic-todennus ja käytössä olevat bearer-todennusta käyttävät API-tilit. Älä käytä palveluntarjoajan tunnistetietoja.
Tee GET-pyyntö, jonka polussa on tuettu luettelon nimi. Välitä sovellettavat luettelosuodattimet kyselymerkkijonossa. Pyynnön runkoa ei tarvita.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/enum/usecase?validSubUsecase=true"| Nimi | Tyyppi | Pakollinen | Kuvaus |
|---|---|---|---|
type | merkkijono | Kyllä | Luettelon nimi alkuperäisessä kirjainkoossa. Portaali käyttää nimiä usecase, entityType, vertical, altBusinessIdType, brandRelationship, country, usState, stockExchange ja cnp. Nämä ovat luetteloiden nimiä, eivät brändien tai kampanjoiden tunnisteita. |
| Nimi | Tyyppi | Pakollinen | Kuvaus |
|---|---|---|---|
validSubUsecase | totuusarvo | Ei | Portaali käyttää luettelon usecase pyynnössä arvoa true hakeakseen kelvolliset alikäyttötapausten valintavaihtoehdot. Jätä parametri pois, kun haet tavallisen käyttötapausluettelon. Rekisteri toimittaa saatavuustiedot ja määritelmät. |
Vastaus
Tämä TCR-reitti palauttaa rekisterin vastauksen rungon suoraan yhdessä sen HTTP-tilakoodin kanssa. Se ei käytä vanhempaa v3-version status.code/status.msg/response-käärettä. Luetteloiden rakenteet vaihtelevat: jotkin yhdistävät arvot kuvaileviin olioihin, toiset merkkijonoihin. Säilytä koneellisesti luettavat avaimet, kun lähetät myöhemmin lomakkeen. Lyhennetty kuvitteellinen usecase-esimerkki havainnollistaa oliot arvoina sisältävää hakurakennetta, ei ajantasaista luetteloa tai taatusti täydellistä skeemaa. Tarkista sekä HTTP-tilakoodi että odotettu JSON-rakenne.
Havainnollistava vastauksen rakenne; ei ajantasaisia tilitietoja eikä voimassa oleva hintatarjous.
{
"2FA": {
"displayName": "Authentication",
"description": "Example authentication use case"
}
}Virheet
- 401: Tilin todennus epäonnistui. Tarkista API-tunnistetiedot, tilin käytössäolo ja sovellettavat lähde-IP-rajoitukset.
- 400/404 ja muut rekisterivirheet: Virheellinen tai ei saatavilla oleva luettelo tai suodatin. Nykyinen reitti säilyttää taustapalvelun HTTP-tilakoodin ja vastauksen rungon; yleispätevää v3-virhekäärettä ei ole.
- 429: Tilin tai palveluntarjoajan yhteinen pyyntöraja on saavutettu. Noudata Retry-After-otsaketta ja pidennä odotusaikaa uudelleenyritysten välillä.
- 502: Rekisteriin ei saatu yhteyttä. Saatavuutta ei tiedetä; älä korvaa vastausta tyhjillä valintavaihtoehdoilla ja käsittele sitä onnistuneena tuloksena.
- 503: Pyyntörajoitin tai taustapalvelu ei ole käytettävissä. Tarkista vastauksen runko ja mahdollinen Retry-After-otsake ennen uudelleenyritystä.
Saatavuus ja sivuvaikutukset
- Tämä luettelon GET-pyyntö ei luo brändiä tai kampanjaa, lähetä rekisteröintiä, varaa resurssia eikä veloita rekisteröintimaksua katselmoidussa käsittelypolussa. Se ottaa yhteyden palveluntarjoajaan ja kirjoittaa pyynnön tarkastuslokimerkinnät.
- Luetteloiden määritelmät ja mahdolliset toimittajan maksujen metatiedot eivät ole asiakkaalle annettava hintatarjous. Nykyinen portaali hakee kampanjoiden asiakashinnat erikseen; vanhaa getCampaignPrice-apufunktiota ja vanhoja luetteloarvojen hintamerkintöjä ei saa pitää tämän reitin hinnoittelusopimuksena.
- Tuettu luettelomerkintä ei todista, että tietty brändi on kelpoinen kyseiseen käyttötapaukseen. Suorita brändikohtainen kelpoisuuden tarkistus, anna vaaditut vakuutukset, hanki suostumus ja tarkista tilin hinnoittelu ennen myöhempää rekisteröintipyyntöä.