Brug et brand til beskedtjenester, som tilhører kontoen
Brug en aktiveret API-konto via HTTPS fra en tilladt kilde-IP-adresse. Godkendelse med Basic og Bearer understøttes. Brandets ID skal tilhøre den pågældende konto. Hold udbyderens tokens, brandets identitetsoplysninger og de returnerede rapporter fortrolige.
Brug et eksisterende resultat fra en udbyder
Brug PUT til at knytte et eksisterende kontrolresultat fra en understøttet udbyder til dit brand. Det bestiller ikke en ny kontrol. Indhent det korrekte transaktions-ID hos udbyderen og et eventuelt bekræftelsestoken direkte fra denne udbyder, og sørg for, at rapporten vedrører den samme virksomhedsidentitet.
AUTHPLUS understøtter ikke denne importproces. Udbyderspecifikke regler for overensstemmelse gælder stadig; en importanmodning tilsidesætter dem ikke og garanterer heller ikke, at brandet opfylder kravene til enhver anvendelse af kampagner.
Forbered importen
| Felt | Værdi |
|---|---|
| evpId | ID for en understøttet udbyder, 1–10 tegn. |
| vettingId | Udbyderens faktiske identifikator for kontroltransaktionen, højst 255 tegn. Brug ikke brandets ID i stedet, og opfind ikke en identifikator. |
| vettingToken | Bekræftelsestoken, når udbyderen kræver det, højst 65535 tegn. Behandl det som en hemmelighed, og udelad det, når udbyderen ikke kræver det. |
Opret vetting-import.json med de faktiske værdier fra udbyderen. Send ikke felter for score, status eller tidsstempel, der kun forekommer i svar, som om de kunne ændre resultatet.
Importér resultatet én gang
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"Forstå eksisterende opkrævninger
Denne proxy registrerer ikke et nyligt importeret resultat som en ny betalingspligtig bestilling. Det annullerer ikke en tidligere bestilt kontrol: når der for samme vettingId allerede findes en bestilling, som afventer resultat eller opkrævning, kan import af et resultat med status ACTIVE eller FAILED medføre afregning af det gemte gebyr. Denne gren af synkroniseringen opkræver ikke gebyret igen for en post, der allerede er opkrævet betaling for.
Følg det faktiske udfald
Et vellykket HTTP-svar kan indeholde en kontrolpost, der stadig afventer behandling. Gem dens vettingId, og gennemgå vettingStatus, begrundelser, score samt ikrafttrædelses- og udløbsdatoer, når de er tilgængelige. PENDING og UNSCORE kræver yderligere opfølgning; ACTIVE, FAILED og EXPIRED beskriver forskellige udfald. Accept på HTTP-niveau er ikke i sig selv bevis på en gunstig score eller på, at kravene til kampagner er opfyldt.
Brug status for ekstern kontrol til at følge posten. Læsning eller import af et endeligt resultat kan medføre afregning af en tidligere betalingspligtig bestilling; det er ikke nødvendigvis uden opkrævning af et eksisterende udestående beløb.
Gentag den samme tilsigtede anmodning
Brug én Idempotency-Key pr. tilsigtet handling, og bevar den nøjagtige metode, sti, forespørgsel og anmodningstekstens bytes. Nøgler understøtter 1–128 udskrivbare ASCII-tegn uden mellemrum. En dublet af en anmodning, der stadig behandles, kan returnere 409 med Retry-After. Afsluttede anmodninger returnerer deres gemte svar igen, herunder fejl. Overhold grænserne for anmodningsfrekvens.
En cachelagret 502 kan følge efter en transportfejl. En cachelagret 500 med requestId kan betyde, at registret accepterede handlingen, men at lokal lagring eller fakturering mislykkedes. Gem anmodningens ID, gennemgå de aktuelle poster, og afstem forholdene med support, før du bruger en ny nøgle. Antag ikke, at fejlen betyder, at der ikke findes nogen bestilling.