Kūrėjams

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

Užsakykite išorinę prekės ženklo patikrą

Užsakykite paslaugų teikėjo patikrą, peržiūrėję jo reikalavimus ir nuo rezultato priklausančius mokesčius.

Šiame puslapyje
  1. Naudokite paskyrai priklausantį žinučių siuntimo prekės ženklą
  2. Užsakykite naują išorinę patikrą
  3. Parenkite užklausą paslaugų teikėjui
  4. Patvirtinkite mokesčius už sėkmingą ir nesėkmingą rezultatą
  5. Pateikite vieną peržiūrėtą užsakymą
  6. Stebėkite faktinį rezultatą
  7. Pakartotinai pateikite tą pačią numatytą užklausą

Naudokite paskyrai priklausantį žinučių siuntimo prekės ženklą

Naudokite įgalintą API paskyrą ir junkitės per HTTPS iš leidžiamo šaltinio IP adreso. Palaikomi Basic ir Bearer autentifikavimo būdai. Prekės ženklo identifikatorius turi priklausyti tai paskyrai. Paslaugų teikėjo prieigos raktus, prekės ženklo tapatybės duomenis ir gautas ataskaitas laikykite konfidencialiais.

Užsakykite naują išorinę patikrą

Naudokite POST, kai reikia, kad patikros paslaugų teikėjas atliktų naują šio prekės ženklo patikrą. Jei jau turite paslaugų teikėjo rezultatą, rinkitės importavimą. Tai atskira procedūra, nesusijusi su pakartotiniu prekės ženklo tapatybės patvirtinimu.

Pirmiausia peržiūrėkite esamą prekės ženklo įrašą ir patvirtinkite jo tapatybės informaciją. Pasirinkite palaikomą paslaugų teikėją ir klasę iš naujausių katalogų ir patikrinkite to paslaugų teikėjo reikalavimus. Ne kiekvienas paslaugų teikėjas palaiko visas klases. Papildomi politinės patikros duomenys turi apibūdinti tikrąją organizaciją ar kampaniją; pavyzdiniai duomenys netinka.

Parenkite užklausą paslaugų teikėjui

Išorinės patikros užsakymo laukai
LaukasReikšmė
evpIdPrivalomas paslaugų teikėjo identifikatorius iš naujausio išorinės patikros paslaugų teikėjų katalogo, 1–10 simbolių.
vettingClassPalaikoma klasė, kurią ketinate įsigyti; pasirinkite ją aiškiai ir patvirtinkite jos kainą.
additionalRequestPayloadJSON formatu užkoduota eilutė su konkrečiam paslaugų teikėjui skirtais duomenimis, privaloma politinei patikrai. Tai eilutė išoriniame JSON objekte, o ne įdėtinis objektas. Visus privalomus duomenis suderinkite su pasirinktu paslaugų teikėju.

Patvirtinkite mokesčius už sėkmingą ir nesėkmingą rezultatą

Dabartiniai mažmeniniai mokesčiai JAV doleriais, užfiksuoti spalio 24 d. (2026 m.). Prieš pateikdami tikrą užsakymą patvirtinkite dabartinę sumą. Iš anksto apmokėtų lėšų pakankamumas tikrinamas pagal sėkmingo rezultato kainą; pirkimai turi būti įgalinti.

Sukonfigūruoti išorinės patikros mokesčiai pagal rezultatą
KlasėAktyvus rezultatasNesėkmingas rezultatas
STANDARD$46.12$5.56
ENHANCED$112.78$6.67
POLITICAL$73.34$24.45
POLITICAL su Express užklausa$106.67$24.45
AUTHPLUS$13.89$13.89
RCS$83.34$83.34

Laukiantiems užsakymams išsaugomos jų sėkmės ir nesėkmės mokesčių sumos; mokestis nuskaitomas sinchronizavus ACTIVE arba FAILED rezultatą. Paskutinėms dviem klasėms taikomas toks pat sukonfigūruotas mokestis už bet kurį galutinį rezultatą. Jei galutinis rezultatas gaunamas iš karto, mokestis gali būti nuskaitomas teikiant užsakymo atsakymą. Vėlesnis būsenos sinchronizavimas gali užbaigti laukiančio mokesčio nuskaitymą.

Nelaikykite mock:true garantija, kad išorinė patikra bus nemokama. Dabartinis išorinės patikros atsiskaitymo procesas vis tiek gali užregistruoti tą užsakymą ir nuskaityti už jį mokestį. Pagal šias instrukcijas bandymams nereikia tikro pirkimo; naudokite neprisijungus veikiančius bandymų duomenų rinkinius, kol būsite pasirengę leisti atlikti mokamą patikrą.

Pateikite vieną peržiūrėtą užsakymą

Parenkite vetting-order.json failą su paslaugų teikėjo identifikatoriumi, klase ir visa privaloma papildoma informacija. Faile turi būti tikroji užklausa, kurią ketinate pateikti. Laikykite jį konfidencialiu.

curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
  --request POST \
  --header 'Content-Type: application/json' \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  --data-binary @vetting-order.json \
  "https://api.multitel.net/tcr/v2/brand/$BRAND_ID/externalVetting"

Stebėkite faktinį rezultatą

Sėkmingame HTTP atsakyme gali būti laukiančios patikros įrašas. Išsaugokite jo vettingId ir peržiūrėkite vettingStatus, priežastis, įvertį bei įsigaliojimo ir galiojimo pabaigos datas, jei jos pateiktos. PENDING ir UNSCORE reikia toliau stebėti; ACTIVE, FAILED ir EXPIRED nurodo skirtingus rezultatus. Vien priėmimas HTTP lygmeniu nepatvirtina palankaus įverčio ar kampanijos tinkamumo.

Naudokite išorinės patikros būseną įrašui stebėti. Galutinio rezultato nuskaitymas ar importavimas gali lemti mokesčio už ankstesnį mokamą užsakymą nuskaitymą; tai nebūtinai reiškia, kad nebus nuskaičiuotas jau esantis neapmokėtas mokestis.

Pakartotinai pateikite tą pačią numatytą užklausą

Kiekvienai numatytai operacijai naudokite vieną Idempotency-Key ir išsaugokite tikslų metodą, kelią, užklausos parametrus bei turinio baitus. Raktus gali sudaryti 1–128 spausdinamieji ASCII simboliai be tarpų. Dar vykdomos užklausos dublikatas gali grąžinti 409 su Retry-After. Užbaigtoms užklausoms pakartotinai grąžinamas išsaugotas atsakymas, įskaitant klaidas. Laikykitės užklausų dažnio ribojimų.

Po duomenų perdavimo sutrikimo gali būti išsaugotas 502 atsakymas. Išsaugotas 500 atsakymas su requestId gali reikšti, kad registras priėmė operaciją, tačiau nepavyko išsaugoti duomenų vietinėje saugykloje arba apskaičiuoti ar nuskaityti mokesčio. Išsaugokite užklausos identifikatorių, peržiūrėkite esamus įrašus ir prieš naudodami naują raktą išsiaiškinkite situaciją su pagalbos tarnyba. Nemanykite, kad klaida reiškia, jog užsakymo nėra.