Dokumentacja API SSP
API platformy po stronie podaży dla programatycznych platform reklamowych
https://polads.eu/api/v1GET /online-advertisement/{PAID}
10 000 żądań na minutę
Wymuszony limit szybkości na token SSP
/online-advertisement/{PAID}📊 Kompaktowy format etykiety
Ten punkt końcowy zwraca kompaktową, przezroczystą etykietę zgodną z wymogami UE, odpowiednią do wyświetlania obok reklam internetowych. Działa tylko w przypadku reklam z medium = „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"
}Wyświetl etykietę na swojej platformie:
<a href="[link]" target="_blank" rel="noopener">
[text]
</a>Format nagłówka
Authorization: Bearer YOUR_SSP_TOKENFormat tokena
64-znakowy ciąg szesnastkowy (entropia 256-bitowa)
Zarządzanie tokenami
Tokenami SSP zarządzają wyłącznie administratorzy systemu. Skontaktuj się z administratorem, aby uzyskać token.
Żaden plan nie ma zastosowania
Token SSP wydaje się integratorowi, a nie wydawcy, więc nie należy do żadnego konta wydawcy i nie ma planu do sprawdzenia. W odróżnieniu od API partnerskiego nic tutaj nie zależy od subskrypcji. Token partnera jest odrzucany na tym punkcie końcowym z kodem 401, a token SSP jest tak samo odrzucany na punktach końcowych partnera.
Kiedy punkt końcowy zwraca 404
Reklama jest rozwiązywana według tej samej reguły widoczności co rejestr publiczny. Reklama, która nie została jeszcze potwierdzona, której wydawca jeszcze nie zatwierdził, albo której data rozpoczęcia publikacji jest wciąż w przyszłości, zwraca 404. Kod 404 nie dowodzi więc, że PA-ID jest błędny.
Powyższy punkt końcowy zwraca jednowierszowy tekst oznaczenia, dla oznaczenia rysowanego przez twoją własną platformę. Znak zwraca gotowe, interaktywne powiadomienie, które umieszczasz obok reklamy w ramce. Oba opisują tę samą informację o przejrzystości.
Jeden adres URL na wersję
Elementy sterujące pokazu odpowiadają tym parametrom jeden do jednego, można więc wybrać na stronie pokazowej i skopiować widoczny adres.
# Oznaczenie narożne, sam znak
GET https://polads.eu/badge/{PA-ID}
# Oznaczenie narożne z napisem
GET https://polads.eu/badge/{PA-ID}?variant=labelled
# Stale widoczny pasek oznaczenia
GET https://polads.eu/badge/{PA-ID}?layout=labelCo robi każdy parametr i co oznacza jego pominięcie
layout=label wybiera pasek, bez niego pojawia się oznaczenie narożne. variant=labelled pokazuje napis na zamkniętym oznaczeniu, bez niego zostaje sam znak. w i h określają miejsce, w którym znajduje się oznaczenie, i decydują, jak dostosowuje się ono przy małej ilości miejsca. Po ich pominięciu oznaczenie zakłada, że ma miejsce, co jest właściwe dla standardowych formatów.
hover=0 służy pokazowi, nie Twojej stronie
Wymusza widok bez wskaźnika, aby pokaz mógł przedstawić wersję dotykową w przeglądarce komputerowej. Prawdziwe oznaczenie samo sprawdza urządzenie. Ustawiając je na stałe, wysyłasz niewłaściwą wersję każdemu odwiedzającemu, którego urządzenie mówi co innego.
Odbiorca komunikatu o rozmiarze jest wymagany
Znak w rogu ładuje się w rozmiarze 32 na 32, aby zakryć jak najmniej kreacji, a przy otwarciu prosi stronę o miejsce. Bez odbiorcy w ogóle się nie otworzy. Pasek oznaczenia jest bardziej wyrozumiały i przycina się tylko przy wąskich szerokościach.
Dostępne tylko dla opublikowanej informacji
Znak jest wydawany, gdy informacja jest potwierdzona, zatwierdzona przez wydawcę i minęła jej data rozpoczęcia. PA-ID objęte embargiem lub niezatwierdzone odpowiada 404 celowo, nie z powodu usterki.
401 Nieautoryzowane
{ "error": "Invalid or revoked SSP API token." }400 Nieprawidłowe żądanie
Reklama została znaleziona, ale jej medium nie jest online. Odpowiedź zwraca rzeczywistą wartość medium, na przykład print. Brakujący lub nieznany PA-ID zwraca zamiast tego 404.
404 Nie znaleziono
{ "error": "Advertisement not found" }429 Przekroczono limit szybkości
{
"error": "Rate limit exceeded",
"limit": 10000,
"remaining": 0,
"reset": "2025-01-15T10:30:00.000Z"
}To jest wersja API v1, a każda odpowiedź mówi o tym w nagłówku X-API-Version. Zmiany łamiące zgodność pojawiają się pod nową ścieżką, zamiast zmieniać tę. Punkt końcowy v1 nie zostanie wyłączony bez nagłówka Deprecation co najmniej 90 dni wcześniej, zgodnie z RFC 8594.
Specyfikacja odczytywalna maszynowo
Pełny dokument OpenAPI 3.1 jest udostępniany pod /api/docs. Skieruj Postmana, Swagger UI albo generator klienta prosto tam, zamiast przepisywać tę stronę.
https://polads.eu/api/docs