SSP API dokumentatsioon
Pakkumispoolse platvormi API programmaatilistele reklaamiplatvormidele
https://polads.eu/api/v1GET /online-advertisement/{PAID}
10,000 päringut minutis
Päringupiirangut rakendatakse iga SSP loa kohta eraldi
/online-advertisement/{PAID}📊 Kompaktne märgisevorming
See lõpp-punkt tagastab kompaktse, EL-i nõuetele vastava läbipaistvusmärgise, mis sobib kuvamiseks veebireklaamide kõrval. Töötab ainult reklaamide puhul, mille meedium = "online".
curl -X GET "https://polads.eu/api/v1/online-advertisement/ABC12" \
-H "Authorization: Bearer YOUR_SSP_TOKEN" \
-H "Accept: application/json"{
"text": "Politisk Reklame - ACME Corp - Folketingsvalg - polads.eu/ABC12",
"link": "https://polads.eu/ABC12",
"PAID": "ABC12"
}Kuvage silt oma platvormil:
<a href="[link]" target="_blank" rel="noopener">
[text]
</a>Päise vorming
Authorization: Bearer YOUR_SSP_TOKENLoa vorming
64-kohaline kuueteistkümnendjada (256-bitine entroopia)
Lubade haldamine
SSP-lube haldavad ainult süsteemiadministraatorid. Loa saamiseks võtke ühendust oma administraatoriga.
Ükski tellimuspakett ei kohaldu
SSP luba antakse liidestajale, mitte avaldajale, seega ei kuulu see ühegi avaldajakonto juurde ja kontrollitavat paketti pole. Erinevalt partneri API-st ei sõltu siin miski tellimusest. Partneri luba lükatakse selles lõpp-punktis tagasi koodiga 401 ja SSP luba lükatakse samamoodi tagasi partneri lõpp-punktides.
Millal lõpp-punkt tagastab 404
Teadet otsitakse sama nähtavusreegli järgi nagu avalikus registris. Kui teade pole veel kinnitatud, avaldaja pole seda veel heaks kiitnud või selle avaldamise alguskuupäev on alles tulevikus, tagastatakse 404. Seega ei tõenda vastus 404, et PA-ID on vale.
Ülal olev lõpp-punkt tagastab üherealise sildi TEKSTI sildi jaoks, mille kuvab teie enda platvorm. Märk tagastab valmis kuvatud interaktiivse teate, mille paigutate reklaami kõrvale raamina. Mõlemad kirjeldavad sama läbipaistvusteadet.
Üks URL iga versiooni kohta
Näidise juhtnupud vastavad neile parameetritele üks ühele, nii et saate valida näidislehel ja kopeerida nähtava aadressi.
# Nurgamärk, ainult märk
GET https://polads.eu/badge/{PA-ID}
# Nurgamärk koos tekstiga
GET https://polads.eu/badge/{PA-ID}?variant=labelled
# Alati nähtav sildiriba
GET https://polads.eu/badge/{PA-ID}?layout=labelMida iga parameeter teeb ja mida tähendab selle ärajätmine
layout=label valib riba. Kui selle ära jätate, kuvatakse nurgamärk. variant=labelled paneb suletud märgi näitama oma teksti. Kui selle ära jätate, kuvatakse ainult märk. w ja h määravad ala, kuhu märk paigutub, ja valivad, kuidas see kitsas ruumis lihtsustub. Kui need ära jätate, eeldab märk, et ruumi on piisavalt, mis on standardvormingute puhul õige.
hover=0 on näidise jaoks, mitte teie lehe jaoks
See sunnib peale hiirekursorita paigutuse, et näidis saaks lauaarvuti brauseris näidata puuteekraani versiooni. Päris märk kontrollib seadet ise. Kui selle väärtuse püsivalt määrate, saadate vale versiooni igale külastajale, kelle seade on teistsugune.
Suuruse muutmise kuulaja on kohustuslik
Nurgamärk laaditakse suuruses 32 korda 32, et katta reklaamimaterjalist võimalikult vähe, ja avanedes palub see seda sisaldavalt lehelt ruumi. Ilma kuulajata ei saa see üldse avaneda. Tähisriba lihtsustub sujuvamalt ja kärbitakse ainult kitsastel laiustel.
Saadaval ainult avaldatud teate puhul
Märki väljastatakse, kui teade on kinnitatud, avaldaja on selle heaks kiitnud ja avaldamise alguskuupäev on möödunud. Embargo all olev või heaks kiitmata PA-ID tagastab 404 teadlikult, mitte vea tõttu.
401 Volitamata
{
"error": "Invalid or revoked SSP API token."
}{
"error": "Missing or invalid Authorization header. Expected: Bearer <token>"
}400 Vigane päring
Kuulutus leiti, kuid selle meedium ei ole online. Vastus tagastab meediumi tegeliku väärtuse, näiteks print. Puuduv või tundmatu PA-ID tagastab selle asemel 404.
{
"error": "This endpoint is only for online advertisements",
"medium": "print"
}404 Ei leitud
{
"error": "Advertisement not found"
}429 Päringute limiit ületatud
{
"error": "Rate limit exceeded",
"limit": 10000,
"remaining": 0,
"reset": "2026-05-14T15:14:00.000Z"
}See on API versioon v1 ja iga vastus märgib seda päises X-API-Version. Ühilduvust rikkuvad muudatused avaldatakse uuel teel, mitte selle tee muutmise kaudu. Versiooni v1 lõpp-punkti ei lülitata välja enne, kui vähemalt 90 päeva varem on saadetud päis Deprecation vastavalt standardile RFC 8594.
Masinloetav spetsifikatsioon
Täielik OpenAPI 3.1 dokument on saadaval aadressil /api/docs. Suunake Postman, Swagger UI või kliendigeneraator otse sellele, selle asemel et seda lehte ümber kirjutada.
https://polads.eu/api/docs