Ontwikkelaars

GET/tcr/v2/brand/{brandId}/externalVetting

Gaan ’n handelsmerk se keuringsresultate na

Lees keuringsresultate vir ’n handelsmerk op jou rekening en volg ’n bestaande beoordeling deur hangende, suksesvolle of mislukte resultate.

Op hierdie bladsy
  1. Kies die handelsmerk wat jy nagaan
  2. Volg ’n bestaande beoordeling
  3. Verstaan die koste vir ’n vroeëre bestelling
  4. Probeer weer om die data te lees sonder om nog ’n bestelling in te dien
  5. Hou registrasiestappe apart
  6. Versoek
  7. Antwoord
  8. Foute
  9. Beskikbaarheid en bykomende uitwerkings

Kies die handelsmerk wat jy nagaan

Gebruik die handelsmerk-ID uit jou rekening. Bewaar dit saam met die gevolglike keuringsrekords sodat ’n beoordeling vir een onderneming nie met ’n ander onderneming se beoordeling verwar word nie. Moenie ’n ander rekening se identifiseerders gebruik nie.

Volg ’n bestaande beoordeling

Bewaar die vettingId, evpId, vettingClass en vettingStatus wanneer dit teenwoordig is. Die huidige sinchronisasie hanteer PENDING en UNSCORE as resultate wat steeds op verdere kontrolering wag, en ACTIVE en FAILED as finale resultate vir vereffening. Lees die besonderhede wat teruggestuur is voordat jy besluit of enige opvolg nodig is. ’n Leë lys alleen is nie bewys dat ’n vorige indiening nie die register bereik het nie.

Verstaan die koste vir ’n vroeëre bestelling

Om die status na te gaan, bestel nie nog ’n beoordeling nie. Dit kan egter ’n voltooide resultaat rekonsilieer en die koste verbonde aan ’n vroeëre faktureerbare beoordelingsversoek vereffen. Dit sluit ’n toepaslike fooi vir ’n mislukte beoordeling in. Gebruik die prys en voorwaardes wat ten tyde van die bestelling nagegaan is; moenie vandag se prys uit ’n ou voorbeeld of ’n statusantwoord aflei nie.

Probeer weer om die data te lees sonder om nog ’n bestelling in te dien

Bewaar die handelsmerk-ID en bekende keurings-ID’s by ’n tydelike mislukking, hou by Retry-After en probeer weer om hierdie data te lees met toenemende wagtye tussen pogings. Moenie ’n nuwe beoordeling bestel bloot omdat die statusnaslaan misluk het of ’n onverwagte antwoordliggaam teruggestuur het nie. Kontak MultiTEL by ’n aanhoudende teenstrydigheid deur ’n geoutentiseerde ondersteuningskanaal en verskaf die toepaslike verwysings-ID’s.

Hou registrasiestappe apart

Keuring stel ’n beoordelingsresultaat vir die handelsmerk vas. Veldtogkwalifikasie, veldtogregistrasie en nommertoewysing bly afsonderlike stappe. Gaan hul huidige status en vereistes na voordat jy boodskappe stuur.

Versoek

Gebruik ’n geaktiveerde API-rekening oor HTTPS vanaf ’n toegelate bron-IP-adres. Gebruik jou rekening se aanmeldbesonderhede, nie die register se aanmeldbesonderhede nie. Die handelsmerk moet aan die geoutentiseerde rekening gekoppel wees.

Gebruik GET met die handelsmerk-ID in die pad en die verpligte vettingStatus-navraagfilter. Die nagegane skema definieer ’n skikking van statusse; hierdie voorbeeld vra een ACTIVE-waarde aan. Hierdie gids bevestig nie hoe veelvuldige waardes geënkodeer word of dat die verskaffer ongefiltreerde versoeke aanvaar nie. Geen versoekliggaam word vereis nie.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/brand/$BRAND_ID/externalVetting?vettingStatus=ACTIVE"
Padparameters
NaamTipeVerpligtendBeskrywing
brandIdteksstringJaDie handelsmerk-ID in die register wat aan jou MultiTEL-rekening gekoppel is. Dit is nie jou rekening-ID of ’n keurings-ID nie.
Navraagparameters
NaamTipeVerpligtendBeskrywing
vettingStatusskikking van teksstringeJaVerpligte statusfilter. Toegelate waardes: PENDING, UNSCORE, ACTIVE, FAILED, EXPIRED. Die voorbeeld verskaf een ACTIVE-waarde; geen aanspraak word gemaak oor die enkodering van veelvuldige waardes of die verskaffer se aanvaarding van ongefiltreerde versoeke nie.

Antwoord

Die huidige roete behou die register se HTTP-status en antwoordliggaam eerder as om die verouderde v3-antwoordomhulsel te gebruik. Die verkorte fiktiewe skikking illustreer velde wat deur die plaaslike sinchronisasieproses gebruik word; dit is nie ’n vasgelegde registerantwoord of ’n gewaarborgde volledige skema nie. Gaan die HTTP-status en JSON na voordat jy rekords lees. Bewaar elke vettingId saam met die gekose handelsmerk.

Illustrasie van die antwoordstruktuur; dit is nie lewendige rekeningdata of ’n huidige kwotasie nie.

[
  {
    "vettingId": "example-vetting-id",
    "evpId": "example-review-provider",
    "vettingClass": "STANDARD",
    "vettingStatus": "ACTIVE"
  }
]

Foute

  • 401: Rekeningstawing het misluk. Gaan die aanmeldbesonderhede, die API se aktiveringstatus en toepaslike bron-IP-beperkings na.
  • 404: Die handelsmerk is nie aan hierdie rekening gekoppel nie, of die register kon dit nie vind nie. ’n Weiering op grond van rekeningeienaarskap vind plaas voordat die versoek na die register gestuur word.
  • 429: Die rekening of register se versoeklimiet is bereik. Hou by Retry-After en gebruik toenemende wagtye tussen pogings.
  • 502/503: Die datavervoer, register, versoekbegrenser of plaaslike verwerking is nie beskikbaar nie. ’n Fout bevestig nie dat ’n vroeëre beoordelingsversoek misluk het nie.

Beskikbaarheid en bykomende uitwerkings

  • Hierdie GET plaas nie ’n nuwe keuringsbestelling nie. Dit haal registerresultate op, skryf ouditrekords vir die versoek en sinchroniseer gestoorde resultate.
  • Die lees van ’n voltooide resultaat kan die koste vir ’n voorheen geplaasde faktureerbare keuringsbestelling vereffen. ’n Mislukte beoordeling kan aan ’n toepaslike fooi vir mislukking onderhewig wees. Gaan die prys en voorwaardes na wanneer jy bestel; hierdie leesversoek is nie ’n pryskwotasie nie.
  • ’n Nuut ontdekte rekord wat deur hierdie GET ingevoer word, word nie outomaties as ’n nuwe faktureerbare bestelling geklassifiseer nie.
  • ’n Suksesvolle keuringsresultaat of een met die status ACTIVE beteken nie veldtoggoedkeuring, telefoonnommertoewysing of toestemming om boodskappe te stuur nie.