SSP API Documentation
API de platformă din partea ofertei pentru platforme de publicitate programatică
https://polads.eu/api/v1GET /online-advertisement/{PAID}
10.000 de solicitări pe minut
Limita de rată aplicată per indicativ SSP
/online-advertisement/{PAID}📊 Format compact de etichetă
Acest punct final returnează o etichetă de transparență compactă, conformă cu UE, potrivită pentru afișare alături de reclame online. Funcționează doar pentru reclame cu mediu = „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"
}Afișează eticheta pe platforma ta:
<a href="[link]" target="_blank" rel="noopener">
[text]
</a>Format antet
Authorization: Bearer YOUR_SSP_TOKENFormat Token
șir hexazecimal de 64 de caractere (entropie de 256 de biți)
Gestionarea jetoanelor
Tokenurile SSP sunt gestionate numai de administratorii de sistem. Contactați administratorul pentru a obține un token.
Niciun plan nu se aplică
Un token SSP este emis unui integrator, nu unui editor, deci nu aparține niciunui cont de editor și nu există niciun plan de verificat. Spre deosebire de API-ul pentru parteneri, aici nimic nu depinde de un abonament. Un token de partener este respins pe acest endpoint cu 401, iar un token SSP este respins la fel pe endpointurile pentru parteneri.
Când endpointul returnează 404
Anunțul este rezolvat după aceeași regulă de vizibilitate ca registrul public. Un anunț care nu este încă confirmat, pe care editorul nu l-a aprobat încă, sau a cărui dată de începere a publicării este încă în viitor returnează 404. Prin urmare, un 404 nu dovedește că un PA-ID este greșit.
Punctul final de mai sus returnează textul etichetei pe un rând, pentru o etichetă pe care o desenează propria dumneavoastră platformă. Însemnul returnează o notificare interactivă gata compusă, pe care o așezați lângă reclamă într-un cadru. Ambele descriu aceeași notificare de transparență.
Câte un URL pentru fiecare versiune
Comenzile demonstrației corespund unu la unu acestor parametri, așa că puteți alege în pagina de demonstrație și copia adresa pe care o vedeți.
# Insignă de colț, doar semnul
GET https://polads.eu/badge/{PA-ID}
# Insignă de colț cu textul ei
GET https://polads.eu/badge/{PA-ID}?variant=labelled
# Bandă de marcare vizibilă permanent
GET https://polads.eu/badge/{PA-ID}?layout=labelCe face fiecare parametru și ce înseamnă omiterea lui
layout=label selectează banda, fără el apare insigna de colț. variant=labelled arată textul pe insigna închisă, fără el rămâne doar semnul. w și h declară spațiul în care stă insigna și decid cum se adaptează când spațiul este strâmt. Dacă le omiteți, insigna presupune că are loc, ceea ce este corect pentru formatele standard.
hover=0 este pentru demonstrație, nu pentru pagina dumneavoastră
Forțează afișarea fără indicator, pentru ca demonstrația să poată arăta versiunea tactilă într-un browser de birou. Insigna reală verifică singură dispozitivul. Dacă o fixați, trimiteți versiunea greșită fiecărui vizitator al cărui dispozitiv spune altceva.
Ascultătorul de redimensionare este obligatoriu
Însemnul din colț se încarcă la 32 pe 32 pentru a acoperi cât mai puțin din reclamă, apoi cere spațiu paginii atunci când se deschide. Fără ascultător nu se poate deschide deloc. Banda este mai tolerantă și se taie doar pe lățimi înguste.
Disponibil doar pentru o notificare publicată
Însemnul este servit după ce notificarea este confirmată, aprobată de editor și a trecut data de început. Un PA-ID sub embargo sau neaprobat răspunde 404 intenționat, nu din cauza unei erori.
Deschideți demonstrația interactivă și copiați codul de încorporare
401 Neautorizat
{ "error": "Invalid or revoked SSP API token." }400 Cerere incorectă
Anunțul a fost găsit, dar mediul său nu este online. Răspunsul returnează valoarea reală a mediului, de exemplu print. Un PA-ID lipsă sau necunoscut returnează în schimb 404.
404 Nu a fost găsit
{ "error": "Advertisement not found" }429 Limită de rată depășită
{
"error": "Rate limit exceeded",
"limit": 10000,
"remaining": 0,
"reset": "2025-01-15T10:30:00.000Z"
}Aceasta este versiunea de API v1, iar fiecare răspuns o indică într-un antet X-API-Version. Modificările incompatibile apar pe o cale nouă în loc să o schimbe pe aceasta. Un endpoint v1 nu va fi oprit fără un antet Deprecation cu cel puțin 90 de zile înainte, conform RFC 8594.
Specificație care poate fi citită automat
Documentul OpenAPI 3.1 complet este servit la /api/docs. Îndreptați Postman, Swagger UI sau un generator de clienți direct într-acolo în loc să transcrieți această pagină.
https://polads.eu/api/docs