Last inn kataloger for meldingsregistrering

Last inn alternativer før du bygger et registreringsskjema

Bruk den gjeldende katalogen for meldingsregistrering til å fylle ut alternativer i stedet for å hardkode registerverdier. For et merkevareskjema laster portalen inn kataloger for virksomhetstype, bransje, alternativ virksomhetsidentifikatortype, merkevarerelasjon, land, amerikansk delstat og børs. For et kampanjeskjema laster den inn bruksområder, gyldige underbruksområder og tilkoblingspartnere. Behold hver returnerte maskinverdi sammen med visningsetiketten; bruk verdien, ikke en oversatt etikett, når du bygger en senere forespørsel.

Velg en katalog

Behandle svaret fra TCR direkte

Svarinnholdet kommer direkte fra TCR-API. I motsetning til mange eldre /v3-endepunkter har det ingen ekstra status/response-innpakning. Kontroller HTTP-statusen før du tolker innholdet. En katalog kan inneholde tekstetiketter eller strukturerte definisjoner, så ikke anta at alle verdier har de samme feltene. Hvis HTTP-forespørselen lykkes, men innholdet ikke er gyldig JSON med forventet struktur, skal du rapportere et mislykket oppslag i stedet for å erstatte det med en tom liste uten varsel.

Skill katalogalternativer fra kvalifisering og priser

En generell katalog over bruksområder forteller ikke hvilke bruksområder en bestemt merkevare kvalifiserer for. Den nåværende portalen utfører et kvalifiseringsoppslag for den aktuelle merkevaren før kampanjen opprettes, og kontrollerer kravene fra den valgte operatøren. Leverandørens gebyrmetadata er heller ikke kontoens endelige sluttkundepris. Gjennomgå gjeldende kontopris og registreringsvilkår separat. Innlasting av en katalog godkjenner ikke en merkevare, kampanje eller et meldingsnummer.

Håndter utilgjengelige kataloger

Behold kundens skjemainndata hvis et oppslag mislykkes. Vis feilen, respekter Retry-After når den returneres, og øk ventetiden mellom nye forsøk. Ikke last inn alle katalogene gjentatte ganger eller behandle en feil knyttet til forespørselsgrensen eller transporten som en tom, gyldig katalog. Denne GET-forespørselen krever ingen idempotensnøkkel og spilles ikke av på nytt fra idempotenslageret for endringsoperasjoner.

Forespørsel

Bruk en aktivert API-konto over HTTPS fra en tillatt kilde-IP-adresse. Den nåværende ruten støtter kontoens autentiseringspolicy, inkludert Basic-autentisering og aktiverte API-kontoer med bærertoken. Ikke bruk leverandørens påloggingsopplysninger.

Bruk GET med et støttet katalognavn i stien. Send relevante katalogfiltre i spørringsstrengen. Forespørselen trenger ikke noe innhold.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/enum/usecase?validSubUsecase=true"

Svar

Denne TCR-ruten returnerer registerets svarinnhold direkte med tilhørende HTTP-status. Den bruker ikke den eldre v3-innpakningen status.code/status.msg/response. Katalogstrukturer varierer: Noen tilordner verdier til beskrivende objekter, andre til tekststrenger. Behold de maskinlesbare nøklene når du senere sender inn et skjema. Det forkortede, fiktive usecase-eksemplet viser en tilordning med objekter som verdier, ikke en oppdatert katalog eller et garantert fullstendig skjema. Kontroller både HTTP-statusen og forventet JSON-struktur.

Illustrasjon av svarstrukturen; ikke faktiske kontodata eller et gjeldende pristilbud.

{
  "2FA": {
    "displayName": "Authentication",
    "description": "Example authentication use case"
  }
}

Feil

• 401: Kontoautentiseringen mislyktes. Kontroller API-påloggingsopplysningen, at kontoen er aktivert, og gjeldende begrensninger for kilde-IP-adresser.
• 400/404 og andre registerfeil: Ugyldig eller utilgjengelig katalog eller filter. Den nåværende ruten beholder HTTP-statusen og svarinnholdet fra den bakenforliggende tjenesten; det finnes ingen universell v3-feilinnpakning.
• 429: Kontoens forespørselsgrense eller leverandørens delte forespørselsgrense er nådd. Respekter Retry-After og øk ventetiden mellom nye forsøk.
• 502: Kunne ikke nå registeret. Tilgjengeligheten er ukjent; ikke erstatt resultatet med tomme alternativer og presenter det som vellykket.
• 503: Forespørselsbegrenseren eller den bakenforliggende tjenesten er utilgjengelig. Undersøk svarinnholdet og et eventuelt Retry-After-hode før du prøver på nytt.

Tilgjengelighet og sideeffekter

• Denne GET-forespørselen for kataloger oppretter ikke en merkevare eller kampanje, sender ikke inn en registrering, reserverer ikke en ressurs og belaster ikke et registreringsgebyr i det gjennomgåtte forløpet. Den kontakter leverandøren og skriver revisjonslogger for forespørsler.
• Katalogdefinisjoner og eventuelle metadata om leverandørgebyrer er ikke et pristilbud til sluttkunden. Den nåværende portalen henter sluttkundepriser for kampanjer separat; den eldre hjelpefunksjonen getCampaignPrice og gamle prisannotasjoner i oppregningstyper må ikke behandles som denne rutens prisvilkår.
• En støttet katalogoppføring er ikke bevis på at en bestemt merkevare kvalifiserer for det aktuelle bruksområdet. Fullfør kvalifisering for den aktuelle merkevaren, erklæringer, samtykke og gjennomgang av kontopriser før en senere registreringsforespørsel.