Indlæs kataloger til registrering af beskedtjenester

Indlæs valgmuligheder, før du opbygger en registreringsformular

Brug det aktuelle katalog til registrering af beskedtjenester til at udfylde valgmuligheder i stedet for at hardkode registerværdier. Til en brandformular indlæser portalen kataloger over virksomhedsform, branche, type af alternativt virksomheds-id, relation til brandet, land, amerikansk delstat og børs. Til en kampagneformular indlæser den anvendelsesområder, gyldige underområder og forbindelsespartnere. Gem hver returneret maskinværdi sammen med dens visningstekst; brug værdien, ikke en oversat visningstekst, når du opbygger en senere anmodning.

Vælg et katalog

Håndter svaret fra TCR direkte

Svarindholdet kommer direkte fra TCR-API'et. I modsætning til mange ældre /v3-endepunkter har det ingen tilføjet status/response-indpakning. Kontrollér HTTP-statussen, før du fortolker indholdet. Et katalog kan indeholde visningstekster som tekststrenge eller strukturerede definitioner, så antag ikke, at alle værdier har de samme felter. Hvis HTTP-anmodningen lykkes, men indholdet ikke er gyldig JSON med den forventede struktur, skal du rapportere et mislykket opslag i stedet for ubemærket at erstatte det med en tom liste.

Hold katalogvalg adskilt fra kvalificering og prissætning

Et generelt katalog over anvendelsesområder fortæller ikke, hvilke anvendelsesområder et bestemt brand kvalificerer sig til. Den nuværende portal foretager et brandspecifikt kvalificeringsopslag, før en kampagne oprettes, og kontrollerer kravene fra den valgte operatør. Tilsvarende er en leverandørs gebyrmetadata ikke kontoens endelige kundepris. Gennemgå den gældende pris for kontoen og registreringsvilkårene særskilt. Indlæsning af et katalog godkender ikke et brand, en kampagne eller et nummer til beskedtjenester.

Håndter utilgængelige kataloger

Bevar kundens indtastninger i formularen, hvis et opslag mislykkes. Vis fejlen, overhold Retry-After når den returneres, og brug gradvist længere ventetid mellem nye forsøg. Genindlæs ikke alle kataloger gentagne gange, og behandl ikke en fejl vedrørende anmodningsgrænser eller transport som et tomt, gyldigt katalog. Denne GET kræver ikke en idempotensnøgle og genafspilles ikke fra idempotenslageret for ændringsoperationer.

Anmodning

Brug en aktiveret API-konto via HTTPS fra en tilladt kilde-IP-adresse. Den aktuelle rute understøtter kontoens autentificeringspolitik, herunder Basic-autentificering og aktiverede API-konti med bearer-token. Brug ikke udbyderens legitimationsoplysninger.

Brug GET med et understøttet katalognavn i stien. Angiv relevante katalogfiltre i forespørgselsstrengen. Anmodningen behøver intet indhold.

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-rute returnerer registrets indhold direkte sammen med dets HTTP-status. Den bruger ikke den ældre v3-indpakning med status.code/status.msg/response. Katalogernes strukturer varierer: nogle knytter værdier til beskrivende objekter, mens andre knytter værdier til tekststrenge. Bevar de maskinlæsbare nøgler, når du senere indsender en formular. Det forkortede, fiktive usecase-eksempel viser en opslagstabel med objekter som værdier, ikke et aktuelt katalog eller et garanteret fuldstændigt skema. Kontrollér både HTTP-statussen og den forventede JSON-struktur.

Illustration af svarstrukturen; ikke aktuelle kontodata eller et gældende pristilbud.

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

Fejl

• 401: Autentificering af kontoen mislykkedes. Kontrollér API-legitimationsoplysningerne, om kontoen er aktiveret, og de gældende begrænsninger for kilde-IP-adresser.
• 400/404 og andre registerfejl: Ugyldigt eller utilgængeligt katalog eller filter. Den aktuelle rute bevarer den bagvedliggende tjenestes HTTP-status og svarindhold; der findes ingen universel v3-fejlindpakning.
• 429: Kontoens eller udbyderens fælles anmodningsgrænse er nået. Overhold Retry-After, og prøv igen med gradvist længere ventetid mellem forsøgene.
• 502: Der kunne ikke oprettes forbindelse til registret. Tilgængeligheden er ukendt; erstat ikke resultatet med tomme valgmuligheder, som om opslaget var lykkedes.
• 503: Anmodningsbegrænseren eller den bagvedliggende tjeneste er utilgængelig. Undersøg indholdet og en eventuel Retry-After-header, før du prøver igen.

Tilgængelighed og sideeffekter

• Denne GET til katalogopslag opretter ikke et brand eller en kampagne, indsender ikke en registrering, reserverer ikke en ressource og opkræver ikke et registreringsgebyr i det gennemgåede forløb. Den kontakter udbyderen og skriver revisionsposter for anmodningen.
• Katalogdefinitioner og eventuelle metadata om leverandørgebyrer er ikke et pristilbud til kunden. Den nuværende portal henter kundepriser for kampagner særskilt; den ældre hjælpefunktion getCampaignPrice og gamle prisangivelser på enum-værdier må ikke betragtes som denne rutes priskontrakt.
• En understøttet katalogpost er ikke bevis for, at et bestemt brand kvalificerer sig til det pågældende anvendelsesområde. Gennemfør brandspecifik kvalificering, afgiv erklæringer, indhent samtykke, og gennemgå kontoens priser før en senere registreringsanmodning.