SSP API dokumentáció
Kínálati oldali platform API programozott hirdetési platformok számára
https://polads.eu/api/v1GET /online-advertisement/{PAID}
10 000 kérés percenként
Díjkorlát SSP-tokenenként érvényesítve
/online-advertisement/{PAID}📊 Kompakt címkeformátum
Ez a végpont kompakt, EU-kompatibilis átlátszósági címkét ad vissza, amely alkalmas az online hirdetések melletti megjelenítésre. Csak azoknál a hirdetéseknél működik, amelyek médium = "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"
}Jelenítse meg a címkét a platformon:
<a href="[link]" target="_blank" rel="noopener">
[text]
</a>Fejléc formátum
Authorization: Bearer YOUR_SSP_TOKENToken formátum
64 karakteres hexadecimális karakterlánc (256 bites entrópia)
Token-kezelés
SSP tokeneket csak a rendszergazdák kezelhetnek. Forduljon a rendszergazdához a token beszerzéséhez.
Semmilyen csomag nem alkalmazandó
Az SSP tokent integrátornak adjuk ki, nem kiadónak, így nem tartozik kiadói fiókhoz, és nincs ellenőrizendő csomag. A partner API-tól eltérően itt semmi nem függ előfizetéstől. Egy partnertokent ez a végpont 401 kóddal utasít el, egy SSP tokent pedig a partnervégpontok utasítanak el ugyanígy.
Mikor ad vissza a végpont 404-et
A hirdetést ugyanazzal a láthatósági szabállyal oldjuk fel, mint a nyilvános nyilvántartásban. Az a hirdetés, amelyet még nem erősítettek meg, amelyet a kiadó még nem hagyott jóvá, vagy amelynek közzétételi kezdődátuma még a jövőben van, 404-et ad. A 404 tehát nem bizonyítja, hogy a PA-ID hibás.
A fenti végpont az egysoros jelölésszöveget adja vissza, olyan jelöléshez, amelyet a saját platformja rajzol meg. A jelzés kész, interaktív tájékoztatót ad vissza, amelyet keretként helyez a hirdetés mellé. Mindkettő ugyanazt az átláthatósági tájékoztatót írja le.
Verziónként egy URL
A bemutató vezérlői egy az egyben megfelelnek ezeknek a paramétereknek, így a bemutatóoldalon választhat, és a látott címet másolhatja.
# Sarokjelvény, csak a jelzés
GET https://polads.eu/badge/{PA-ID}
# Sarokjelvény felirattal
GET https://polads.eu/badge/{PA-ID}?variant=labelled
# Mindig látható jelölősáv
GET https://polads.eu/badge/{PA-ID}?layout=labelMit csinál az egyes paraméterek, és mit jelent, ha kihagyja őket
A layout=label a sávot választja, nélküle a sarokjelvény jelenik meg. A variant=labelled a zárt jelvényen mutatja a feliratot, nélküle csak a jelzés marad. A w és a h megadja a helyet, ahol a jelvény ül, és eldönti, hogyan alkalmazkodik szűk helyen. Ha kihagyja őket, a jelvény abból indul ki, hogy van helye, ami a szokásos méreteknél helytálló.
A hover=0 a bemutatóhoz való, nem az Ön oldalára
Kikényszeríti a mutató nélküli nézetet, hogy a bemutató asztali böngészőben is megmutathassa az érintéses változatot. A valódi jelvény maga vizsgálja meg az eszközt. Ha rögzíti, minden olyan látogatónak a rossz változatot küldi, akinek az eszköze mást mond.
A méretfigyelő kötelező
A sarokjelzés 32-szer 32-es méretben töltődik be, hogy a lehető legkevesebbet takarja el a kreatívból, majd nyitáskor helyet kér az oldaltól. A figyelő nélkül egyáltalán nem nyílik ki. A jelölősáv elnézőbb, és csak keskeny szélességeknél vágódik le.
Csak közzétett tájékoztatóhoz érhető el
A jelzést akkor szolgáljuk ki, ha a tájékoztató megerősített, a kiadó jóváhagyta és túl van a kezdő dátumán. A zárolt vagy jóvá nem hagyott PA-ID szándékosan 404-et ad, nem hiba miatt.
Nyissa meg az interaktív bemutatót és másolja ki a beágyazási kódot
401 Jogosulatlan
{ "error": "Invalid or revoked SSP API token." }400 Hibás kérés
A hirdetés megvan, de a médiuma nem online. A válasz a tényleges médiumértéket adja vissza, például print. A hiányzó vagy ismeretlen PA-ID helyette 404-et ad.
404 Nem található
{ "error": "Advertisement not found" }429 Áramkorlát túllépve
{
"error": "Rate limit exceeded",
"limit": 10000,
"remaining": 0,
"reset": "2025-01-15T10:30:00.000Z"
}Ez az API v1 verziója, és minden válasz jelzi ezt egy X-API-Version fejlécben. A törésekkel járó változások új útvonalon jelennek meg, ahelyett hogy ezt módosítanák. Egy v1 végpontot nem kapcsolunk ki legalább 90 nappal korábbi Deprecation fejléc nélkül, az RFC 8594 szerint.
Géppel olvasható specifikáció
A teljes OpenAPI 3.1 dokumentum a /api/docs címen érhető el. Irányítsa a Postmant, a Swagger UI-t vagy egy klienskódgenerátort közvetlenül oda, ahelyett hogy ezt az oldalt másolná át.
https://polads.eu/api/docs