Valige bränd, mida kontrollite
Kasutage oma konto brändi ID-d. Hoidke seda koos saadud taustakontrolli kirjetega, et ühe ettevõtte kontrolli ei aetaks segi teise ettevõtte kontrolliga. Ärge kasutage teise konto identifikaatoreid.
Jälgige olemasolevat kontrolli
Säilitage vettingId, evpId, vettingClass ja vettingStatus väärtused, kui need on olemas. Praegune sünkroonimine käsitleb olekuid PENDING ja UNSCORE täiendavat kontrolli ootavate tulemustena ning olekuid ACTIVE ja FAILED arveldamise jaoks lõplike tulemustena. Enne edasiste toimingute vajaduse üle otsustamist lugege vastuses saadud üksikasju. Tühi loend üksi ei tõenda, et varasem esitus ei jõudnud registrisse.
Tutvuge varasema tellimuse tasudega
Oleku kontrollimine ei telli uut taustakontrolli. See võib aga viia lõpetatud kontrolli tulemuse salvestatud andmetega kooskõlla ja arveldada varasema tasulise kontrollitaotlusega seotud tasu. See hõlmab ka kohaldatavat tasu ebaõnnestunud kontrolli eest. Lähtuge tellimisel üle vaadatud hinnast ja tingimustest; ärge järeldage praegust hinda vana näite või olekupäringu vastuse põhjal.
Korrake lugemispäringut uut tellimust esitamata
Ajutise tõrke korral säilitage brändi ID ja teadaolevad taustakontrolli ID-d, järgige päist Retry-After ning korrake seda lugemispäringut, suurendades katsete vahelist ooteaega. Ärge esitage uut kontrollitellimust üksnes seetõttu, et olekupäring ebaõnnestus või tagastas ootamatu vastusesisu. Püsiva lahknevuse korral võtke MultiTEL-iga ühendust autenditud tugikanali kaudu ja esitage asjakohased viite-ID-d.
Hoidke registreerimise etapid eraldi
Taustakontroll annab brändi kohta kontrollitulemuse. Kampaania nõuetele vastavuse hindamine, kampaania registreerimine ja numbri määramine on endiselt eraldi etapid. Enne sõnumite saatmist kontrollige nende praegust olekut ja nõudeid.
Päring
Kasutage lubatud lähte-IP-aadressilt HTTPS-ühenduse kaudu kontot, millel on API kasutamine lubatud. Kasutage oma konto, mitte registri autentimisandmeid. Bränd peab olema seotud autenditud kontoga.
Tehke GET-päring, mille teel on brändi ID ja millel on kohustuslik päringufilter vettingStatus. Ülevaadatud skeem määratleb olekute massiivi; selles näites päritakse ühte ACTIVE väärtust. See juhend ei kinnita mitme väärtuse kodeerimisviisi ega seda, et teenusepakkuja aktsepteerib filtrita päringuid. Päringu keha ei ole nõutav.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/brand/$BRAND_ID/externalVetting?vettingStatus=ACTIVE"| Nimi | Tüüp | Kohustuslik | Kirjeldus |
|---|---|---|---|
brandId | sõne | Jah | Teie MultiTEL-i kontoga seotud brändi ID registris. See ei ole teie konto ID ega taustakontrolli ID. |
| Nimi | Tüüp | Kohustuslik | Kirjeldus |
|---|---|---|---|
vettingStatus | sõnede massiiv | Jah | Kohustuslik olekufilter. Lubatud väärtused: PENDING, UNSCORE, ACTIVE, FAILED, EXPIRED. Näites esitatakse üks ACTIVE väärtus; mitme väärtuse kodeerimisviisi ega filtrita päringute aktsepteerimist teenusepakkuja poolt ei kinnitata. |
Vastus
Praegune marsruut säilitab registri HTTP oleku ja vastusesisu, selle asemel et kasutada varasemat v3 vastuse ümbrisstruktuuri. Lühendatud väljamõeldud massiiv näitlikustab välju, mida kasutab kohaliku sünkroonimise täitmistee; see ei ole salvestatud registrivastus ega garanteeritult täielik skeem. Enne kirjete lugemist kontrollige HTTP olekut ja JSON-i. Hoidke iga vettingId väärtus koos valitud brändiga.
Näitlik vastusestruktuur; see ei sisalda konto tegelikke andmeid ega kehtivat hinnapakkumist.
[
{
"vettingId": "example-vetting-id",
"evpId": "example-review-provider",
"vettingClass": "STANDARD",
"vettingStatus": "ACTIVE"
}
]Vead
- 401: Konto autentimine ebaõnnestus. Kontrollige autentimisandmeid, kas API kasutamine on lubatud, ja kohaldatavaid lähte-IP-aadressi piiranguid.
- 404: Bränd ei ole selle kontoga seotud või register ei leidnud seda. Konto omandiõiguse kontrollist tulenev keeldumine toimub enne registripäringut.
- 429: Konto või registri päringulimiit on saavutatud. Järgige päist Retry-After ja suurendage katsete vahelist ooteaega.
- 502/503: Andmeedastus, register, päringupiiraja või kohalik töötlus ei ole saadaval. Viga ei tõenda, et varasem kontrollitaotlus ebaõnnestus.
Kättesaadavus ja kõrvalmõjud
- See GET-päring ei esita uut taustakontrolli tellimust. See hangib registrist tulemused, kirjutab päringu auditikirjed ja sünkroonib salvestatud tulemused.
- Lõpetatud kontrolli tulemuse lugemine võib arveldada varem esitatud tasulise taustakontrolli tellimuse tasu. Ebaõnnestunud kontrolliga võib kaasneda kohaldatav ebaõnnestumise tasu. Vaadake hind ja tingimused üle tellimisel; see lugemispäring ei ole hinnapakkumine.
- Selle GET-päringuga imporditud uut avastatud kirjet ei liigitata automaatselt uueks tasuliseks tellimuseks.
- Edukas või olekuga ACTIVE taustakontrolli tulemus ei tähenda kampaania heakskiitu, telefoninumbri määramist ega luba sõnumeid saata.