API başvurusu

Not

Bu sayfa API sözleşmesinden üretilir (OpenAPI belgesi). Postman, Insomnia ya da kod üreticilerine aktarabilirsiniz.

Hesap

GET /api/ext/v1/me

Anahtarın müşterisi, adı ve izinleri

İzin: yok (her anahtar)

Cevaplar: 200 ExtMe

Şubeler

GET /api/ext/v1/locations

Şubeler

İzin: screens:read

Parametreler

Ad	Yer	Tür	Zorunlu
page	sorgu	integer	—
pageSize	sorgu	integer	—

Cevaplar: 200 ExtPageOfExtLocation

Ekranlar

GET /api/ext/v1/screens

Ekranlar, cihazları ve canlı durumları; şubeye, etikete ve çevrimiçi olmaya göre süzülür

İzin: screens:read

Parametreler

Ad	Yer	Tür	Zorunlu
locationId	sorgu	uuid	—
tag	sorgu	string	—
online	sorgu	boolean	—
page	sorgu	integer	—
pageSize	sorgu	integer	—

Cevaplar: 200 ExtPageOfExtScreen

GET /api/ext/v1/screens/{id}

İzin: screens:read

Parametreler

Ad	Yer	Tür	Zorunlu
id	yol	uuid	evet

Cevaplar: 200 ExtScreen

PUT /api/ext/v1/screens/{id}

Ekran ayarlarının tamamını yazar (ad, şube, varsayılan playlist, yön, etiketler, yayın saatleri)

İzin: screens:write

Parametreler

Ad	Yer	Tür	Zorunlu
id	yol	uuid	evet

Gövde: ExtScreenSettings

Cevaplar: 200 ExtScreen · 400 Bad Request

POST /api/ext/v1/screens/{id}/commands

Uzaktan komut; sonuç komut kaydından okunur

İzin: screens:write

Parametreler

Ad	Yer	Tür	Zorunlu
id	yol	uuid	evet

Gövde: ExtCommandRequest

Cevaplar: 202 ExtCommand · 400 Bad Request

GET /api/ext/v1/screens/{id}/commands/{commandId}

İzin: screens:read

Parametreler

Ad	Yer	Tür	Zorunlu
id	yol	uuid	evet
commandId	yol	uuid	evet

Cevaplar: 200 ExtCommand

GET /api/ext/v1/screens/{id}/screenshot

Son uygulama görüntüsü (önce screenshot komutu gönderilir)

İzin: screens:read

Parametreler

Ad	Yer	Tür	Zorunlu
id	yol	uuid	evet

Cevaplar: 200 ExtScreenshot

Medya ve klasörler

GET /api/ext/v1/media

Medya kütüphanesi (yeniden eskiye); klasöre, türe ve duruma göre süzülür

İzin: content:read

Parametreler

Ad	Yer	Tür	Zorunlu
folderId	sorgu	uuid	—
type	sorgu	string	—
status	sorgu	string	—
page	sorgu	integer	—
pageSize	sorgu	integer	—

Cevaplar: 200 ExtPageOfExtMedia

GET /api/ext/v1/media/{id}

İzin: content:read

Parametreler

Ad	Yer	Tür	Zorunlu
id	yol	uuid	evet

Cevaplar: 200 ExtMedia

PUT /api/ext/v1/media/{id}

Ad ve klasör

İzin: content:write

Parametreler

Ad	Yer	Tür	Zorunlu
id	yol	uuid	evet

Gövde: ExtMediaUpdate

Cevaplar: 200 ExtMedia · 400 Bad Request

DELETE /api/ext/v1/media/{id}

Çöp kutusuna taşır (30 gün); playlistte kullanılan medya silinmez

İzin: content:write

Parametreler

Ad	Yer	Tür	Zorunlu
id	yol	uuid	evet

Cevaplar: 204 No Content

POST /api/ext/v1/media/uploads

Yükleme adresi (30 dk); dosya bu adrese PUT edilir, sonra complete çağrılır

İzin: content:write

Gövde: ExtUploadRequest

Cevaplar: 201 ExtUpload · 400 Bad Request

POST /api/ext/v1/media/{id}/complete

Yükleme bitti: dosya sunucuda doğrulanır ve işlenmeye alınır; durum ready olunca kullanılır

