SSP API-documentatie
Supply-side platform-API voor programmatische advertentieplatforms
https://polads.eu/api/v1GET /online-advertisement/{PAID}
10.000 verzoeken per minuut
Tarieflimiet afgedwongen per SSP-token
/online-advertisement/{PAID}📊 Compact labelformaat
Dit eindpunt retourneert een compact, EU-conform transparant label dat geschikt is om naast online advertenties te worden weergegeven. Werkt alleen voor advertenties met medium = "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"
}Toon het label op uw platform:
<a href="[link]" target="_blank" rel="noopener">
[text]
</a>Headerformaat
Authorization: Bearer YOUR_SSP_TOKENTokenformaat
hexadecimale tekenreeks van 64 tekens (256-bits entropie)
Tokenbeheer
SSP-tokens worden alleen beheerd door systeembeheerders. Neem contact op met uw beheerder om een token te verkrijgen.
Er geldt geen abonnement
Een SSP-token wordt afgegeven aan een integrator en niet aan een uitgever, dus het hoort bij geen uitgeversaccount en er is geen abonnement te controleren. Anders dan bij de partner-API hangt hier niets van een abonnement af. Een partnertoken wordt op dit endpoint geweigerd met 401, en een SSP-token wordt op de partner-endpoints net zo geweigerd.
Wanneer het endpoint 404 teruggeeft
De advertentie wordt opgezocht volgens dezelfde zichtbaarheidsregel als het openbare register. Een advertentie die nog niet is bevestigd, die de uitgever nog niet heeft goedgekeurd, of waarvan de publicatiedatum nog in de toekomst ligt, geeft 404. Een 404 bewijst dus niet dat een PA-ID onjuist is.
Het eindpunt hierboven geeft de labeltekst van één regel terug, voor een label dat uw eigen platform tekent. Het merk geeft een kant-en-klare, interactieve melding terug die u als iframe naast de advertentie plaatst. Beide beschrijven dezelfde transparantiemelding.
Eén URL per versie
De knoppen van de demo komen één op één overeen met deze parameters, dus u kunt op de demopagina kiezen en de URL kopiëren die u ziet.
# Hoekmarkering, alleen het merkteken
GET https://polads.eu/badge/{PA-ID}
# Hoekmarkering met tekst
GET https://polads.eu/badge/{PA-ID}?variant=labelled
# Altijd zichtbare aanduidingsbalk
GET https://polads.eu/badge/{PA-ID}?layout=labelWat elke parameter doet en wat weglaten betekent
layout=label kiest de balk, zonder deze verschijnt de hoekmarkering. variant=labelled toont de tekst op de gesloten markering, zonder deze blijft alleen het merkteken over. w en h geven de ruimte aan waarin de markering staat en bepalen hoe die zich aanpast bij weinig ruimte. Laat u ze weg, dan gaat de markering uit van voldoende ruimte, wat klopt voor de standaardformaten.
hover=0 hoort bij de demo, niet op uw pagina
Het forceert de weergave zonder aanwijzer, zodat de demo de aanraakversie in een desktopbrowser kan tonen. De echte markering onderzoekt het apparaat zelf. Zet u het vast, dan stuurt u de verkeerde versie naar elke bezoeker van wie het apparaat iets anders zegt.
De ontvanger van het groottebericht is vereist
Het hoekmerk laadt op 32 bij 32 zodat het zo min mogelijk van de advertentie bedekt, en vraagt de pagina om ruimte wanneer het opengaat. Zonder de ontvanger gaat het helemaal niet open. De labelstrook is inschikkelijker en wordt alleen bij smalle breedtes afgekapt.
Alleen voor een gepubliceerde melding
Het merk wordt geleverd zodra de melding is bevestigd, door de uitgever is goedgekeurd en haar startdatum voorbij is. Een geblokkeerde of niet-goedgekeurde PA-ID antwoordt met opzet 404, niet door een fout.
401 Ongeautoriseerd
{ "error": "Invalid or revoked SSP API token." }400 Ongeldig verzoek
De advertentie is gevonden, maar het medium is niet online. De reactie geeft de werkelijke mediumwaarde terug, bijvoorbeeld print. Een ontbrekend of onbekend PA-ID geeft in plaats daarvan 404.
404 Niet gevonden
{ "error": "Advertisement not found" }429 Tarieflimiet overschreden
{
"error": "Rate limit exceeded",
"limit": 10000,
"remaining": 0,
"reset": "2025-01-15T10:30:00.000Z"
}Dit is API-versie v1, en elke reactie vermeldt dat in een X-API-Version-header. Brekende wijzigingen verschijnen onder een nieuw pad in plaats van dit pad te wijzigen. Een v1-endpoint wordt niet uitgezet zonder minstens 90 dagen vooraf een Deprecation-header, conform RFC 8594.
Machineleesbare specificatie
Het volledige OpenAPI 3.1-document staat op /api/docs. Richt Postman, Swagger UI of een clientgenerator daar rechtstreeks op in plaats van deze pagina over te schrijven.
https://polads.eu/api/docs