API-dokumentation för SSP
API för säljsidesplattformar (SSP), avsett för plattformar för programmatisk annonsering
https://polads.eu/api/v1GET /online-advertisement/{PAID}
10 000 anrop per minut
Anropsbegränsningen tillämpas per SSP-token
PUT /online-advertisement/{PAID}/metrics
1 000 anrop per minut
Räknas per SSP-token, separat från märkningsslutpunkten, så att rapportering av mått aldrig förbrukar dina märkningsanrop
/online-advertisement/{PAID}📊 Kompakt märkningsformat
Den här slutpunkten returnerar en kompakt transparensmärkning som uppfyller EU:s krav och lämpar sig för visning bredvid onlineannonser. Fungerar endast för annonser med medium = "online".
Exempelbegäran
curl -X GET "https://polads.eu/api/v1/online-advertisement/ABC12" \
-H "Authorization: Bearer YOUR_SSP_TOKEN" \
-H "Accept: application/json"Svarsexempel
{
"text": "Politisk Reklame - ACME Corp - Folketingsvalg - polads.eu/ABC12",
"link": "https://polads.eu/ABC12",
"PAID": "ABC12"
}Svarsfält
Användningsexempel
Visa märkningen på din plattform:
<a href="[link]" target="_blank" rel="noopener">
[text]
</a>/online-advertisement/{PAID}/metricsDin SSP-token behöver behörigheten metrics:write. En administratör slår på den för den token du redan använder, så ingen ny token utfärdas.
Skicka de löpande totalsummorna sedan meddelandet publicerades, aldrig förändringen sedan din senaste leverans. Varje leverans ersätter de tidigare siffrorna, så om du skickar samma totalsummor igen ändras ingenting.
Du kan rapportera siffror för alla publicerade meddelanden, oavsett vilken utgivare de tillhör. Siffrorna visas i det offentliga transparensmeddelandet tillsammans med datumet då de senast rapporterades.
Exempelbegäran
curl -X PUT "https://polads.eu/api/v1/online-advertisement/ABC12/metrics" \
-H "Authorization: Bearer YOUR_SSP_TOKEN" \
-H "Content-Type: application/json" \
-d '{"viewsCount": 15000, "engagementsCount": 320}'Fält i begäran
Båda fälten är obligatoriska, och vart och ett är ett heltal från 0 till 2147483647.
Svarsexempel
{
"viewsCount": 15000,
"engagementsCount": 320,
"engagementMetricsUpdatedAt": "2026-10-12T08:30:00.000Z"
}Felsvar från den här slutpunkten
401 INVALID_TOKEN
Authorization-huvudet saknas, eller så är tokenet okänt, återkallat eller ett partnertoken. I båda fallen returneras koden INVALID_TOKEN.
{
"error": "Missing or invalid Authorization header. Expected: Bearer <token>",
"code": "INVALID_TOKEN"
}{
"error": "Invalid or revoked SSP API token.",
"code": "INVALID_TOKEN"
}403 INSUFFICIENT_SCOPE
Tokenet är giltigt men har inte tilldelats behörigheten metrics:write. Be din administratör att slå på den.
{
"error": "This token is not authorised to write metrics. Required scope: metrics:write.",
"code": "INSUFFICIENT_SCOPE"
}404 NOT_FOUND
Inget publicerat meddelande matchar detta PA-ID. Precis som för märkningsslutpunkten returneras även 404 för ett meddelande som utgivaren ännu inte har godkänt eller vars startdatum för publicering fortfarande ligger i framtiden.
{
"error": "Advertisement not found",
"code": "NOT_FOUND"
}409 METRICS_NOT_APPLICABLE
Meddelandet ligger utanför det tillämpningsområde som engagemangsmåtten är definierade för. Bilaga II not 15 omfattar meddelanden om onlineannonser eller inbyggda annonser som har använt inriktningsteknik eller annonsleveransteknik och som har börjat visas. Ingenting sparas.
{
"error": "Engagement metrics do not apply to this notice",
"code": "METRICS_NOT_APPLICABLE"
}400 INVALID_METRICS
Innehållet i begäran är inte giltig JSON, eller så saknas de två antalsvärdena, är negativa eller är inte heltal. Svaret anger vad som inte godkändes.
{
"error": "Invalid engagement metrics",
"code": "INVALID_METRICS",
"issues": [
{
"path": "viewsCount",
"message": "Too small: expected number to be >=0"
}
]
}{
"error": "Invalid request body",
"code": "INVALID_METRICS"
}429 RATE_LIMITED
Gränsen per token har överskridits. Svaret innehåller X-RateLimit-Limit, X-RateLimit-Remaining och X-RateLimit-Reset.
{
"error": "Rate limit exceeded",
"code": "RATE_LIMITED",
"limit": 1000,
"remaining": 0,
"reset": "2026-05-14T15:14:00.000Z"
}Format för HTTP-huvud
Authorization: Bearer YOUR_SSP_TOKENTokenformat
Hexadecimal sträng med 64 tecken (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
En SSP-token utfärdas till en integratör och inte till en utgivare, så den 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. En partnertoken avvisas på den här slutpunkten med 401, och en SSP-token avvisas på partnerslutpunkterna på samma sätt.
När slutpunkten svarar 404
Meddelandet slås upp enligt samma synlighetsregel som det offentliga registret. Ett meddelande som ännu inte är bekräftat, som utgivaren ännu inte har godkänt eller vars startdatum för publicering fortfarande ligger i framtiden ger 404. Ett 404-svar är därför inget 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 upp. Märket returnerar ett färdigt, interaktivt meddelande som du placerar bredvid annonsen i en iframe. Båda beskriver samma transparensmeddelande.
En URL per version
Reglagen i demonstrationen motsvarar dessa parametrar en till en, så du kan göra dina val på demonstrationssidan och kopiera adressen som visas.
# Hörnmärke, endast symbol
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 märkningsraden. Utelämnar du den visas hörnmärket. variant=labelled gör att det stängda märket visar sin text. Utelämnar du den visas bara symbolen. w och h anger den plats som märket sitter i och avgör hur det anpassar sig när utrymmet är begränsat. Utelämnar du dem utgår märket från att det finns plats, vilket stämmer för standardformaten.
hover=0 är avsett för demonstrationen, inte för din sida
Den tvingar fram layouten utan hovring så att demonstrationen kan visa pekskärmsversionen i en datorwebbläsare. Det riktiga märket känner själv av enheten. Hårdkodar du värdet skickar du fel version till varje besökare vars enhet inte stämmer överens med det.
Lyssnaren för storleksändring krävs
Hörnmärket laddas i storleken 32 gånger 32 så att det täcker så lite av annonsmaterialet som möjligt, och ber sedan värdsidan om utrymme när det öppnas. Utan lyssnaren går det inte att öppna alls. Märkningsraden anpassar sig mjukare och beskärs bara vid smala bredder.
Endast tillgängligt för ett publicerat meddelande
Märket levereras när meddelandet är bekräftat, godkänt av utgivaren och startdatumet för publicering har passerats. Ett PA-ID under embargo eller utan godkännande svarar med 404 avsiktligt, inte på grund av ett fel.
Öppna den interaktiva demonstrationen och kopiera inbäddningskoden
401 Obehörig
{
"error": "Invalid or revoked SSP API token."
}{
"error": "Missing or invalid Authorization header. Expected: Bearer <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.
{
"error": "This endpoint is only for online advertisements",
"medium": "print"
}404 Hittades inte
{
"error": "Advertisement not found"
}429 Anropsgränsen har överskridits
{
"error": "Rate limit exceeded",
"limit": 10000,
"remaining": 0,
"reset": "2026-05-14T15:14:00.000Z"
}Detta är API-version v1, och varje svar anger det i huvudet X-API-Version. Ändringar som inte är bakåtkompatibla publiceras under en ny sökväg i stället för att den här ändras. En v1-slutpunkt stängs inte av utan ett Deprecation-huvud 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