SSP API dokumentacija
API platforme na strani ponude za programatske oglasne platforme
https://polads.eu/api/v1GET /online-advertisement/{PAID}
10 000 zahtjeva u minuti
Ograničenje stope nametnuto po SSP tokenu
/online-advertisement/{PAID}📊 Kompaktni format naljepnice
Ova krajnja točka vraća kompaktnu prozirnu oznaku usklađenu s EU-om prikladnu za prikaz uz online oglase. Radi samo za oglase s medijem = "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"
}Prikaži oznaku na svojoj platformi:
<a href="[link]" target="_blank" rel="noopener">
[text]
</a>Format zaglavlja
Authorization: Bearer YOUR_SSP_TOKENFormat tokena
64-znakovni heksadecimalni niz (256-bitna entropija)
Upravljanje tokenima
SSP tokenima upravljaju samo administratori sustava. Obratite se svom administratoru da biste dobili token.
Nijedan plan se ne primjenjuje
SSP token izdaje se integratoru, a ne izdavatelju, pa ne pripada nijednom izdavačkom računu i nema plana koji bi se provjeravao. Za razliku od partnerskog API-ja, ovdje ništa ne ovisi o pretplati. Partnerski token odbija se na ovoj krajnjoj točki s kodom 401, a SSP token jednako se odbija na partnerskim krajnjim točkama.
Kada krajnja točka vraća 404
Oglas se razrješava po istom pravilu vidljivosti kao javni registar. Oglas koji još nije potvrđen, koji izdavatelj još nije odobrio, ili čiji je datum početka objave još u budućnosti, vraća 404. Kod 404 stoga nije dokaz da je PA-ID pogrešan.
Gornja krajnja točka vraća jednoredni tekst oznake, za oznaku koju crta vaša vlastita platforma. Oznaka vraća gotovu, interaktivnu obavijest koju stavljate uz oglas u okvir. Oboje opisuje istu obavijest o transparentnosti.
Jedan URL po verziji
Kontrole demonstracije odgovaraju ovim parametrima jedan na jedan, pa možete odabrati na demo stranici i kopirati adresu koju vidite.
# Kutna oznaka, samo znak
GET https://polads.eu/badge/{PA-ID}
# Kutna oznaka s tekstom
GET https://polads.eu/badge/{PA-ID}?variant=labelled
# Trajno vidljiva traka s oznakom
GET https://polads.eu/badge/{PA-ID}?layout=labelŠto radi svaki parametar i što znači izostaviti ga
layout=label odabire traku, bez njega se prikazuje kutna oznaka. variant=labelled prikazuje tekst na zatvorenoj oznaci, bez njega ostaje samo znak. w i h određuju prostor u kojem oznaka stoji i odlučuju kako se prilagođava na malo mjesta. Ako ih izostavite, oznaka pretpostavlja da ima prostora, što odgovara standardnim formatima.
hover=0 je za demonstraciju, ne za vašu stranicu
Nameće prikaz bez pokazivača kako bi demonstracija mogla pokazati dodirnu verziju u stolnom pregledniku. Prava oznaka sama provjerava uređaj. Ako ga fiksirate, šaljete pogrešnu verziju svakom posjetitelju čiji uređaj tvrdi suprotno.
Slušatelj promjene veličine je obavezan
Kutna oznaka učitava se u veličini 32 puta 32 kako bi prekrila što manje oglasa, a pri otvaranju traži od stranice prostor. Bez slušatelja se uopće ne može otvoriti. Traka s oznakom je popustljivija i reže se samo pri uskim širinama.
Dostupno samo za objavljenu obavijest
Oznaka se poslužuje kada je obavijest potvrđena, odobrena od izdavača i kada je prošao datum početka. PA-ID pod embargom ili bez odobrenja odgovara 404 namjerno, a ne zbog greške.
401 Neovlašteno
{ "error": "Invalid or revoked SSP API token." }400 Neispravan zahtjev
Oglas je pronađen, ali njegov medij nije online. Odgovor vraća stvarnu vrijednost medija, primjerice print. PA-ID koji nedostaje ili je nepoznat umjesto toga vraća 404.
404 Nije pronađeno
{ "error": "Advertisement not found" }429 Ograničenje brzine premašeno
{
"error": "Rate limit exceeded",
"limit": 10000,
"remaining": 0,
"reset": "2025-01-15T10:30:00.000Z"
}Ovo je verzija API v1, a svaki odgovor to navodi u zaglavlju X-API-Version. Nekompatibilne promjene izlaze na novoj putanji umjesto da mijenjaju ovu. Krajnja točka v1 neće biti isključena bez zaglavlja Deprecation najmanje 90 dana unaprijed, u skladu s RFC 8594.
Strojno čitljiva specifikacija
Cjeloviti dokument OpenAPI 3.1 poslužuje se na /api/docs. Usmjerite Postman, Swagger UI ili generator klijenta izravno onamo umjesto da prepisujete ovu stranicu.
https://polads.eu/api/docs