İzin: content:write

Parametreler

Ad	Yer	Tür	Zorunlu
id	yol	uuid	evet

Cevaplar: 202 ExtMedia

GET /api/ext/v1/folders

İzin: content:read

Parametreler

Ad	Yer	Tür	Zorunlu
page	sorgu	integer	—
pageSize	sorgu	integer	—

Cevaplar: 200 ExtPageOfExtFolder

POST /api/ext/v1/folders

İzin: content:write

Gövde: ExtFolderRequest

Cevaplar: 201 ExtFolder · 400 Bad Request

PUT /api/ext/v1/folders/{id}

İzin: content:write

Parametreler

Ad	Yer	Tür	Zorunlu
id	yol	uuid	evet

Gövde: ExtFolderRequest

Cevaplar: 200 ExtFolder · 400 Bad Request

DELETE /api/ext/v1/folders/{id}

Yalnız boş klasör silinir

İzin: content:write

Parametreler

Ad	Yer	Tür	Zorunlu
id	yol	uuid	evet

Cevaplar: 204 No Content

Playlistler

GET /api/ext/v1/playlists

İzin: content:read

Parametreler

Ad	Yer	Tür	Zorunlu
page	sorgu	integer	—
pageSize	sorgu	integer	—

Cevaplar: 200 ExtPageOfExtPlaylistSummary

POST /api/ext/v1/playlists

Playlist ve öğeleri tek istekte

İzin: content:write

Gövde: ExtPlaylistRequest

Cevaplar: 201 ExtPlaylist · 400 Bad Request

GET /api/ext/v1/playlists/{id}

İzin: content:read

Parametreler

Ad	Yer	Tür	Zorunlu
id	yol	uuid	evet

Cevaplar: 200 ExtPlaylist

PUT /api/ext/v1/playlists/{id}

Playlistin tamamını yazar; ekranlar hemen güncellenir

İzin: content:write

Parametreler

Ad	Yer	Tür	Zorunlu
id	yol	uuid	evet

Gövde: ExtPlaylistRequest

Cevaplar: 200 ExtPlaylist · 400 Bad Request

DELETE /api/ext/v1/playlists/{id}

Çöp kutusuna taşır; ekranlardan ve kurallardan çıkar

İzin: content:write

Parametreler

Ad	Yer	Tür	Zorunlu
id	yol	uuid	evet

Cevaplar: 204 No Content

Zamanlama

GET /api/ext/v1/schedule

Kurallar, öncelik sırasıyla

İzin: content:read

Cevaplar: 200 ExtScheduleRule[]

PUT /api/ext/v1/schedule

Bütün kuralları sırasıyla yazar (ilk kural en yüksek öncelik)

İzin: content:write

Gövde: ExtScheduleRequest

Cevaplar: 200 ExtScheduleRule[] · 400 Bad Request

POST /api/ext/v1/schedule/impact

Kaydetmeden dener: bu kural listesinin önümüzdeki 7 güne etkisi ve boş kalan yayın saatleri

İzin: content:read

Gövde: ExtScheduleRequest

Cevaplar: 200 ExtScheduleImpact · 400 Bad Request

Acil duyuru

GET /api/ext/v1/alerts

Etkin ve son gönderilen duyurular

İzin: content:read

Cevaplar: 200 ExtAlert[]

POST /api/ext/v1/alerts

Seçilen ekranlarda hemen tam ekran duyuru

İzin: content:write

Gövde: ExtAlertRequest

Cevaplar: 201 ExtAlert · 400 Bad Request

POST /api/ext/v1/alerts/{id}/end

İzin: content:write

Parametreler

Ad	Yer	Tür	Zorunlu
id	yol	uuid	evet

Cevaplar: 200 ExtAlert

Raporlar

GET /api/ext/v1/reports/plays

Oynatma raporu (from, to: yyyy-MM-dd; isteğe bağlı screenId)

İzin: reports:read

Parametreler

Ad	Yer	Tür	Zorunlu
from	sorgu	date	evet
to	sorgu	date	evet
screenId	sorgu	uuid	—

Cevaplar: 200 ExtPlayReport

GET /api/ext/v1/reports/plays.csv

