SSP API dokumentácia
API platformy na strane ponuky pre programatické reklamné platformy
https://polads.eu/api/v1GET /online-advertisement/{PAID}
10 000 žiadostí za minútu
Limit rýchlosti uplatňovaný na token SSP
/online-advertisement/{PAID}📊 Kompaktný formát štítku
Tento koncový bod vracia kompaktný štítok transparentnosti v súlade s EÚ, ktorý je vhodný na zobrazenie spolu s online reklamami. Funguje len pre reklamy s médiom = "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"
}Zobrazte štítok na svojej platforme:
<a href="[link]" target="_blank" rel="noopener">
[text]
</a>Formát hlavičky
Authorization: Bearer YOUR_SSP_TOKENFormát tokenu
64-znakový hexadecimálny reťazec (256-bitová entropia)
Správa tokenov Tokeny
SSP spravujú iba správcovia systému. Ak chcete získať token, kontaktujte svojho správcu.
Žiadny plán sa neuplatní
SSP token sa vydáva integrátorovi, nie vydavateľovi, takže nepatrí k žiadnemu vydavateľskému účtu a nie je čo overovať. Na rozdiel od partnerského API tu nič nezávisí od predplatného. Partnerský token je na tomto koncovom bode odmietnutý s kódom 401 a SSP token je rovnako odmietnutý na partnerských koncových bodoch.
Kedy koncový bod vráti 404
Inzerát sa vyhľadáva podľa rovnakého pravidla viditeľnosti ako verejný register. Inzerát, ktorý ešte nie je potvrdený, ktorý vydavateľ ešte neschválil, alebo ktorého dátum začiatku zverejnenia ešte len nastane, vráti 404. Kód 404 teda nie je dôkazom, že je PA-ID nesprávne.
Koncový bod vyššie vracia jednoriadkový text označenia pre označenie, ktoré vykresľuje vaša vlastná platforma. Značka vracia hotové interaktívne oznámenie, ktoré umiestnite vedľa reklamy do rámu. Obidve opisujú to isté oznámenie o transparentnosti.
Jedna adresa URL na verziu
Ovládacie prvky ukážky zodpovedajú týmto parametrom jeden k jednému, takže si môžete vybrať na ukážkovej stránke a skopírovať zobrazenú adresu.
# Rohový odznak, iba značka
GET https://polads.eu/badge/{PA-ID}
# Rohový odznak s textom
GET https://polads.eu/badge/{PA-ID}?variant=labelled
# Trvalo viditeľný pás s označením
GET https://polads.eu/badge/{PA-ID}?layout=labelČo robí každý parameter a čo znamená jeho vynechanie
layout=label vyberie pás, bez neho sa zobrazí rohový odznak. variant=labelled zobrazí text na zatvorenom odznaku, bez neho ostane len značka. w a h určujú miesto, v ktorom odznak sedí, a rozhodujú, ako sa prispôsobí v tesnom priestore. Ak ich vynecháte, odznak predpokladá, že má miesto, čo zodpovedá štandardným formátom.
hover=0 patrí k ukážke, nie na vašu stránku
Vynúti zobrazenie bez ukazovateľa, aby ukážka mohla ukázať dotykovú verziu v počítačovom prehliadači. Skutočný odznak si zariadenie overí sám. Ak ho pevne nastavíte, pošlete nesprávnu verziu každému návštevníkovi, ktorého zariadenie tvrdí opak.
Poslucháč zmeny veľkosti je povinný
Rohová značka sa načíta vo veľkosti 32 krát 32, aby zakryla čo najmenej z kreatívy, a pri otvorení požiada stránku o miesto. Bez poslucháča sa nedá otvoriť vôbec. Pruh s označením je zhovievavejší a oreže sa len pri úzkych šírkach.
Dostupné len pre zverejnené oznámenie
Značka sa doručí, keď je oznámenie potvrdené, schválené vydavateľom a po dátume začiatku. PA-ID s embargom alebo bez schválenia odpovedá 404 zámerne, nie pre chybu.
401 Neoprávnené
{ "error": "Invalid or revoked SSP API token." }400 Chybná požiadavka
Inzerát sa našiel, ale jeho médium nie je online. Odpoveď vracia skutočnú hodnotu média, napríklad print. Chýbajúce alebo neznáme PA-ID vráti namiesto toho 404.
404 Nenájdené
{ "error": "Advertisement not found" }429 Prekročený limit sadzby
{
"error": "Rate limit exceeded",
"limit": 10000,
"remaining": 0,
"reset": "2025-01-15T10:30:00.000Z"
}Toto je verzia API v1 a každá odpoveď to uvádza v hlavičke X-API-Version. Nekompatibilné zmeny vychádzajú pod novou cestou, namiesto toho aby menili túto. Koncový bod v1 nebude vypnutý bez hlavičky Deprecation najmenej 90 dní vopred, v súlade s RFC 8594.
Strojovo čitateľná špecifikácia
Úplný dokument OpenAPI 3.1 je dostupný na /api/docs. Nasmerujte Postman, Swagger UI alebo generátor klienta rovno tam, namiesto toho aby ste túto stránku odpisovali.
https://polads.eu/api/docs