SSP Dokumentazzjoni API
API ta’ pjattaforma tan-naħa tal-provvista għal pjattaformi ta’ reklamar programmatiku
https://polads.eu/api/v1GET /online-advertisement/{PAID}
10,000 talba kull minuta
Limitu tar-rata infurzat għal kull token SSP
/online-advertisement/{PAID}📊 Format tat-Tikketta Kompatta
Dan l-endpoint jirritorna tikketta ta' trasparenza kompatta u konformi mal-UE adattata għall-wiri flimkien ma' reklami onlajn. Taħdem biss għal reklami b'medju = "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"
}Uri t-tikketta fuq il-pjattaforma tiegħek:
<a href="[link]" target="_blank" rel="noopener">
[text]
</a>Format tal-Header
Authorization: Bearer YOUR_SSP_TOKENFormat tat-Token
String eżadeċimali ta' 64 karattru (entropija ta' 256 bit)
Ġestjoni tat-Token
Tokens SSP huma ġestiti minn amministraturi tas-sistema biss. Ikkuntattja lill-amministratur tiegħek biex tikseb token.
L-ebda pjan ma japplika
Token SSP jinħareġ lil integratur u mhux lil pubblikatur, għalhekk ma jappartjeni għall-ebda kont ta’ pubblikatur u m’hemmx pjan x’jiġi vverifikat. B’differenza mill-API tas-sħab, hawn xejn ma jiddependi minn abbonament. Token ta’ sieħeb jiġi rrifjutat f’dan l-endpoint b’401, u token SSP jiġi rrifjutat bl-istess mod fl-endpoints tas-sħab.
Meta l-endpoint jirritorna 404
Ir-reklam jinstab bl-istess regola ta’ viżibilità tar-reġistru pubbliku. Reklam li għadu mhux ikkonfermat, li l-pubblikatur għadu ma approvax, jew li d-data tal-bidu tal-pubblikazzjoni tiegħu għadha fil-futur, jirritorna 404. Għalhekk kodiċi 404 mhuwiex prova li PA-ID huwa żbaljat.
L-endpoint ta’ hawn fuq jirritorna t-test tat-tikketta fuq linja waħda, għal tikketta li tpinġi l-pjattaforma tiegħek stess. Il-marka tirritorna avviż interattiv lest, li tqiegħed ħdejn ir-reklam f’qafas. It-tnejn jiddeskrivu l-istess avviż ta’ trasparenza.
URL wieħed għal kull verżjoni
Il-kontrolli tad-dimostrazzjoni jaqblu ma' dawn il-parametri wieħed b'wieħed, għalhekk tista' tagħżel fil-paġna tad-dimostrazzjoni u tikkopja l-URL li tara.
# Badge tal-kantuniera, il-marka biss
GET https://polads.eu/badge/{PA-ID}
# Badge tal-kantuniera bil-kliem tiegħu
GET https://polads.eu/badge/{PA-ID}?variant=labelled
# Faxxa ta' tikkettar dejjem viżibbli
GET https://polads.eu/badge/{PA-ID}?layout=labelX'jagħmel kull parametru, u xi jfisser li tħallih barra
layout=label jagħżel il-faxxa, mingħajru tidher il-badge tal-kantuniera. variant=labelled juri l-kliem fuq il-badge magħluqa, mingħajru tibqa' l-marka biss. w u h jiddikjaraw l-ispazju li fih toqgħod il-badge u jiddeċiedu kif tadatta meta l-ispazju jkun dejjaq. Jekk tħallihom barra, il-badge tassumi li għandha spazju, u dan huwa tajjeb għall-formati standard.
hover=0 huwa għad-dimostrazzjoni, mhux għall-paġna tiegħek
Jisforza l-wiri mingħajr hover biex id-dimostrazzjoni tkun tista' turi l-verżjoni tal-mess fi browser tal-kompjuter. Il-badge vera tittestja l-apparat waħedha. Jekk tissettjaha fissa, tibgħat il-verżjoni żbaljata lil kull viżitatur li l-apparat tiegħu jgħid mod ieħor.
Is-semmiegħ tad-daqs huwa meħtieġ
Il-marka tar-rokna titgħabba f’32 b’32 biex tgħatti l-inqas possibbli mir-reklam, u mbagħad titlob spazju lill-paġna meta tinfetaħ. Mingħajr is-semmiegħ ma tistax tinfetaħ xejn. L-istrixxa hija aktar toleranti u tinqata’ biss f’wisgħat dojoq.
Disponibbli biss għal avviż ippubblikat
Il-marka tiġi servuta meta l-avviż ikun ikkonfermat, approvat mill-pubblikatur u tkun għaddiet id-data tal-bidu tiegħu. PA-ID taħt embargo jew mhux approvat iwieġeb 404 apposta, mhux minħabba ħsara.
Iftaħ id-dimostrazzjoni interattiva u kkopja l-kodiċi tal-inkorporazzjoni
401 Mhux awtorizzat
{ "error": "Invalid or revoked SSP API token." }400 Talba invalida
Ir-reklam instab, iżda l-mezz tiegħu mhuwiex online. It-tweġiba tirritorna l-valur reali tal-mezz, pereżempju print. PA-ID nieqes jew mhux magħruf minflok jirritorna 404.
404 Mhux Instab
{ "error": "Advertisement not found" }429 Limitu tar-Rata Inqabeż
{
"error": "Rate limit exceeded",
"limit": 10000,
"remaining": 0,
"reset": "2025-01-15T10:30:00.000Z"
}Din hija l-verżjoni API v1, u kull tweġiba tgħid dan f’intestatura X-API-Version. Bidliet li jkissru l-kompatibilità joħorġu fuq mogħdija ġdida minflok ma jibdlu din. Endpoint v1 mhux se jintefa mingħajr intestatura Deprecation mill-inqas 90 jum qabel, skont RFC 8594.
Speċifikazzjoni li tinqara mill-magni
Id-dokument sħiħ OpenAPI 3.1 jinsab fuq /api/docs. Immira Postman, Swagger UI jew ġeneratur ta’ klijenti direttament hemm minflok ma tikkopja din il-paġna.
https://polads.eu/api/docs