İzin: reports:read

Parametreler

Ad	Yer	Tür	Zorunlu
from	sorgu	date	evet
to	sorgu	date	evet
screenId	sorgu	uuid	—
lang	sorgu	string	—

Cevaplar: 200 OK

GET /api/ext/v1/reports/uptime

Çalışma süresi raporu

İzin: reports:read

Parametreler

Ad	Yer	Tür	Zorunlu
from	sorgu	date	evet
to	sorgu	date	evet
screenId	sorgu	uuid	—

Cevaplar: 200 ExtUptimeReport

GET /api/ext/v1/reports/uptime.csv

İzin: reports:read

Parametreler

Ad	Yer	Tür	Zorunlu
from	sorgu	date	evet
to	sorgu	date	evet
screenId	sorgu	uuid	—
lang	sorgu	string	—

Cevaplar: 200 OK

Webhooklar

GET /api/ext/v1/webhooks

Webhook adresleri

İzin: webhooks:manage

Cevaplar: 200 WebhookResponse[]

POST /api/ext/v1/webhooks

Yeni adres (en çok 5); imza sırrı yalnız bu cevapta döner

İzin: webhooks:manage

Gövde: WebhookRequest

Cevaplar: 201 WebhookSecretResponse · 400 Bad Request

PUT /api/ext/v1/webhooks/{id}

Adres, olaylar ve açık/kapalı; durdurulan adres açılınca sayaç sıfırlanır

İzin: webhooks:manage

Parametreler

Ad	Yer	Tür	Zorunlu
id	yol	uuid	evet

Gövde: WebhookRequest

Cevaplar: 200 WebhookResponse · 400 Bad Request

DELETE /api/ext/v1/webhooks/{id}

İzin: webhooks:manage

Parametreler

Ad	Yer	Tür	Zorunlu
id	yol	uuid	evet

Cevaplar: 204 No Content

POST /api/ext/v1/webhooks/{id}/rotate-secret

Yeni imza sırrı; eskisi hemen geçersiz

İzin: webhooks:manage

Parametreler

Ad	Yer	Tür	Zorunlu
id	yol	uuid	evet

Cevaplar: 200 WebhookSecretResponse

POST /api/ext/v1/webhooks/{id}/test

webhook.test olayını kuyruğa alır

İzin: webhooks:manage

Parametreler

Ad	Yer	Tür	Zorunlu
id	yol	uuid	evet

Cevaplar: 202 WebhookDeliveryResponse

GET /api/ext/v1/webhooks/{id}/deliveries

Son 7 günün teslimleri

İzin: webhooks:manage

Parametreler

Ad	Yer	Tür	Zorunlu
id	yol	uuid	evet

Cevaplar: 200 WebhookDeliveryResponse[]

Şemalar

ExtAlert

Alan	Tür	Zorunlu
id	uuid	evet
title	string	evet
message	string	evet
tone	danger | info	evet
target	all | locations | tags | screens	evet
targetIds	uuid[]	evet
tags	string[]	evet
startsAt	date-time	evet
endsAt	date-time | null	evet
endedAt	date-time | null	evet
active	boolean	evet

ExtAlertRequest

Alan	Tür	Zorunlu
title	string	evet
message	string | null	evet
tone	danger | info	evet
target	all | locations | tags | screens	evet
targetIds	uuid[] | null	—
tags	string[] | null	—
endsAt	date-time | null	—

ExtApiKey

Alan	Tür	Zorunlu
id	uuid	evet
name	string	evet
scopes	string[]	evet
expiresAt	date-time | null	evet

ExtCommand

Alan	Tür	Zorunlu
id	uuid	evet
screenId	uuid	evet
type	string	evet
status	pending | delivered | succeeded | failed | unsupported | expired	evet
createdAt	date-time	evet
expiresAt	date-time	evet
finishedAt	date-time | null	evet
message	string | null	evet

ExtCommandRequest

Alan	Tür	Zorunlu
type	string	evet
volume	integer | null	—

ExtDevice

Alan	Tür	Zorunlu
platform	android | web | webos | tizen | windows	evet
manufacturer	string | null	evet
model	string | null	evet
osVersion	string | null	evet
playerVersion	string	evet
online	boolean	evet
lastSeenAt	date-time | null	evet
displayWidth	integer | null	evet
displayHeight	integer | null	evet
nowPlaying	any	evet
availableCommands	string[]	evet

