SSP API dokumentace
API platformy na straně nabídky pro programatické reklamní platformy
https://polads.eu/api/v1GET /online-advertisement/{PAID}
10 000 požadavků za minutu
Limit rychlosti vynucený na token SSP
/online-advertisement/{PAID}📊 Kompaktní formát štítku
Tento koncový bod vrací kompaktní transparentní štítek vyhovující EU, který je vhodný pro zobrazení vedle online reklam. Funguje pouze pro reklamy s médiem = "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ítek na vaší platformě:
<a href="[link]" target="_blank" rel="noopener">
[text]
</a>Formát záhlaví
Authorization: Bearer YOUR_SSP_TOKENFormát tokenu
64znakový hexadecimální řetězec (256bitová entropie)
Správa tokenů Tokeny
SSP spravují pouze správci systému. Chcete-li získat token, kontaktujte svého správce.
Žádný tarif se neuplatní
SSP token se vydává integrátorovi, nikoli vydavateli, takže nepatří k žádnému vydavatelskému účtu a není co ověřovat. Na rozdíl od partnerského API zde nic nezávisí na předplatném. Partnerský token je na tomto koncovém bodu odmítnut s kódem 401 a SSP token je stejně odmítnut na partnerských koncových bodech.
Kdy koncový bod vrátí 404
Inzerát se vyhledává podle stejného pravidla viditelnosti jako veřejný rejstřík. Inzerát, který dosud není potvrzený, který vydavatel dosud neschválil, nebo jehož datum zahájení zveřejnění teprve nastane, vrátí 404. Kód 404 tedy není důkazem, že je PA-ID chybné.
Koncový bod výše vrací jednořádkový text označení pro označení, které vykresluje vaše vlastní platforma. Značka vrací hotové interaktivní oznámení, které umístíte vedle reklamy do rámu. Obojí popisuje totéž oznámení o transparentnosti.
Jedna adresa URL pro každou verzi
Ovládací prvky ukázky odpovídají těmto parametrům jeden k jednomu, můžete tedy vybrat na ukázkové stránce a zkopírovat zobrazenou adresu.
# Rohový odznak, pouze značka
GET https://polads.eu/badge/{PA-ID}
# Rohový odznak s popisem
GET https://polads.eu/badge/{PA-ID}?variant=labelled
# Trvale viditelný pruh s označením
GET https://polads.eu/badge/{PA-ID}?layout=labelCo dělá každý parametr a co znamená jeho vynechání
layout=label vybere pruh, bez něj se zobrazí rohový odznak. variant=labelled zobrazí popis na zavřeném odznaku, bez něj zůstane jen značka. w a h určují místo, ve kterém odznak sedí, a rozhodují, jak se přizpůsobí v těsném prostoru. Pokud je vynecháte, odznak předpokládá, že má místo, což odpovídá standardním formátům.
hover=0 patří k ukázce, ne na vaši stránku
Vynutí zobrazení bez najetí myší, aby ukázka mohla ukázat dotykovou verzi v počítačovém prohlížeči. Skutečný odznak si zařízení ověří sám. Když jej pevně nastavíte, pošlete špatnou verzi každému návštěvníkovi, jehož zařízení tvrdí opak.
Posluchač změny velikosti je povinný
Rohová značka se načte ve velikosti 32 krát 32, aby zakryla co nejméně z kreativy, a při otevření požádá stránku o místo. Bez posluchače se nedá otevřít vůbec. Pruh s označením je shovívavější a ořízne se jen při úzkých šířkách.
Dostupné jen pro zveřejněné oznámení
Značka se doručí, jakmile je oznámení potvrzené, schválené vydavatelem a po datu zahájení. PA-ID s embargem nebo bez schválení odpovídá 404 záměrně, nikoli kvůli chybě.
401 Neoprávněné
{ "error": "Invalid or revoked SSP API token." }400 Chybný požadavek
Inzerát byl nalezen, ale jeho médium není online. Odpověď vrací skutečnou hodnotu média, například print. Chybějící nebo neznámé PA-ID vrací místo toho 404.
404 Nenalezeno
{ "error": "Advertisement not found" }429 Překročen limit sazby
{
"error": "Rate limit exceeded",
"limit": 10000,
"remaining": 0,
"reset": "2025-01-15T10:30:00.000Z"
}Toto je verze API v1 a každá odpověď to uvádí v hlavičce X-API-Version. Nekompatibilní změny vycházejí pod novou cestou, místo aby měnily tuto. Koncový bod v1 nebude vypnut bez hlavičky Deprecation nejméně 90 dní předem, v souladu s RFC 8594.
Strojově čitelná specifikace
Úplný dokument OpenAPI 3.1 je dostupný na /api/docs. Nasměrujte Postman, Swagger UI nebo generátor klienta rovnou tam, místo abyste tuto stránku opisovali.
https://polads.eu/api/docs