Catalogi voor berichtregistratie laden

Laad keuzemogelijkheden voordat u een registratieformulier opbouwt

Gebruik de actuele catalogus voor berichtregistratie om keuzelijsten te vullen in plaats van registerwaarden vast in de code op te nemen. Voor een merkformulier laadt het portaal catalogi met organisatievormen, sectoren, typen alternatieve bedrijfsidentificatie, relaties tot het merk, landen, Amerikaanse staten en effectenbeurzen. Voor een campagneformulier laadt het gebruiksscenario's, geldige onderliggende gebruiksscenario's en connectiviteitspartners. Bewaar elke geretourneerde machinewaarde samen met het bijbehorende weergavelabel; gebruik bij het opbouwen van een later verzoek de waarde, niet een vertaald label.

Kies een catalogus

Verwerk het TCR-antwoord rechtstreeks

De antwoordinhoud is rechtstreeks afkomstig van de TCR-API. Anders dan bij veel oudere /v3-eindpunten heeft deze geen toegevoegde status/response-omhulling. Controleer de HTTP-status voordat u het antwoord interpreteert. Een catalogus kan tekstlabels of gestructureerde definities bevatten, dus ga er niet van uit dat elke waarde dezelfde velden heeft. Als het HTTP-verzoek slaagt maar de inhoud geen geldige JSON met de verwachte structuur is, meld dan dat het ophalen is mislukt in plaats van het resultaat ongemerkt door een lege lijst te vervangen.

Houd cataloguskeuzes gescheiden van geschiktheidscontroles en prijzen

Een algemene catalogus met gebruiksscenario's geeft niet aan voor welke scenario's een afzonderlijk merk in aanmerking komt. Het huidige portaal vraagt vóór het aanmaken van een campagne de geschiktheid van het specifieke merk op en controleert de vereisten van de geselecteerde telecomaanbieders. Ook zijn de tariefmetadata van een leverancier niet de uiteindelijke klantprijs voor het account. Beoordeel de toepasselijke accountprijs en registratievoorwaarden afzonderlijk. Het laden van een catalogus betekent niet dat een merk, campagne of nummer voor berichtenverkeer is goedgekeurd.

Ga om met niet-beschikbare catalogi

Bewaar de formulierinvoer van de klant als het ophalen mislukt. Toon de fout, houd rekening met Retry-After wanneer deze header wordt geretourneerd en gebruik oplopende wachttijden tussen pogingen. Laad niet steeds alle catalogi opnieuw en behandel een fout door een verzoeklimiet of een transportfout niet als een geldige lege catalogus. Dit GET-verzoek vereist geen idempotentiesleutel en wordt niet opnieuw afgespeeld vanuit de idempotentieopslag voor wijzigingen.

Verzoek

Gebruik een ingeschakeld API-account via HTTPS vanaf een toegestaan bron-IP-adres. De huidige route ondersteunt het authenticatiebeleid van het account, waaronder Basic-authenticatie en ingeschakelde API-accounts met authenticatie via een bearertoken. Gebruik geen inloggegevens van de provider.

Voer een GET-verzoek uit met een ondersteunde catalogusnaam in het pad. Geef toepasselijke catalogusfilters mee in de querystring. Een verzoekinhoud is niet nodig.

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

Antwoord

Deze TCR-route retourneert de antwoordinhoud van het register rechtstreeks met de bijbehorende HTTP-status. De route gebruikt niet de oudere v3-omhulling status.code/status.msg/response. Catalogusstructuren verschillen: sommige koppelen waarden aan beschrijvende objecten, andere koppelen waarden aan tekenreeksen. Behoud de machineleesbare sleutels wanneer u later een formulier indient. Het ingekorte fictieve usecase-voorbeeld toont een toewijzing met objecten als waarden, geen actuele catalogus of gegarandeerd volledig schema. Controleer zowel de HTTP-status als de verwachte JSON-structuur.

Voorbeeld van de antwoordstructuur; geen actuele accountgegevens of geldende prijsopgave.

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

Fouten

• 401: Accountauthenticatie is mislukt. Controleer de API-inloggegevens, of het account is ingeschakeld en welke beperkingen voor bron-IP-adressen van toepassing zijn.
• 400/404 en andere registerfouten: ongeldige of niet-beschikbare catalogus of filter. De huidige route behoudt de HTTP-status en antwoordinhoud van de achterliggende dienst; er is geen universele v3-foutomhulling.
• 429: De verzoeklimiet van het account of de gedeelde verzoeklimiet van de provider is bereikt. Houd rekening met Retry-After en probeer het opnieuw met oplopende wachttijden.
• 502: Het register kon niet worden bereikt. De beschikbaarheid is onbekend; geef geen lege keuzelijst terug alsof het ophalen is geslaagd.
• 503: De verzoekbegrenzer of achterliggende dienst is niet beschikbaar. Controleer de antwoordinhoud en een eventuele Retry-After-header voordat u het opnieuw probeert.

Beschikbaarheid en neveneffecten

• Dit GET-verzoek voor een catalogus maakt in het beoordeelde uitvoeringspad geen merk of campagne aan, dient geen registratie in, reserveert geen resource en brengt geen registratiekosten in rekening. Het neemt contact op met de provider en schrijft auditregistraties van verzoeken.
• Catalogusdefinities en eventuele tariefmetadata van leveranciers vormen geen prijsopgave voor de klant. Het huidige portaal haalt klantprijzen voor campagnes afzonderlijk op; de verouderde hulpfunctie getCampaignPrice en oude prijsannotaties bij opsommingswaarden mogen niet als prijscontract van deze route worden beschouwd.
• Een ondersteunde catalogusvermelding bewijst niet dat een bepaald merk voor dat gebruiksscenario in aanmerking komt. Rond de geschiktheidscontrole voor het specifieke merk, verklaringen, toestemming en de beoordeling van de accountprijzen af voordat u later een registratieverzoek indient.