Nyilvános API
a rádió weboldalának adatforrása
A nyilvános API egy csak olvasható JSON-felület a Web modul adataihoz: állomások, műsorvezetők, műsorok, heti műsortükör és adáslista a visszahallgatható hangfájlokkal. A rádió weboldala ebből építi fel a műsor-, műsorvezető-, műsorrend- és archívumoldalait.
Ez az oldal a weboldal fejlesztőjének szól: minden végpontot, paramétert, mezőt és hibaválaszt leír, a végén pedig lépésről lépésre megmutatja, hogyan áll össze az adatokból egy műsorrend vagy egy archívumoldal.
Az adatok felépítése
| Adat | Mi ez | Mire hivatkozik |
|---|---|---|
| Állomás | egy rádióadó | — |
| Műsorvezető | egy személy a bemutatkozásával és a portréjával | állomás (vagy mindegyik) |
| Műsor | egy műsor a leírásával és a borítóképével | állomás (vagy mindegyik), műsorvezetők |
| Műsortükör-sáv | egy ismétlődő heti idősáv: „ez a műsor minden hétfőn 6-kor” | műsor, állomás, a sáv saját műsorvezetői |
| Adás | egy konkrét adás egy konkrét napon | műsor, a sáv, amelyből készült, állomás, az adás saját műsorvezetői, hangfájlok |
| Hangfájl | az adás visszahallgatható felvétele | adás |
A válaszok a kapcsolt adatot azonosítóval hivatkozzák: az adásban a műsor azonosítója áll, nem a teljes műsor. A weboldal a műsorokat és a műsorvezetőket egyszer olvassa be, és az azonosítók alapján kapcsolja össze őket (lásd lent).
Kapcsolódás
| Elem | Érték |
|---|---|
| Alapcím | http(s)://<szerver>:<port> — a címet, a portot és az API kulcsot a Broadmax Support adja meg |
| Metódus | csak GET |
| Hitelesítés | X-Api-Key: <kulcs> fejléc minden kérésben |
| Engedélyezett címek | csak az előre megadott IP-címekről vagy tartományokból érkező kérés jut át — a weboldal szerverének címét a kulccsal együtt kell egyeztetni |
| Kéréskorlát | IP-címenként percenként 120 kérés (alapértelmezés), lásd Kéréskorlát |
| Válasz | application/json; charset=utf-8 |
curl -H "X-Api-Key: <kulcs>" https://broadmin.example.com/public/status
Az API kulcs szerveroldali titok: az API-t a weboldal backendje hívja, a böngésző a weboldaltól kapja az adatot. Böngészőből közvetlenül nem hívható — a kulcs így bárki számára látható lenne, a látogató IP-címe nincs az engedélyezettek között, és az API a böngészőknek szóló CORS-fejléceket sem küldi.
Végpontok
| Végpont | Tartalom | Olvasási mód |
|---|---|---|
GET /public/status | elérhetőség, verzió, szerveridő | — |
GET /public/station | az aktív állomások | mindig a teljes lista |
GET /public/presenter | az aktív műsorvezetők | lapozva, since kurzorral |
GET /public/show | az aktív műsorok, műsorvezetőikkel | lapozva, since kurzorral |
GET /public/grid | a heti műsortükör sávjai | lapozva, since kurzorral |
GET /public/grid?date=… | egy nap műsorrendje kiszámolt időpontokkal | egy nap egyben |
GET /public/broadcast | a konkrét adások, hangfájljaikkal | since kurzorral vagy from/to dátumtartománnyal |
GET /public/broadcast/{broadcastId} | egyetlen adás | — |
Általános szabályok
| Szabály | Leírás |
|---|---|
| Azonosítók | minden azonosító GUID, kisbetűs, kötőjeles alakban (3f2a9c1e-6b0d-4d8e-9a51-2c7e4b8f0a13) |
| Üres mező | a null értékű mező kimarad a válaszból — a hiányzó mezőt üresnek kell tekinteni |
| Üres lista | a lista típusú mező mindig jelen van, üresen [] |
| Időpont | yyyy-MM-ddTHH:mm:ss, az állomás helyi idejében, időzóna-jelölés nélkül; a módosítási időpontok ezredmásodperceket is hordozhatnak (2026-10-18T09:12:44.517, a záró nullák nélkül) |
| Dátum | yyyy-MM-dd |
| Globális sor | ha a …Station mező hiányzik, a sor minden állomásra érvényes |
station paraméter | az adott állomás sorait és a globális sorokat adja vissza; nélküle minden állomás minden sora jön |
| Inaktív adat | inaktív műsorvezető és inaktív műsor nem jelenik meg, és az inaktív műsor sávjai és adásai sem; a műsorvezető-listákban is csak aktív műsorvezető szerepel |
| Képek, hangfájlok | a …Image és a filePath mező relatív útvonal (pl. presenter/kiss-peter-45fb91ac.jpg, audio/20261018/26101806_pld_reggeli-show-00.mp3); a fájlokat a BroAdmin a weboldal tárhelyére tölti fel, az útvonal ennek a gyökeréhez képest értendő |
| Slug | URL-barát azonosító, a weboldal címeihez használható |
| Ismeretlen paraméter | az API figyelmen kívül hagyja |
| Új mezők | a válaszok később új mezőkkel bővülhetnek; a weboldal a számára ismeretlen mezőt hagyja figyelmen kívül |
Lapozás és szinkronizálás
A presenter, a show, a grid és a since módú broadcast a sorokat módosítási sorrendben adja, lapokra bontva, közös borítékban:
{
"success": true,
"count": 250,
"limit": 250,
"more": true,
"next": "2026-10-18T09:12:44.517|3f2a9c1e-6b0d-4d8e-9a51-2c7e4b8f0a13",
"data": [ ... ]
}
| Paraméter / mező | Jelentés |
|---|---|
limit (paraméter) | lapméret: alapértelmezés 250, legfeljebb 1000; nulla vagy negatív értéknél 250, 1000 fölött 1000 érvényes |
since (paraméter) | kurzor: az előző lap next értéke; csak az utána módosult sorok jönnek. Sima időpont is megadható (pl. 2026-10-01 vagy 2026-10-01T12:00:00) |
count | a lapon lévő sorok száma |
limit | a ténylegesen alkalmazott lapméret |
more | true, ha a lap megtelt — a következő lapot is le kell kérni |
next | a következő kérés since értéke; üres lapnál hiányzik |
Hogyan működik a since?
A since egy könyvjelző: megmondja, meddig jutott el a weboldal az adatok követésében. Az API minden lap végén kiadja a következő könyvjelzőt (next), a weboldal ezt adja vissza a következő kérésben.
- A
nextkét részből áll,|jellel elválasztva: az utolsó kapott sor módosítási időpontja és az azonosítója. - A sorok mindig módosítási idő szerint növekvő sorrendben jönnek; azonos időpontnál az azonosító dönt.
- A következő lap azokat a sorokat adja, amelyek a könyvjelző után következnek ebben a sorrendben. Ezért a laphatáron sor nem ismétlődik és nem marad ki akkor sem, ha több sor ugyanabban az ezredmásodpercben módosult.
- Ha a
sincecsak időpont (azonosító nélkül), az annál később módosult sorok jönnek.
A next értékét URL-kódolva kell a címbe tenni (a : és a | miatt):
curl -H "X-Api-Key: <kulcs>" "https://broadmin.example.com/public/show?since=2026-10-18T09%3A12%3A44.517%7C3f2a9c1e-6b0d-4d8e-9a51-2c7e4b8f0a13"
A szinkronizálás menete
Entitásonként (műsorvezető, műsor, sáv, adás) külön könyvjelzőt kell vezetni.
- Első betöltés: kérés
sincenélkül, majd újra és újra a kapottnextértékkel, amígmoretrue. - Könyvjelző mentése: az utolsó kapott
nextértéket el kell tárolni. - Frissítés: később ugyanettől a könyvjelzőtől kell kérdezni — csak az azóta létrejött vagy módosult sorok érkeznek. A kapott sor a weboldalon a meglévőt felülírja (azonosító szerint), az új sor hozzáadódik.
- Üres lap: ha nincs változás, a
dataüres, anexthiányzik — a könyvjelző marad a régi. - Teljes újraolvasás: a törölt vagy inaktívvá tett sor a könyvjelzős olvasásban nem jelenik meg. Ezért időnként (pl. naponta)
sincenélkül végig kell olvasni a listát, és ami nincs benne, azt a weboldalon is törölni kell.
Egy teljes példa három kéréssel (lapméret 2, a könnyebb követhetőségért):
1. GET /public/show?limit=2 → count 2, more true, next "2026-09-02T23:08:45.470|22d7b35c-…" 2. GET /public/show?limit=2&since=2026-09-02T23:08:45.470|22d7b35c-… → count 1, more false, next "2026-09-14T10:02:11.093|a4e9898a-…" ← ezt kell eltárolni 3. (öt perccel később) GET /public/show?limit=2&since=2026-09-14T10:02:11.093|a4e9898a-… → count 0, more false, next hiányzik ← nincs változás, a könyvjelző marad
Mit vesz észre a szinkronizálás?
| Változás a BroAdminban | Hol jelenik meg |
|---|---|
| műsorvezető adatainak módosítása, új műsorvezető | presenter |
| műsor adatainak vagy műsorvezetőinek módosítása, új műsor | show |
| sáv adatainak vagy műsorvezetőinek módosítása, új sáv | grid |
| adás adatainak, műsorvezetőinek vagy állapotának módosítása, új adás | broadcast |
| elkészül vagy kicserélődik az adás hanganyaga | broadcast (az állapot ready-re vált, a broadcastFile lista megtelik) |
| törlés, inaktívvá tétel | sehol — csak a teljes újraolvasás mutatja ki |
| egy inaktív műsor újra aktív lesz | a műsor megjelenik a show listában; a sávjai és adásai a következő teljes újraolvasáskor |
A since paraméterbe mindig az API által adott next értéket érdemes tenni. Ha saját időpontból indulunk, azt a /public/status time mezőjéből vegyük, ne a weboldal szerverének órájából.
Javasolt ritmus: könyvjelzős frissítés 1–5 percenként, teljes újraolvasás naponta egyszer. A négy entitás egy-egy kérése percenként bőven a kéréskorláton belül marad.
Állapot
GET /public/status
Elérhetőség-ellenőrzés: megmutatja, hogy az API él, melyik verzió fut, és mennyi a szerver órája. Paramétere nincs.
{
"success": true,
"service": "BroAdmin public API",
"version": "2.0.65.0",
"time": "2026-10-18T14:05:12.3456789+02:00",
"endpoints": [
"/public/status",
"/public/station",
"/public/presenter",
"/public/show",
"/public/grid",
"/public/broadcast",
"/public/broadcast/{broadcastId}"
]
}
| Mező | Típus | Jelentés |
|---|---|---|
service | szöveg | a szolgáltatás neve |
version | szöveg | a BroAdmin verziója |
time | időpont | a szerver pontos ideje — az egyetlen mező, amely az időzóna-eltolást is tartalmazza |
endpoints | lista | az elérhető végpontok |
Állomások
GET /public/station
A teljes lista mindig egyben jön, lapozás és since nélkül, megjelenítési sorrendben. Csak az aktív állomások szerepelnek benne. Paramétere nincs.
{
"success": true,
"count": 1,
"data": [
{
"stationId": "1b5ab385-5703-4eac-b4fc-f0fad799bb12",
"stationSlug": "pelda-radio",
"stationName": "Példa Rádió",
"stationTLA": "PLD",
"stationSequence": 1
}
]
}
| Mező | Típus | Jelentés |
|---|---|---|
stationId | GUID | az állomás azonosítója — ezt kell a többi végpont station paraméterébe tenni |
stationSlug | szöveg | URL-barát azonosító |
stationName | szöveg | az állomás neve |
stationTLA | szöveg | hárombetűs rövidítés (az adás-slugokban kisbetűvel szerepel) |
stationSequence | egész | megjelenítési sorrend |
Műsorvezetők
GET /public/presenter[?station={guid}][&since={kurzor}][&limit=250]
| Paraméter | Kötelező | Formátum | Jelentés |
|---|---|---|---|
station | nem | GUID | az állomás műsorvezetői és a minden állomáshoz tartozók |
since | nem | kurzor vagy időpont | csak az utána módosult sorok |
limit | nem | 1–1000 | lapméret, alapértelmezés 250 |
{
"success": true,
"count": 1,
"limit": 250,
"more": false,
"next": "2026-09-02T23:09:19.563|c63464b2-fc24-4e94-89fa-05315f8d316a",
"data": [
{
"presenterId": "c63464b2-fc24-4e94-89fa-05315f8d316a",
"presenterSlug": "kiss-peter",
"presenterName": "Kiss Péter",
"presenterTitle": "műsorvezető",
"presenterDescription": "Tíz éve a reggeli műsor hangja.",
"presenterImage": "presenter/kiss-peter-45fb91ac.jpg",
"presenterModify": "2026-09-02T23:09:19.563"
}
]
}
| Mező | Típus | Mindig jön? | Jelentés |
|---|---|---|---|
presenterId | GUID | igen | azonosító |
presenterStation | GUID | nem | az állomás; hiányzik, ha minden állomáshoz tartozik |
presenterSlug | szöveg | igen | URL-barát azonosító (pl. kiss-peter) |
presenterName | szöveg | igen | név |
presenterTitle | szöveg | nem | titulus |
presenterDescription | szöveg | nem | bemutatkozás, sima szöveg, sortörésekkel |
presenterImage | szöveg | nem | négyzetes portré relatív útvonala |
presenterModify | időpont | igen | utolsó módosítás |
Műsorok
GET /public/show[?station={guid}][&since={kurzor}][&limit=250]
| Paraméter | Kötelező | Formátum | Jelentés |
|---|---|---|---|
station | nem | GUID | az állomás műsorai és a globális műsorok |
since | nem | kurzor vagy időpont | csak az utána módosult sorok |
limit | nem | 1–1000 | lapméret, alapértelmezés 250 |
{
"success": true,
"count": 1,
"limit": 250,
"more": false,
"next": "2026-09-02T23:08:45.470|22d7b35c-f4db-4525-9426-10ffa5b43ac1",
"data": [
{
"showId": "22d7b35c-f4db-4525-9426-10ffa5b43ac1",
"showSlug": "reggeli-show",
"showName": "Reggeli Show",
"showTitle": "ébresztő hírekkel és zenével",
"showDescription": "Hétköznap reggelente hat és kilenc között.",
"showImage": "show/reggeli-show-d679670a.jpg",
"showModify": "2026-09-02T23:08:45.47",
"showPresenter": [ "c63464b2-fc24-4e94-89fa-05315f8d316a" ]
}
]
}
| Mező | Típus | Mindig jön? | Jelentés |
|---|---|---|---|
showId | GUID | igen | azonosító |
showStation | GUID | nem | az állomás; hiányzik, ha a műsor globális |
showSlug | szöveg | igen | URL-barát azonosító (pl. reggeli-show) |
showName | szöveg | igen | a műsor neve |
showTitle | szöveg | nem | alcím |
showDescription | szöveg | nem | leírás, sima szöveg, sortörésekkel |
showImage | szöveg | nem | négyzetes borítókép relatív útvonala |
showModify | időpont | igen | utolsó módosítás |
showPresenter | GUID-lista | igen | a műsor aktív műsorvezetőinek azonosítói; lehet üres |
Műsortükör
A /public/grid végpontnak két olvasási módja van, és a kettő nem keverhető (date mellett since → 400):
| Mód | Mire való | Sorrend |
|---|---|---|
since (vagy paraméter nélkül) | a sávok tárolt szabályainak követése | módosítás szerint, kurzorral lapozva |
date | egy nap kiszámolt műsorrendje | kezdési idő szerint, egyben |
A sávok
GET /public/grid[?station={guid}][&since={kurzor}][&limit=250]
Egy sor egy ismétlődő sáv: a műsor a gridStart napjának hétköznapján, gridTime-kor szól, gridInterval hetente, gridStart-tól gridStop-ig.
| Paraméter | Kötelező | Formátum | Jelentés |
|---|---|---|---|
station | nem | GUID | az állomás sávjai és a globális sávok |
since | nem | kurzor vagy időpont | csak az utána módosult sorok |
limit | nem | 1–1000 | lapméret, alapértelmezés 250 |
{
"success": true,
"count": 1,
"limit": 250,
"more": false,
"next": "2026-07-26T22:31:52.430|0b9cd1f5-e2c6-48c8-88ba-f6e326fb4845",
"data": [
{
"gridId": "0b9cd1f5-e2c6-48c8-88ba-f6e326fb4845",
"gridStation": "1b5ab385-5703-4eac-b4fc-f0fad799bb12",
"gridShow": "22d7b35c-f4db-4525-9426-10ffa5b43ac1",
"gridTime": "06:00",
"gridStart": "2026-07-20",
"gridDuration": 180,
"gridInterval": 1,
"gridRebroadcast": false,
"gridModify": "2026-07-26T22:31:52.43",
"gridPresenter": []
}
]
}
| Mező | Típus | Mindig jön? | Jelentés |
|---|---|---|---|
gridId | GUID | igen | azonosító |
gridStation | GUID | nem | az állomás; hiányzik, ha a sáv globális |
gridShow | GUID | igen | a műsor azonosítója |
gridTime | szöveg | igen | kezdés, HH:mm |
gridStart | dátum | igen | az első adásnap; a hét napját is ez adja meg |
gridStop | dátum | nem | az utolsó adásnap (beleszámít); hiányzik, ha a sáv nyitott végű |
gridDuration | egész | igen | hossz percben |
gridInterval | egész | igen | ismétlődés hetekben (1 = minden héten, 2 = kéthetente) |
gridRebroadcast | logikai | igen | true, ha a sáv ismétlés |
gridModify | időpont | igen | utolsó módosítás |
gridPresenter | GUID-lista | igen | a sáv saját műsorvezetői; üres listánál a műsoré érvényes |
A fenti példa jelentése: 2026. július 20-tól (hétfő) minden hétfőn 6:00-tól 9:00-ig, határidő nélkül.
Egy nap műsorrendje
GET /public/grid?date=yyyy-MM-dd[&station={guid}]
A műsortükör egy adott napra kiszámolva: az aznap érvényes sávok, kezdési idő szerint rendezve, a kiszámolt kezdéssel és befejezéssel, lapozás nélkül. A weboldalnak így nem kell maga kiszámolnia az ismétlődést.
| Paraméter | Kötelező | Formátum | Jelentés |
|---|---|---|---|
date | igen (ebben a módban) | yyyy-MM-dd | a nap; múltbeli és jövőbeli nap is kérhető |
station | nem | GUID | az állomás sávjai és a globális sávok |
Ebben a módban a limit nem érvényes (a nap minden sávja egyben jön), a since pedig hibát ad.
{
"success": true,
"date": "2026-10-19",
"count": 2,
"data": [
{
"gridId": "0b9cd1f5-e2c6-48c8-88ba-f6e326fb4845",
"gridShow": "22d7b35c-f4db-4525-9426-10ffa5b43ac1",
"gridStation": "1b5ab385-5703-4eac-b4fc-f0fad799bb12",
"airingStart": "2026-10-19T06:00:00",
"airingStop": "2026-10-19T09:00:00",
"gridRebroadcast": false,
"gridPresenter": []
},
{
"gridId": "2e3806f6-0a82-4900-8d61-6c476b9bf6e6",
"gridShow": "b39ff923-68f6-4dd4-a0c1-341ff1f4a8be",
"airingStart": "2026-10-19T22:00:00",
"airingStop": "2026-10-20T01:00:00",
"gridRebroadcast": true,
"gridPresenter": [ "c63464b2-fc24-4e94-89fa-05315f8d316a" ]
}
]
}
| Mező | Típus | Mindig jön? | Jelentés |
|---|---|---|---|
date (a borítékban) | dátum | igen | a kért nap |
count (a borítékban) | egész | igen | a nap sávjainak száma |
gridId | GUID | igen | a sáv azonosítója |
gridShow | GUID | igen | a műsor azonosítója |
gridStation | GUID | nem | az állomás; hiányzik, ha a sáv globális |
airingStart | időpont | igen | a kiszámolt kezdés a kért napon |
airingStop | időpont | igen | a kiszámolt befejezés (kezdés + gridDuration perc) |
gridRebroadcast | logikai | igen | true, ha a sáv ismétlés |
gridPresenter | GUID-lista | igen | a sáv saját műsorvezetői; üres listánál a műsoré érvényes |
Egy sáv akkor szerepel a napon, ha mind teljesül:
- a nap a
gridStartés agridStopközé esik (mindkét nap beleszámít;gridStopnélkül nincs felső határ), - a nap a hét ugyanazon napja, mint a
gridStart, - a
gridStartóta eltelt hetek száma osztható agridIntervalértékével, - a sáv műsora aktív.
Az éjfélen átnyúló sáv airingStop értéke már a következő napra esik; a sáv ahhoz a naphoz tartozik, amelyiken kezdődik.
A műsortükör a tervet mutatja, az adáslista a tényleges adásokat. Egy egyedileg áthelyezett vagy kézzel felvett adás csak a /public/broadcast válaszában látszik; a műsorrend-oldal a kettőből áll össze (lásd lent).
Adások
GET /public/broadcast[?station={guid}][&since={kurzor}][&limit=250]
GET /public/broadcast?from=yyyy-MM-dd&to=yyyy-MM-dd[&station={guid}][&limit=250]
Egy sor egy konkrét adás egy konkrét napon. Az adásokat a BroAdmin a műsortükörből hozza létre, alapértelmezés szerint 7 napra előre; a távolabbi napokra a műsortükör napi nézete ad műsorrendet. Két olvasási mód van, és a kettő nem keverhető (since mellett from/to → 400):
| Mód | Mire való | Sorrend |
|---|---|---|
since (vagy paraméter nélkül) | a weboldal adatainak naprakészen tartása | módosítás szerint, kurzorral lapozva |
from/to | egy időszak adásai, pl. egy műsorrend- vagy archívumoldalhoz | kezdési idő szerint; nincs next |
| Paraméter | Kötelező | Formátum | Jelentés |
|---|---|---|---|
station | nem | GUID | az állomás adásai és a globális adások |
since | nem | kurzor vagy időpont | csak az utána módosult sorok |
from | nem | yyyy-MM-dd | a tartomány első napja (beleszámít), az adás kezdése alapján |
to | nem | yyyy-MM-dd | a tartomány utolsó napja (beleszámít) |
limit | nem | 1–1000 | lapméret, alapértelmezés 250 |
A dátumtartományos módról:
- Egyetlen nap adásaihoz a
fromés atougyanaz a dátum:?from=2026-10-19&to=2026-10-19. - A
fromvagy atoönmagában is megadható, ilyenkor a tartomány az egyik irányban nyitott. - Az éjfélen átnyúló adás ahhoz a naphoz tartozik, amelyiken kezdődik.
- A válasz itt is a lapozó borítékban jön, de
nextnélkül. Hamoretrue, a tartomány több sort tartalmaz, mint a lapméret: nagyobblimitvagy szűkebb tartomány kell.
{
"success": true,
"count": 1,
"limit": 250,
"more": false,
"data": [
{
"broadcastId": "aacdbef3-5376-495b-a6aa-7da385c8f57e",
"broadcastStation": "1b5ab385-5703-4eac-b4fc-f0fad799bb12",
"broadcastShow": "22d7b35c-f4db-4525-9426-10ffa5b43ac1",
"broadcastGrid": "0b9cd1f5-e2c6-48c8-88ba-f6e326fb4845",
"broadcastStart": "2026-10-19T06:00:00",
"broadcastStop": "2026-10-19T09:00:00",
"broadcastSlug": "26101906_pld_reggeli-show",
"broadcastRebroadcast": false,
"broadcastStatus": "ready",
"broadcastModify": "2026-10-19T09:18:28.26",
"broadcastPresenter": [],
"broadcastFile": [
{
"fileId": "8b860aa0-8c13-42fd-ae24-b22be880919a",
"fileSlug": "26101906_pld_reggeli-show-01",
"filePath": "audio/20261019/26101906_pld_reggeli-show-01.mp3",
"fileModify": "2026-10-19T09:15:54.507"
},
{
"fileId": "5e0f3c5f-81e3-4c86-8d83-3f1c5ce49074",
"fileSlug": "26101906_pld_reggeli-show-02",
"filePath": "audio/20261019/26101906_pld_reggeli-show-02.mp3",
"fileModify": "2026-10-19T09:16:45.827"
}
]
}
]
}
| Mező | Típus | Mindig jön? | Jelentés |
|---|---|---|---|
broadcastId | GUID | igen | azonosító |
broadcastStation | GUID | nem | az állomás; hiányzik, ha az adás globális |
broadcastShow | GUID | igen | a műsor azonosítója |
broadcastGrid | GUID | nem | a sáv, amelyből az adás készült; hiányzik, ha kézzel vették fel |
broadcastStart | időpont | igen | kezdés |
broadcastStop | időpont | igen | befejezés |
broadcastSlug | szöveg | igen | az adás URL-barát azonosítója, egyben a hangfájlok nevének eleje: <ééhhnnóó>_<állomáskód>_<műsor-slug> (pl. 26101906_pld_reggeli-show) |
broadcastTitle | szöveg | nem | egyedi alcím; hiányzik → a műsor showTitle értéke érvényes |
broadcastDescription | szöveg | nem | egyedi leírás; hiányzik → a műsor showDescription értéke érvényes |
broadcastImage | szöveg | nem | egyedi kép; hiányzik → a műsor showImage értéke érvényes |
broadcastRebroadcast | logikai | igen | true, ha az adás ismétlés |
broadcastStatus | szöveg | igen | a hanganyag állapota, lásd lent |
broadcastModify | időpont | igen | utolsó módosítás |
broadcastPresenter | GUID-lista | igen | az adás saját műsorvezetői; üres listánál a sávé (broadcastGrid), annak hiányában a műsoré érvényes |
broadcastFile | lista | igen | a meghallgatható hangfájlok, lejátszási sorrendben; lehet üres |
broadcastStatus | Jelentés | Teendő a weboldalon |
|---|---|---|
scheduled | az adás még nem ment le, vagy a hanganyag feldolgozásra vár | műsorrendben megjelenik, lejátszó nélkül |
ready | a hanganyag kész, a broadcastFile lista meghallgatható | lejátszó megjeleníthető |
skipped | ehhez az adáshoz nem készül hanganyag (kihagyásra jelölt adás vagy ismétlés) | műsorrendben megjelenik, archívumban nem |
error-… | a hanganyag nem készült el (error-marker, error-take, error-log, error-file, error-ftp) | lejátszó nélkül; a hiba javítása után az adás ready állapottal újra megjelenik a szinkronizálásban |
broadcastFile mező | Típus | Jelentés |
|---|---|---|
fileId | GUID | azonosító |
fileSlug | szöveg | a fájl neve kiterjesztés nélkül |
filePath | szöveg | a fájl relatív útvonala, pl. audio/20261019/26101906_pld_reggeli-show-01.mp3 |
fileModify | időpont | a fájl bejegyzésének ideje |
Egy adás hanganyaga alapesetben egyetlen fájl (<slug>-00.mp3); ha az adás több részre bomlik, a részek <slug>-01.mp3, <slug>-02.mp3 … néven, a listában lejátszási sorrendben jönnek. A fájlok 192 kbps-os mp3-ak, a reklámblokkok nélkül.
Egy adás
GET /public/broadcast/{broadcastId}
Egyetlen adás ugyanazokkal a mezőkkel, lapozó boríték nélkül.
{
"success": true,
"data": {
"broadcastId": "aacdbef3-5376-495b-a6aa-7da385c8f57e",
"broadcastShow": "22d7b35c-f4db-4525-9426-10ffa5b43ac1",
"broadcastStart": "2026-10-19T06:00:00",
"broadcastStop": "2026-10-19T09:00:00",
"broadcastSlug": "26101906_pld_reggeli-show",
"broadcastRebroadcast": false,
"broadcastStatus": "ready",
"broadcastModify": "2026-10-19T09:18:28.26",
"broadcastPresenter": [],
"broadcastFile": [ … ]
}
}
Ha az adás nem létezik, vagy a műsora inaktív, a válasz 404 (Broadcast not found.). Ha az azonosító nem GUID, a válasz 404 üres törzzsel.
Összerakás a weboldalon
Öröklés
Az adás és a sáv csak azt tárolja, amiben eltér a műsortól. A megjelenítendő értéket a weboldal rakja össze, ebben a sorrendben — az első nem üres érték érvényes:
| Megjelenítendő adat | 1. | 2. | 3. |
|---|---|---|---|
| adás alcíme | broadcastTitle | showTitle | — |
| adás leírása | broadcastDescription | showDescription | — |
| adás képe | broadcastImage | showImage | — |
| adás műsorvezetői | broadcastPresenter | a broadcastGrid sáv gridPresenter listája | showPresenter |
| sáv műsorvezetői | gridPresenter | showPresenter | — |
Az adás neve mindig a műsor neve (showName).
Képek és hangfájlok címe
A …Image és a filePath relatív útvonal. A BroAdmin a fájlokat a weboldal tárhelyének egy mappájába tölti fel; a teljes cím ennek a mappának a webes címe és az útvonal együtt:
https://www.pelda-radio.example/media/ + audio/20261019/26101906_pld_reggeli-show-01.mp3
Egy nap műsorrendje a weboldalon
- Az adott nap adásai:
/public/broadcast?from=<nap>&to=<nap>. - Az adott nap terve:
/public/grid?date=<nap>. - A műsorrend az adásokból áll; a terv egy sávja csak akkor kerül be, ha abban a percben nem kezdődik adás. Így a már létrehozott adások (az egyedi módosításaikkal) elsőbbséget kapnak, a távolabbi napokat pedig a terv tölti ki.
- A sorok a kezdésük szerint rendezve adják a napot.
Mi megy most?
A mai nap fenti módon összerakott műsorrendjéből az a sor, amelynek a kezdése már elmúlt, a befejezése még nem. Az időpontok az állomás helyi idejében értendők; a pontos szerveridőt a /public/status time mezője adja.
Archívum
Egy időszak ready állapotú adásai: /public/broadcast?from=<első nap>&to=<utolsó nap>, a válaszból a broadcastStatus = ready sorok. Folyamatosan követett archívumhoz a since mód való: amikor egy adás hanganyaga elkészül, az adás ready állapottal megjelenik a következő frissítésben.
Hibák
Hiba esetén a válasz törzse:
{ "success": false, "message": "Invalid or missing API key." }
| Kód | Mikor | message |
|---|---|---|
| 400 | hibás since | since must be a valid timestamp, optionally followed by |{guid}. vagy The id part of since must be a valid guid. |
| 400 | hibás date a /public/grid végponton | date must be a valid yyyy-MM-dd value. |
| 400 | date és since együtt | since cannot be combined with date. |
| 400 | hibás from vagy to | from must be a valid yyyy-MM-dd value. / to must be a valid yyyy-MM-dd value. |
| 400 | since és from/to együtt | since cannot be combined with from or to. |
| 400 | a station vagy a limit nem értelmezhető | The value '…' is not valid. |
| 401 | hiányzó vagy hibás API kulcs | Invalid or missing API key. |
| 403 | a kérés nem engedélyezett IP-címről jött | Access from this address is denied. |
| 404 | nem létező adás | Broadcast not found. |
| 404 | ismeretlen útvonal | üres törzs |
| 429 | a kéréskorlát túllépve | Rate limit exceeded. |
| 500 | szerverhiba | Internal server error. |
Az ellenőrzés sorrendje: IP-cím, kéréskorlát, API kulcs. Nem engedélyezett címről tehát helyes kulccsal is 403 jön.
Kéréskorlát
- IP-címenként percenként 120 kérés az alapértelmezés; az érték telepítésenként állítható.
- A számláló egyperces ablakokban dolgozik: az első kéréstől számított egy perc után nulláról indul.
- Az engedélyezett címről érkező minden kérés beleszámít, a hibás kulcsú is.
- Túllépésnél a válasz 429; a következő ablakban a kérések újra átmennek.
GYIK
Miért nem jelenik meg egy törölt műsor eltűnése a frissítésben?
A könyvjelzős olvasás csak a létező, aktív sorok változását adja. A törölt vagy inaktívvá tett sort a napi teljes újraolvasás mutatja ki: ami abban nincs benne, azt a weboldalon is törölni kell.
Mi a különbség a /public/grid?date=… és a /public/broadcast?from=…&to=… között?
Az első a műsortükörből számolt tervet adja bármelyik napra, hangfájl nélkül. A második a ténylegesen létrehozott adásokat az állapotukkal és a hangfájljaikkal, de csak addig, ameddig az adások előre létre vannak hozva.
Használhatok saját időpontot a since paraméterben?
Igen, sima időpont is megadható; ilyenkor az annál később módosult sorok jönnek. A folytatáshoz ezután is a válasz next értékét érdemes használni, mert az laphatáron sem veszít sort.
Miért hiányzik egy mező a válaszból?
Mert nincs értéke. A null értékű mező kimarad; a hiányzó …Station mező azt jelenti, hogy a sor minden állomásra érvényes.
Miért üres a broadcastPresenter?
Mert az adásnak nincs saját műsorvezető-beállítása. Ilyenkor a sáv, annak hiányában a műsor műsorvezetői érvényesek, lásd Öröklés.
Miért kapok 403-at helyes kulccsal?
Mert a kérés nem az előre egyeztetett IP-címről érkezett. A weboldal szerverének kimenő címét a Broadmax Supporttal kell egyeztetni.
Kapcsolódó
- Web — a modul áttekintése
- Műsorok — a műsorok törzsadatai
- Műsorvezetők — a műsorvezetők törzsadatai
- Műsortükör — a heti műsorrend szerkesztése
- Adáslista — a konkrét adások és a hanganyaguk