ExtFolder

Alan	Tür	Zorunlu
id	uuid	evet
name	string	evet
mediaCount	integer	evet

ExtFolderRequest

Alan	Tür	Zorunlu
name	string	evet

ExtLocation

Alan	Tür	Zorunlu
id	uuid	evet
name	string	evet
address	string | null	evet
city	string | null	evet
timeZone	string | null	evet
createdAt	date-time	evet

ExtMe

Alan	Tür	Zorunlu
tenant	ExtRef	evet
key	ExtApiKey	evet

ExtMedia

Alan	Tür	Zorunlu
id	uuid	evet
name	string	evet
type	image | video	evet
status	uploading | processing | ready | failed	evet
folderId	uuid | null	evet
contentType	string	evet
sizeBytes	integer	evet
width	integer | null	evet
height	integer | null	evet
durationMs	integer | null	evet
url	string | null	evet
thumbnailUrl	string | null	evet
failureCode	string | null	evet
source	upload | ai	evet
createdAt	date-time	evet

ExtMediaUpdate

Alan	Tür	Zorunlu
name	string	evet
folderId	uuid | null	evet

ExtNowPlaying

Alan	Tür	Zorunlu
mediaId	uuid	evet
name	string	evet

ExtOpenHours

Alan	Tür	Zorunlu
days	integer[]	evet
open	string	evet
close	string	evet

ExtPageOfExtFolder

Alan	Tür	Zorunlu
items	ExtFolder[]	evet
page	integer	evet
pageSize	integer	evet
total	integer	evet

ExtPageOfExtLocation

Alan	Tür	Zorunlu
items	ExtLocation[]	evet
page	integer	evet
pageSize	integer	evet
total	integer	evet

ExtPageOfExtMedia

Alan	Tür	Zorunlu
items	ExtMedia[]	evet
page	integer	evet
pageSize	integer	evet
total	integer	evet

ExtPageOfExtPlaylistSummary

Alan	Tür	Zorunlu
items	ExtPlaylistSummary[]	evet
page	integer	evet
pageSize	integer	evet
total	integer	evet

ExtPageOfExtScreen

Alan	Tür	Zorunlu
items	ExtScreen[]	evet
page	integer	evet
pageSize	integer	evet
total	integer	evet

ExtPlayContent

Alan	Tür	Zorunlu
kind	media | template | widget	evet
contentId	string	evet
name	string | null	evet
plays	integer	evet
seconds	integer	evet
screens	integer	evet

ExtPlayReport

Alan	Tür	Zorunlu
from	date	evet
to	date	evet
plays	integer	evet
seconds	integer	evet
contents	ExtPlayContent[]	evet
screens	ExtPlayScreen[]	evet

ExtPlayScreen

Alan	Tür	Zorunlu
screenId	uuid	evet
name	string	evet
plays	integer	evet
seconds	integer	evet

ExtPlaylist

Alan	Tür	Zorunlu
id	uuid	evet
name	string	evet
shuffle	boolean	evet
items	ExtPlaylistItem[]	evet
updatedAt	date-time	evet

ExtPlaylistItem

Alan	Tür	Zorunlu
id	uuid	evet
kind	media | design | widget | plugin	evet
durationSeconds	integer	evet
validFrom	date | null	evet
validTo	date | null	evet
mediaId	uuid | null	evet
designId	uuid | null	evet
widget	any	evet
pluginCode	string | null	evet

ExtPlaylistItemRequest

Alan	Tür	Zorunlu
durationSeconds	integer	evet
mediaId	uuid | null	—
designId	uuid | null	—
widget	any	—
pluginCode	string | null	—
validFrom	date | null	—
validTo	date | null	—

ExtPlaylistRequest

Alan	Tür	Zorunlu
name	string	evet
shuffle	boolean	evet
items	ExtPlaylistItemRequest[]	evet

ExtPlaylistSummary

Alan	Tür	Zorunlu
id	uuid	evet
name	string	evet
shuffle	boolean	evet
itemCount	integer	evet
totalSeconds	integer	evet
updatedAt	date-time	evet

