SSP-rajapinnan dokumentaatio
Tarjontapuolen alustan (SSP) rajapinta ohjelmallisen mainonnan alustoille
https://polads.eu/api/v1GET /online-advertisement/{PAID}
10 000 pyyntöä minuutissa
Rajoitus koskee kutakin SSP-tunnistetta erikseen
/online-advertisement/{PAID}📊 Tiivis merkintämuoto
Tämä päätepiste palauttaa tiiviin, EU:n vaatimusten mukaisen avoimuusmerkinnän, joka sopii näytettäväksi verkkomainosten yhteydessä. Toimii vain mainoksille, joiden medium-kentän arvo on "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"
}Näytä merkintä alustallasi:
<a href="[link]" target="_blank" rel="noopener">
[text]
</a>Otsakkeen muoto
Authorization: Bearer YOUR_SSP_TOKENTunnuksen muoto
64-merkkinen heksadesimaalimerkkijono (256-bittinen entropia)
Tunnusten hallinta
SSP-tunnuksia hallinnoivat vain järjestelmänvalvojat. Saat tunnuksen ottamalla yhteyttä järjestelmänvalvojaan.
Tilausta ei edellytetä
SSP-tunnus myönnetään integroijalle eikä julkaisijalle, joten siihen ei liity julkaisijatiliä eikä tarkistettavaa tilausta ole. Toisin kuin kumppanirajapinnassa, mikään tässä ei riipu tilauksesta. Kumppanitunnus hylätään tässä päätepisteessä koodilla 401, ja SSP-tunnus hylätään samalla tavalla kumppanipäätepisteissä.
Milloin päätepiste palauttaa koodin 404
Ilmoitus haetaan samalla näkyvyyssäännöllä kuin julkisessa rekisterissä. Jos ilmoitusta ei ole vielä vahvistettu, julkaisija ei ole vielä hyväksynyt sitä tai sen julkaisun alkamispäivä on vasta tulevaisuudessa, päätepiste palauttaa koodin 404. Koodi 404 ei siis todista, että PA-ID olisi väärä.
Yllä oleva päätepiste palauttaa yksirivisen merkinnän TEKSTIN merkintää varten, jonka oma alustasi piirtää. Merkki palauttaa valmiiksi piirretyn, vuorovaikutteisen ilmoituksen, jonka sijoitat mainoksen viereen iframe-kehyksenä. Molemmat kuvaavat samaa avoimuusilmoitusta.
Yksi URL-osoite versiota kohden
Esittelyn säätimet vastaavat näitä parametreja yksi yhteen, joten voit tehdä valinnan esittelysivulla ja kopioida näkyviin tulevan URL-osoitteen.
# Kulmamerkki, pelkkä symboli
GET https://polads.eu/badge/{PA-ID}
# Kulmamerkki, jossa näkyy teksti
GET https://polads.eu/badge/{PA-ID}?variant=labelled
# Jatkuvasti näkyvä merkintäpalkki
GET https://polads.eu/badge/{PA-ID}?layout=labelMitä kukin parametri tekee ja mitä sen pois jättäminen tarkoittaa
layout=label valitsee merkintäpalkin. Ilman sitä näytetään kulmamerkki. variant=labelled näyttää tekstin suljetussa merkissä. Ilman sitä näytetään pelkkä merkki. w ja h ilmoittavat tilan, jossa merkki sijaitsee, ja määrittävät, miten se pelkistyy ahtaassa tilassa. Jos jätät ne pois, merkki olettaa, että tilaa on riittävästi, mikä pitää paikkansa vakiomuodoissa.
hover=0 on tarkoitettu esittelyyn, ei sivullesi
Se pakottaa kosketuslaitteiden asettelun, jotta esittely voi näyttää kosketusversion työpöytäselaimessa. Oikea merkki tunnistaa laitteen itse. Jos kiinnität arvon koodiin, lähetät väärän version jokaiselle kävijälle, jonka laite ei vastaa sitä.
Koonmuutoksen kuuntelija on pakollinen
Kulmamerkki latautuu kokoon 32 × 32, jotta se peittää mainoksesta mahdollisimman vähän, ja pyytää isäntäsivulta lisää tilaa avautuessaan. Ilman kuuntelijaa se ei avaudu lainkaan. Merkintäpalkki pelkistyy lievemmin ja rajautuu vain kapeilla leveyksillä.
Saatavilla vain julkaistulle ilmoitukselle
Merkki toimitetaan, kun ilmoitus on vahvistettu, julkaisija on hyväksynyt sen ja sen julkaisun alkamispäivä on ohitettu. Julkaisuaikaa odottava tai hyväksymätön PA-ID palauttaa koodin 404 tarkoituksellisesti, ei virheen vuoksi.
401 Luvaton
{
"error": "Invalid or revoked SSP API token."
}{
"error": "Missing or invalid Authorization header. Expected: Bearer <token>"
}400 Virheellinen pyyntö
Ilmoitus löytyi, mutta sen media ei ole online. Vastaus palauttaa todellisen media-arvon, esimerkiksi print. Puuttuva tai tuntematon PA-ID palauttaa sen sijaan 404.
{
"error": "This endpoint is only for online advertisements",
"medium": "print"
}404 Ei löytynyt
{
"error": "Advertisement not found"
}429 Pyyntöraja ylitetty
{
"error": "Rate limit exceeded",
"limit": 10000,
"remaining": 0,
"reset": "2026-05-14T15:14:00.000Z"
}Tämä on rajapinnan versio v1, ja jokainen vastaus ilmoittaa sen X-API-Version-otsakkeessa. Yhteensopivuuden rikkovat muutokset julkaistaan uudessa polussa, eikä tätä polkua muuteta. v1-päätepistettä ei poisteta käytöstä ilman Deprecation-otsaketta vähintään 90 päivää etukäteen RFC 8594:n mukaisesti.
Koneluettava määrittely
Koko OpenAPI 3.1 -dokumentti on saatavilla osoitteessa /api/docs. Ohjaa Postman, Swagger UI tai asiakasgeneraattori suoraan siihen sen sijaan, että kopioisit tämän sivun tiedot käsin.
https://polads.eu/api/docs