SSP API dokumentacija
API platforme na strani ponudbe za programatične oglaševalske platforme
https://polads.eu/api/v1GET /online-advertisement/{PAID}
10.000 zahtev na minuto
Uveljavljena omejitev stopnje na žeton SSP
/online-advertisement/{PAID}📊 Kompakten format etikete
Ta končna točka vrne kompaktno prosojno oznako, skladno z EU, ki je primerna za prikaz poleg spletnih oglasov. Deluje samo za oglase z 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 oznako na svoji platformi:
<a href="[link]" target="_blank" rel="noopener">
[text]
</a>Oblika glave
Authorization: Bearer YOUR_SSP_TOKENOblika žetona
64-mestni šestnajstiški niz (256-bitna entropija)
Upravljanje žetonov
SSP žetone upravljajo samo sistemski skrbniki. Za pridobitev žetona se obrnite na skrbnika.
Noben paket se ne uporablja
Žeton SSP se izda integratorju in ne založniku, zato ne pripada nobenemu založniškemu računu in ni paketa, ki bi ga bilo treba preveriti. Za razliko od partnerskega API tu nič ni odvisno od naročnine. Partnerski žeton je na tej končni točki zavrnjen s kodo 401, žeton SSP pa je enako zavrnjen na partnerskih končnih točkah.
Kdaj končna točka vrne 404
Oglas se razreši po istem pravilu vidnosti kot javni register. Oglas, ki še ni potrjen, ki ga založnik še ni odobril, ali katerega datum začetka objave je še v prihodnosti, vrne 404. Koda 404 torej ni dokaz, da je PA-ID napačen.
Zgornja končna točka vrne enovrstično besedilo oznake za oznako, ki jo nariše vaša lastna platforma. Oznaka vrne pripravljeno, interaktivno obvestilo, ki ga postavite ob oglas v okvir. Oboje opisuje isto obvestilo o preglednosti.
En URL za vsako različico
Upravljalni elementi predstavitve ustrezajo tem parametrom ena proti ena, zato lahko izberete na predstavitveni strani in kopirate prikazani naslov.
# Kotna oznaka, samo znak
GET https://polads.eu/badge/{PA-ID}
# Kotna oznaka z besedilom
GET https://polads.eu/badge/{PA-ID}?variant=labelled
# Vedno vidni trak z oznako
GET https://polads.eu/badge/{PA-ID}?layout=labelKaj počne vsak parameter in kaj pomeni, če ga izpustite
layout=label izbere trak, brez njega se prikaže kotna oznaka. variant=labelled pokaže besedilo na zaprti oznaki, brez njega ostane samo znak. w in h določata prostor, v katerem stoji oznaka, in odločata, kako se prilagodi v tesnem prostoru. Če ju izpustite, oznaka predpostavi, da ima prostor, kar ustreza standardnim oblikam.
hover=0 je za predstavitev, ne za vašo stran
Vsili prikaz brez kazalca, da lahko predstavitev pokaže različico za dotik v namiznem brskalniku. Prava oznaka napravo preveri sama. Če jo določite trdno, pošljete napačno različico vsakemu obiskovalcu, čigar naprava trdi drugače.
Poslušalec spremembe velikosti je obvezen
Kotna oznaka se naloži v velikosti 32 krat 32, da prekrije čim manj oglasa, in ob odprtju stran zaprosi za prostor. Brez poslušalca se sploh ne more odpreti. Trak z oznako je bolj prizanesljiv in se obreže le pri ozkih širinah.
Na voljo le za objavljeno obvestilo
Oznaka se postreže, ko je obvestilo potrjeno, odobreno s strani izdajatelja in je minil datum začetka. PA-ID pod embargom ali brez odobritve odgovori 404 namenoma, ne zaradi napake.
401 Nepooblaščeno
{ "error": "Invalid or revoked SSP API token." }400 Neveljavna zahteva
Oglas je bil najden, vendar njegov medij ni online. Odziv vrne dejansko vrednost medija, na primer print. Manjkajoč ali neznan PA-ID namesto tega vrne 404.
404 Ni najdeno
{ "error": "Advertisement not found" }429 Omejitev hitrosti presežena
{
"error": "Rate limit exceeded",
"limit": 10000,
"remaining": 0,
"reset": "2025-01-15T10:30:00.000Z"
}To je različica API v1 in vsak odziv to navede v glavi X-API-Version. Nezdružljive spremembe izidejo na novi poti, namesto da bi spremenile to. Končna točka v1 ne bo izklopljena brez glave Deprecation vsaj 90 dni prej, skladno z RFC 8594.
Strojno berljiva specifikacija
Celoten dokument OpenAPI 3.1 je na voljo na /api/docs. Usmerite Postman, Swagger UI ali generator odjemalca naravnost tja, namesto da to stran prepisujete.
https://polads.eu/api/docs