SSP API dokumentacija
Pasiūlos pusės platformos API programinės reklamos platformoms
https://polads.eu/api/v1GET /online-advertisement/{PAID}
10 000 užklausų per minutę
Užklausų dažnio riba taikoma kiekvienam SSP prieigos raktui atskirai
/online-advertisement/{PAID}📊 Kompaktiškas etiketės formatas
Šis galinis taškas grąžina kompaktišką, ES reikalavimus atitinkančią skaidrumo etiketę, tinkamą rodyti šalia internetinių reklamos skelbimų. Veikia tik su skelbimais, kurių medija = "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"
}Parodykite etiketę savo platformoje:
<a href="[link]" target="_blank" rel="noopener">
[text]
</a>Antraštės formatas
Authorization: Bearer YOUR_SSP_TOKENPrieigos rakto formatas
64 simbolių šešioliktainė eilutė (256 bitų entropija)
Prieigos raktų valdymas
SSP prieigos raktus valdo tik sistemos administratoriai. Norėdami gauti prieigos raktą, susisiekite su administratoriumi.
Netaikomas joks prenumeratos planas
SSP prieigos raktas išduodamas integratoriui, o ne leidėjui, todėl jis nesusietas su jokia leidėjo paskyra ir nėra plano, kurį reikėtų tikrinti. Kitaip nei partnerių API, čia niekas nepriklauso nuo prenumeratos. Partnerio prieigos raktas šiame galiniame taške atmetamas su kodu 401, o SSP prieigos raktas lygiai taip pat atmetamas partnerių galiniuose taškuose.
Kada galinis taškas grąžina 404
Pranešimas nustatomas pagal tą pačią matomumo taisyklę kaip ir viešajame registre. Jei pranešimas dar nepatvirtintas, jo leidėjas dar jo nepasirašė arba jo paskelbimo pradžios data dar nesuėjo, grąžinamas 404. Todėl 404 nėra įrodymas, kad PA-ID yra klaidingas.
Aukščiau nurodytas galinis taškas grąžina vienos eilutės etiketės TEKSTĄ, skirtą etiketei, kurią atvaizduoja jūsų pačių platforma. Ženklas grąžina paruoštą interaktyvų pranešimą, kurį įterptiniame rėmelyje patalpinate šalia skelbimo. Abu aprašo tą patį skaidrumo pranešimą.
Po vieną URL kiekvienai versijai
Demonstracijos valdikliai atitinka šiuos parametrus vienas prie vieno, tad galite pasirinkti demonstraciniame puslapyje ir nukopijuoti matomą adresą.
# Kampo ženklas, tik simbolis
GET https://polads.eu/badge/{PA-ID}
# Kampo ženklas su užrašu
GET https://polads.eu/badge/{PA-ID}?variant=labelled
# Nuolat matoma ženklinimo juosta
GET https://polads.eu/badge/{PA-ID}?layout=labelKą daro kiekvienas parametras ir ką reiškia jį praleisti
layout=label parenka juostą. Jo nenurodžius rodomas kampo ženklas. variant=labelled uždarame ženkle parodo jo užrašą. Jo nenurodžius rodomas tik ženklas. w ir h nurodo vietą, kurioje yra ženklas, ir lemia, kaip jis supaprastinamas ankštoje vietoje. Jų nenurodžius ženklas laiko, kad vietos pakanka, o tai tinka standartiniams formatams.
hover=0 skirtas demonstracijai, ne jūsų puslapiui
Jis priverstinai įjungia išdėstymą be užvedimo pele, kad demonstracija galėtų parodyti jutiklinę versiją kompiuterio naršyklėje. Tikrasis ženklas pats patikrina įrenginį. Įrašę šią reikšmę į kodą, kiekvienam lankytojui, kurio įrenginys yra kitoks, pateiksite netinkamą versiją.
Dydžio keitimo klausytojas yra privalomas
Kampo ženklas įkeliamas 32 × 32 dydžio, kad kuo mažiau uždengtų reklaminę medžiagą, o atsidarydamas paprašo talpinančiojo puslapio daugiau vietos. Be klausytojo jis apskritai negali atsidaryti. Ženklinimo juosta prisitaiko švelniau ir nukerpama tik esant mažam pločiui.
Pasiekiamas tik paskelbtiems pranešimams
Ženklas pateikiamas, kai pranešimas patvirtintas, leidėjo pasirašytas ir sulaukta jo paskelbimo pradžios datos. Embargu apribotas ar leidėjo nepasirašytas PA-ID atsako 404 tyčia, o ne dėl gedimo.
Atverkite interaktyvią demonstraciją ir nukopijuokite įterpimo kodą
401 Neteisėta
{
"error": "Invalid or revoked SSP API token."
}{
"error": "Missing or invalid Authorization header. Expected: Bearer <token>"
}400 Netinkama užklausa
Skelbimas rastas, bet jo medija nėra online. Atsakymas grąžina tikrąją medijos reikšmę, pavyzdžiui print. Trūkstamas ar nežinomas PA-ID vietoj to grąžina 404.
{
"error": "This endpoint is only for online advertisements",
"medium": "print"
}404 Nerasta
{
"error": "Advertisement not found"
}429 Viršyta užklausų riba
{
"error": "Rate limit exceeded",
"limit": 10000,
"remaining": 0,
"reset": "2026-05-14T15:14:00.000Z"
}Tai yra API versija v1, ir kiekvienas atsakymas tai nurodo antraštėje X-API-Version. Suderinamumą pažeidžiantys pakeitimai išleidžiami nauju keliu, o šis nekeičiamas. Versijos v1 galinis taškas nebus išjungtas, jei ne vėliau kaip prieš 90 dienų nebus pateikta antraštė Deprecation pagal RFC 8594.
Kompiuterio nuskaitoma specifikacija
Visas OpenAPI 3.1 dokumentas pateikiamas adresu /api/docs. Nukreipkite Postman, Swagger UI ar kliento generatorių tiesiai į jį, užuot perrašinėję šį puslapį.
https://polads.eu/api/docs