SSP API документация
API на платформа от страната на предлагането за програматични рекламни платформи
https://polads.eu/api/v1GET /online-advertisement/{PAID}
10 000 заявки в минута
Ограничение на скоростта, наложено за SSP токен
/online-advertisement/{PAID}📊 Компактен формат на етикет
Тази крайна точка връща компактен, съвместим с ЕС прозрачен етикет, подходящ за показване заедно с онлайн реклами. Работи само за реклами със среда = "онлайн".
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"
}Покажете етикета на вашата платформа:
<a href="[link]" target="_blank" rel="noopener">
[text]
</a>Формат на заглавката
Authorization: Bearer YOUR_SSP_TOKENФормат на токена
64-знаков шестнадесетичен низ (256-битова ентропия)
Управление на токени
SSP токените се управляват само от системни администратори. Свържете се с вашия администратор, за да получите токен.
Никакъв план не се прилага
SSP токен се издава на интегратор, а не на издател, затова не принадлежи към никакъв издателски профил и няма план за проверка. За разлика от партньорския API тук нищо не зависи от абонамент. Партньорски токен се отхвърля на тази крайна точка с код 401, а SSP токен се отхвърля по същия начин на партньорските крайни точки.
Кога крайната точка връща 404
Обявата се намира по същото правило за видимост като публичния регистър. Обява, която още не е потвърдена, която издателят още не е одобрил, или чиято начална дата на публикуване е още в бъдещето, връща 404. Затова кодът 404 не доказва, че PA-ID е грешен.
Горната крайна точка връща едноредовия текст на обозначението, за обозначение, което изчертава вашата собствена платформа. Знакът връща готово интерактивно съобщение, което поставяте до рекламата в рамка. И двете описват едно и също съобщение за прозрачност.
По един URL адрес за всяка версия
Бутоните в демонстрацията съответстват едно към едно на тези параметри, така че можете да изберете в демонстрационната страница и да копирате показания адрес.
# Ъглова значка, само знакът
GET https://polads.eu/badge/{PA-ID}
# Ъглова значка с надпис
GET https://polads.eu/badge/{PA-ID}?variant=labelled
# Постоянно видима лента с обозначение
GET https://polads.eu/badge/{PA-ID}?layout=labelКакво прави всеки параметър и какво означава да го пропуснете
layout=label избира лентата, без него се показва ъгловата значка. variant=labelled показва надписа върху затворената значка, без него остава само знакът. w и h определят мястото, в което стои значката, и решават как тя се приспособява при малко място. Ако ги пропуснете, значката приема, че има място, което е правилно за стандартните формати.
hover=0 е за демонстрацията, не за вашата страница
Той налага изгледа без посочване, за да може демонстрацията да покаже версията за докосване в настолен браузър. Истинската значка сама проверява устройството. Ако го фиксирате, изпращате грешната версия на всеки посетител, чието устройство твърди друго.
Слушателят за размер е задължителен
Ъгловият знак се зарежда в размер 32 на 32, за да покрива възможно най-малко от рекламата, и при отваряне иска място от страницата. Без слушателя изобщо не може да се отвори. Лентата с обозначение е по-снизходителна и се отрязва само при тесни ширини.
Достъпно само за публикувано съобщение
Знакът се доставя, когато съобщението е потвърдено, одобрено от издателя и е след началната си дата. PA-ID под ембарго или без одобрение отговаря 404 нарочно, а не поради грешка.
Отворете интерактивната демонстрация и копирайте кода за вграждане
401 Неразрешено
{ "error": "Invalid or revoked SSP API token." }400 Невалидна заявка
Обявата е намерена, но носителят ѝ не е online. Отговорът връща действителната стойност на носителя, например print. Липсващ или непознат PA-ID връща 404.
404 Не е намерено
{ "error": "Advertisement not found" }429 Лимитът на скоростта е превишен
{
"error": "Rate limit exceeded",
"limit": 10000,
"remaining": 0,
"reset": "2025-01-15T10:30:00.000Z"
}Това е версия на API v1 и всеки отговор го посочва в заглавка X-API-Version. Несъвместимите промени излизат на нов път, вместо да променят този. Крайна точка v1 няма да бъде изключена без заглавка Deprecation поне 90 дни предварително, съгласно RFC 8594.
Машинно четима спецификация
Пълният документ OpenAPI 3.1 се обслужва на /api/docs. Насочете Postman, Swagger UI или генератор на клиенти право натам, вместо да преписвате тази страница.
https://polads.eu/api/docs