SSP API-dokumentation
API för supply-side-plattformar till programmatiska annonsplattformar
https://polads.eu/api/v1GET /online-advertisement/{PAID}
10 000 förfrågningar per minut
Taxegräns tillämpas per SSP-token
/online-advertisement/{PAID}📊 Kompakt etikettformat
Denna slutpunkt returnerar en kompakt, EU-kompatibel transparensetikett som lämpar sig för visning tillsammans med onlineannonser. Fungerar endast för annonser med 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"
}Visa etiketten på din plattform:
<a href="[link]" target="_blank" rel="noopener">
[text]
</a>Header Format
Authorization: Bearer YOUR_SSP_TOKENTokenformat
64-teckens hexadecimal sträng (256-bitars entropi)
Tokenhantering
SSP-tokens hanteras endast av systemadministratörer. Kontakta din administratör för att få en token.
Inget abonnemang är tillämpligt
Ett SSP-token utfärdas till en integratör och inte till en utgivare, så det hör inte till något utgivarkonto och det finns inget abonnemang att kontrollera. Till skillnad från partner-API:et beror ingenting här på ett abonnemang. Ett partnertoken avvisas på den här slutpunkten med 401, och ett SSP-token avvisas på partnerslutpunkterna på samma sätt.
När slutpunkten svarar 404
Annonsen slås upp enligt samma synlighetsregel som det offentliga registret. En annons som ännu inte är bekräftad, som utgivaren ännu inte har godkänt, eller vars publiceringsdatum ligger i framtiden, ger 404. En 404 är därför inte bevis för att ett PA-ID är fel.
Slutpunkten ovan returnerar själva märkningstexten på en rad, för en märkning som din egen plattform ritar. Märket returnerar ett färdigt, interaktivt meddelande som du placerar bredvid annonsen i en iframe. Båda beskriver samma öppenhetsmeddelande.
En URL per version
Demonstrationens reglage motsvarar dessa parametrar ett till ett, så du kan välja på demonstrationssidan och kopiera adressen du ser.
# Hörnmärke, bara märket
GET https://polads.eu/badge/{PA-ID}
# Hörnmärke med text
GET https://polads.eu/badge/{PA-ID}?variant=labelled
# Alltid synlig märkningsrad
GET https://polads.eu/badge/{PA-ID}?layout=labelVad varje parameter gör och vad det betyder att utelämna den
layout=label väljer raden, utan den visas hörnmärket. variant=labelled visar texten på det stängda märket, utan den återstår bara märket. w och h anger utrymmet där märket sitter och avgör hur det anpassar sig när det är trångt. Utelämnar du dem utgår märket från att det finns plats, vilket stämmer för standardformaten.
hover=0 hör till demonstrationen, inte till din sida
Den tvingar fram vyn utan pekare så att demonstrationen kan visa pekversionen i en datorwebbläsare. Det riktiga märket undersöker enheten själv. Låser du den skickar du fel version till varje besökare vars enhet säger något annat.
Lyssnaren för storleksändring krävs
Hörnmärket laddas i 32 gånger 32 så att det täcker så lite av annonsen som möjligt, och ber sedan sidan om utrymme när det öppnas. Utan lyssnaren går det inte att öppna alls. Märkningsraden är mer tålig och beskärs bara vid smala bredder.
Endast för ett publicerat meddelande
Märket levereras när meddelandet är bekräftat, godkänt av utgivaren och förbi sitt startdatum. Ett spärrat eller icke godkänt PA-ID svarar 404 avsiktligt, inte på grund av ett fel.
401 Obehörig
{ "error": "Invalid or revoked SSP API token." }400 Felaktig begäran
Annonsen hittades, men dess medium är inte online. Svaret returnerar det faktiska mediumvärdet, till exempel print. Ett PA-ID som saknas eller är okänt ger i stället 404.
404 Hittade inte
{ "error": "Advertisement not found" }429 Hastighetsgränsen har överskridits
{
"error": "Rate limit exceeded",
"limit": 10000,
"remaining": 0,
"reset": "2025-01-15T10:30:00.000Z"
}Detta är API-version v1, och varje svar anger det i en X-API-Version-header. Brytande ändringar publiceras under en ny sökväg i stället för att ändra denna. En v1-slutpunkt stängs inte av utan en Deprecation-header minst 90 dagar i förväg, enligt RFC 8594.
Maskinläsbar specifikation
Hela OpenAPI 3.1-dokumentet finns på /api/docs. Rikta Postman, Swagger UI eller en klientgenerator direkt dit i stället för att skriva av den här sidan.
https://polads.eu/api/docs