Izstrādātājiem

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

Pārbaudiet zīmola izvērtēšanas rezultātus

Skatiet sava konta zīmola izvērtēšanas rezultātus un sekojiet esošai pārbaudei no gaidīšanas stāvokļa līdz veiksmīgam vai neveiksmīgam rezultātam.

Šajā lapā
  1. Atlasiet pārbaudāmo zīmolu
  2. Sekojiet esošai pārbaudei
  3. Izprotiet maksu par iepriekšēju pasūtījumu
  4. Atkārtojiet nolasīšanu, neiesniedzot vēl vienu pasūtījumu
  5. Nošķiriet reģistrācijas darbības
  6. Pieprasījums
  7. Atbilde
  8. Kļūdas
  9. Pieejamība un blakusefekti

Atlasiet pārbaudāmo zīmolu

Izmantojiet zīmola ID no sava konta. Saglabājiet to kopā ar iegūtajiem izvērtēšanas ierakstiem, lai viena uzņēmuma pārbaudi nesajauktu ar cita uzņēmuma pārbaudi. Neizmantojiet cita konta identifikatorus.

Sekojiet esošai pārbaudei

Saglabājiet vettingId, evpId, vettingClass un vettingStatus vērtības, ja tās ir norādītas. Pašreizējā sinhronizācija uzskata PENDING un UNSCORE par rezultātiem, kuriem vēl jāveic papildu pārbaude, savukārt ACTIVE un FAILED — par galīgiem rezultātiem norēķinu veikšanai. Pirms izlemjat, vai nepieciešamas turpmākas darbības, izlasiet atbildē saņemto detalizēto informāciju. Tukšs saraksts pats par sevi nepierāda, ka iepriekšējais iesniegums nav sasniedzis reģistru.

Izprotiet maksu par iepriekšēju pasūtījumu

Statusa pārbaude nepasūta vēl vienu izvērtēšanu. Tomēr tā var saskaņot pabeigtas pārbaudes rezultātu un veikt norēķinu par maksu, kas saistīta ar iepriekšēju maksas izvērtēšanas pieprasījumu. Tas ietver arī piemērojamo maksu par neveiksmīgu pārbaudi. Vadieties pēc cenas un noteikumiem, ar kuriem iepazināties pasūtīšanas brīdī; neizdariet secinājumus par pašreizējo cenu no veca piemēra vai statusa atbildes.

Atkārtojiet nolasīšanu, neiesniedzot vēl vienu pasūtījumu

Īslaicīgas kļūmes gadījumā saglabājiet zīmola ID un zināmos izvērtēšanas ID, ievērojiet Retry-After un atkārtojiet šo nolasīšanu, pakāpeniski palielinot gaidīšanas laiku starp mēģinājumiem. Neiesniedziet jaunu izvērtēšanas pasūtījumu tikai tāpēc, ka statusa pieprasījums neizdevās vai atgrieza negaidītu atbildes saturu. Ja neatbilstība saglabājas, sazinieties ar MultiTEL autentificētā atbalsta kanālā, norādot attiecīgos atsauces ID.

Nošķiriet reģistrācijas darbības

Izvērtēšana nosaka zīmola pārbaudes rezultātu. Kampaņas atbilstības izvērtēšana, kampaņas reģistrācija un numura piešķiršana joprojām ir atsevišķas darbības. Pirms ziņojumu sūtīšanas pārbaudiet to pašreizējo statusu un prasības.

Pieprasījums

Izmantojiet kontu ar iespējotu API piekļuvi, savienojoties ar HTTPS no atļautas avota IP adreses. Izmantojiet sava konta, nevis reģistra piekļuves datus. Zīmolam jābūt saistītam ar autentificēto kontu.

Izmantojiet GET ar zīmola ID ceļā un obligāto vaicājuma filtru vettingStatus. Pārskatītajā shēmā ir definēts statusu masīvs; šajā piemērā tiek pieprasīta viena ACTIVE vērtība. Šī rokasgrāmata neapstiprina vairāku vērtību kodēšanas veidu vai to, ka pakalpojuma sniedzējs pieņem pieprasījumus bez filtra. Pieprasījuma pamatdaļa nav nepieciešama.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/brand/$BRAND_ID/externalVetting?vettingStatus=ACTIVE"
Ceļa parametri
NosaukumsTipsObligātsApraksts
brandIdvirkneJāReģistra zīmola ID, kas saistīts ar jūsu MultiTEL kontu. Tas nav jūsu konta ID vai izvērtēšanas ID.
Vaicājuma parametri
NosaukumsTipsObligātsApraksts
vettingStatusvirkņu masīvsJāObligāts statusa filtrs. Atļautās vērtības: PENDING, UNSCORE, ACTIVE, FAILED, EXPIRED. Piemērā ir norādīta viena ACTIVE vērtība; netiek apgalvots, ka ir noteikts vairāku vērtību kodēšanas veids vai ka pakalpojuma sniedzējs pieņem pieprasījumus bez filtra.

Atbilde

Pašreizējais maršruts saglabā reģistra HTTP statusu un atbildes saturu, nevis izmanto iepriekšējās v3 versijas atbildes ietvaru. Saīsinātais izdomātais masīvs ilustrē laukus, kurus izmanto lokālās sinhronizācijas izpildes ceļš; tā nav fiksēta reģistra atbilde vai garantēti pilnīga shēma. Pirms ierakstu lasīšanas pārbaudiet HTTP statusu un JSON. Saglabājiet katru vettingId kopā ar atlasīto zīmolu.

Ilustratīva atbildes struktūra; tie nav konta faktiskie dati vai pašreizējs cenas piedāvājums.

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

Kļūdas

  • 401: Konta autentifikācija neizdevās. Pārbaudiet piekļuves datus, vai ir iespējota API piekļuve un kādi avota IP ierobežojumi ir piemērojami.
  • 404: Zīmols nav saistīts ar šo kontu, vai reģistrs to nevarēja atrast. Atteikums, kas saistīts ar zīmola piederību kontam, notiek pirms pieprasījuma nosūtīšanas reģistram.
  • 429: Sasniegts konta vai reģistra pieprasījumu limits. Ievērojiet Retry-After un pakāpeniski palieliniet gaidīšanas laiku starp mēģinājumiem.
  • 502/503: Nav pieejama datu pārsūtīšana, reģistrs, pieprasījumu ierobežotājs vai lokālā apstrāde. Kļūda nepierāda, ka iepriekšējais izvērtēšanas pieprasījums ir bijis neveiksmīgs.

Pieejamība un blakusefekti

  • Šis GET pieprasījums neveic jaunu izvērtēšanas pasūtījumu. Tas iegūst reģistra rezultātus, veido pieprasījuma audita ierakstus un sinhronizē saglabātos rezultātus.
  • Pabeigtas pārbaudes rezultāta nolasīšana var veikt norēķinu par iepriekš veiktu maksas izvērtēšanas pasūtījumu. Par neveiksmīgu pārbaudi var tikt piemērota attiecīga maksa. Pasūtīšanas brīdī iepazīstieties ar cenu un noteikumiem; šī nolasīšana nav cenas piedāvājums.
  • Jaunatklāts ieraksts, kas importēts ar šo GET pieprasījumu, netiek automātiski klasificēts kā jauns maksas pasūtījums.
  • Veiksmīgs izvērtēšanas rezultāts vai rezultāts ar statusu ACTIVE nav kampaņas apstiprinājums, tālruņa numura piešķiršana vai atļauja sūtīt ziņojumus.