Kūrėjams

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

Importuokite esamą patikros rezultatą

Susiekite palaikomo paslaugų teikėjo turimą rezultatą su savo prekės ženklu.

Šiame puslapyje
  1. Naudokite paskyrai priklausantį pranešimų siuntimo prekės ženklą
  2. Naudokite teikėjo turimą rezultatą
  3. Pasiruoškite importuoti
  4. Importuokite rezultatą vieną kartą
  5. Susipažinkite su jau taikomais mokesčiais
  6. Stebėkite faktinį rezultatą
  7. Pakartokite tą pačią numatytą užklausą

Naudokite paskyrai priklausantį pranešimų siuntimo prekės ženklą

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

Naudokite teikėjo turimą rezultatą

Naudokite PUT, kad susietumėte palaikomo teikėjo turimą patikros rezultatą su savo prekės ženklu. Taip nauja patikra neužsakoma. Tinkamą teikėjo operacijos identifikatorių ir, jei reikia, patvirtinimo raktą gaukite tiesiogiai iš to teikėjo ir įsitikinkite, kad ataskaita skirta tam pačiam verslo subjektui.

AUTHPLUS nepalaiko šios importavimo eigos. Konkretaus teikėjo duomenų atitikties taisyklės ir toliau galioja; importavimo užklausa jų nepanaikina ir negarantuoja tinkamumo kiekvienam kampanijos naudojimo atvejui.

Pasiruoškite importuoti

Išorinės patikros importavimo laukai
LaukasReikšmė
evpIdPalaikomo teikėjo identifikatorius, 1–10 simbolių.
vettingIdTikrasis teikėjo patikros operacijos identifikatorius, iki 255 simbolių. Vietoje jo nenaudokite prekės ženklo identifikatoriaus ir neišgalvokite identifikatoriaus.
vettingTokenPatvirtinimo raktas, kai jo reikalauja teikėjas, iki 65535 simbolių. Laikykite jį paslaptyje ir jo nesiųskite, kai teikėjas jo nereikalauja.

Sukurkite vetting-import.json naudodami tikrąsias teikėjo reikšmes. Nesiųskite tik atsakymuose pateikiamų įverčio, būsenos ar laiko žymos laukų, tarsi jie galėtų pakeisti rezultatą.

Importuokite rezultatą vieną kartą

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

Susipažinkite su jau taikomais mokesčiais

Šis tarpinis serveris naujai importuoto rezultato neregistruoja kaip naujo mokamo užsakymo. Tai neatšaukia anksčiau užsakytos patikros: jei tam pačiam vettingId jau yra užsakymas, kurio rezultato arba mokesčio nuskaičiavimo laukiama, importavus ACTIVE arba FAILED rezultatą gali būti nuskaičiuotas užsakyme išsaugotas mokestis. Šioje sinchronizavimo šakoje mokestis už įrašą, už kurį jau buvo sumokėta, pakartotinai nenuskaičiuojamas.

Stebėkite faktinį rezultatą

Sėkmingame HTTP atsakyme gali būti dar neužbaigtos patikros įrašas. Išsaugokite jo vettingId ir patikrinkite vettingStatus, priežastis, įvertį bei galiojimo pradžios ir pabaigos datas, jei šie duomenys pateikti. PENDING ir UNSCORE būsenas reikia stebėti toliau; ACTIVE, FAILED ir EXPIRED nurodo skirtingus rezultatus. Vien užklausos priėmimas HTTP lygmeniu nepatvirtina palankaus įverčio ar tinkamumo kampanijai.

Naudokite išorinės patikros būseną įrašui stebėti. Perskaičius arba importavus galutinį rezultatą gali būti nuskaičiuotas ankstesnio mokamo užsakymo mokestis; tai nebūtinai atliekama be jau esamo nesumokėto mokesčio nuskaičiavimo.

Pakartokite tą pačią numatytą užklausą

Kiekvienai numatytai operacijai naudokite vieną Idempotency-Key ir išsaugokite tikslų metodą, kelią, užklausos parametrus bei užklausos turinio baitus. Raktus gali sudaryti 1–128 spausdinamų ASCII simbolių 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 apribojimų.

Po duomenų perdavimo sutrikimo gali būti grąžintas podėlyje išsaugotas 502 atsakymas. Podėlyje išsaugotas 500 atsakymas su requestId gali reikšti, kad registras priėmė operaciją, tačiau nepavyko vietoje išsaugoti duomenų arba apskaičiuoti ar nuskaičiuoti mokesčio. Išsaugokite užklausos identifikatorių, patikrinkite esamus įrašus ir, prieš naudodami naują raktą, suderinkite padėtį su pagalbos tarnyba. Nemanykite, kad klaida reiškia, jog užsakymo nėra.