ExtRef

Alan	Tür	Zorunlu
id	uuid	evet
name	string	evet

ExtScheduleGap

Alan	Tür	Zorunlu
screenId	uuid	evet
screen	string	evet
day	integer	evet
at	string	evet
hours	number	evet
isNew	boolean	evet

ExtScheduleImpact

Alan	Tür	Zorunlu
affectedScreens	integer	evet
changedHours	number	evet
gaps	ExtScheduleGap[]	evet

ExtScheduleRequest

Alan	Tür	Zorunlu
rules	ExtScheduleRuleRequest[]	evet

ExtScheduleRule

Alan	Tür	Zorunlu
id	uuid	evet
name	string	evet
playlist	ExtRef	evet
days	integer[]	evet
start	string | null	evet
end	string | null	evet
validFrom	date | null	evet
validTo	date | null	evet
target	all | screens | tag	evet
screenIds	uuid[]	evet
tag	string | null	evet
priority	integer	evet

ExtScheduleRuleRequest

Alan	Tür	Zorunlu
name	string	evet
playlistId	uuid	evet
days	integer[]	evet
start	string | null	—
end	string | null	—
validFrom	date | null	—
validTo	date | null	—
target	all | screens | tag	—
screenIds	uuid[] | null	—
tag	string | null	—

ExtScreen

Alan	Tür	Zorunlu
id	uuid	evet
name	string	evet
location	any	evet
defaultPlaylist	any	evet
orientation	landscape | portrait	evet
rotation	integer	evet
fit	contain | cover | fill | auto	evet
muted	boolean	evet
kiosk	boolean	evet
tags	string[]	evet
openHours	ExtOpenHours[] | null	evet
device	any	evet
createdAt	date-time	evet

ExtScreenSettings

Alan	Tür	Zorunlu
name	string	evet
locationId	uuid | null	evet
defaultPlaylistId	uuid | null	evet
orientation	landscape | portrait	evet
rotation	integer	evet
fit	contain | cover | fill | auto	evet
muted	boolean	evet
kiosk	boolean	evet
tags	string[] | null	evet
openHours	ExtOpenHours[] | null	evet

ExtScreenshot

Alan	Tür	Zorunlu
url	string	evet
takenAt	date-time	evet

ExtUpload

Alan	Tür	Zorunlu
media	ExtMedia	evet
uploadUrl	string	evet
headers	{ [key]: string }	evet
expiresAt	date-time	evet

ExtUploadRequest

Alan	Tür	Zorunlu
fileName	string	evet
contentType	string	evet
sizeBytes	integer	evet
folderId	uuid | null	evet

ExtUptimeDay

Alan	Tür	Zorunlu
date	date	evet
onlineSeconds	integer	evet
openSeconds	integer	evet

ExtUptimeReport

Alan	Tür	Zorunlu
from	date	evet
to	date	evet
onlineSeconds	integer	evet
openSeconds	integer	evet
screens	ExtUptimeScreen[]	evet

ExtUptimeScreen

Alan	Tür	Zorunlu
screenId	uuid	evet
name	string	evet
onlineSeconds	integer	evet
openSeconds	integer	evet
days	ExtUptimeDay[]	evet

WebhookDeliveryResponse

Alan	Tür	Zorunlu
id	uuid	evet
event	string	evet
status	pending | succeeded | failed	evet
attempts	integer	evet
lastStatusCode	integer | null	evet
lastError	string | null	evet
createdAt	date-time	evet
deliveredAt	date-time | null	evet
nextAttemptAt	date-time | null	evet

WebhookRequest

Alan	Tür	Zorunlu
url	string	evet
description	string | null	evet
events	string[]	evet
enabled	boolean	—

WebhookResponse

Alan	Tür	Zorunlu
id	uuid	evet
url	string	evet
description	string | null	evet
events	string[]	evet
enabled	boolean	evet
disabledAt	date-time | null	evet
consecutiveFailures	integer	evet
createdAt	date-time	evet

WebhookSecretResponse

Alan	Tür	Zorunlu
webhook	WebhookResponse	evet
secret	string	evet

WidgetConfig

Alan	Tür	Zorunlu
kind	clock | weather | rates	evet
placeId	string | null	—