Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Content imported from a Scroll Translations translation file.

...

Sv translation
languagetr


MagicINFO Server, Open API’ye (v2.0) çağrı yaparak içerik yönetimi, zamanlama yönetimi, aygıt yönetimi ve diğer işlevleri gerçekleştirmenize olanak sağlar.

Open API’yi (v2.0) kullanmak için önce bir kimlik denetimi sürecini tamamlamanız gerekir. API’leri test ederken her bir API için farklı bir swagger sayfası kullanın.

Kimlik denetimi

Open API (v2.0) öğelerine çağrı yapılırken api_token değerinin başlık bölümüne eklenmesi gerekir. Eklenmezse “401 Unauthorized” hatası döndürülür.

Belirlenen zaman diliminden sonra, alınan belirtecin tarihi geçer ve kullanılamaz hale gelir. Bu durumda yeni bir belirteç almanız gerekir.

api_token değeri aşağıdaki API’ye yapılacak bir çağrı aracılığıyla edinilebilir.

Hizmet Adı

API çağrısı

Çağrı TürüAçıklama
authenticationRequest

/auth

POSTKullanıcı kimliği ve parolasını kullanarak kimlik denetimi için bir belirteç değeri içeri aktarır.
authenticationRequest

/auth/refresh

GETGeçerlilik süresini uzatmak için yeni bir belirteç oluşturur. Tekrar oturum açmadan REST API’ye çağrı yapılabilir

OPEN API (v2.0)

MagicINFO Server Open API (v2.0) çeşitli işlevler sunar. Her bir işleve yönelik yapılandırma aşağıda gösterilmiştir.

KategoriDenetleyiciAçıklama
İçerikcontent-controllerİçerik dosyası yönetimi
content-group-controllerİçerik grubu yönetimi
Oynatma listesiplaylist-controllerBir çalma listesinin yönetilmesi
playlist-group-controllerÇalma listesi grubu yönetimi
Zamanlamacontent-schedule-controllerİçerik zamanlaması yönetimi
content-schedule-group-controllerİçerik zamanlaması grubu yönetimi
message-schedule-controllerMesaj zamanlaması yönetimi
message-schedule-group-controllerMesaj zamanlaması grubu yönetimi
Aygıtdevice-controllerAygıt yönetimi
device-group-controllerAygıt grubu yönetimi
Kullanıcıuser-controllerKullanıcı yönetimi
user-group-controllerKullanıcı grubu yönetimi
Ayarenvironment-controllerAyar

İçerik

İçerik yükleyin, onaylayın ya da silin. İçerik listelerini yönetin. İçerikle ilgili hizmetlere içerik okuma, yazma ve yönetme izni olan doğrulanmış kullanıcıların erişimi vardır.

Kullanılabilen içerik yönetimi hizmetleri şunlardır:

Hizmet Adı

API çağrısı

Çağrı TürüAçıklama
listAllContent

/restapi/v1.0/cms/contents

GETKarşıya yüklenmiş dosyaların listesini içeri aktarır. Listede içerik küçük resimleri, isimler, dosya türleri ve diğer temel bilgiler bulunur. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
listDashboardContentInfo

/restapi/v1.0/cms/contents/dashboard

GETKontrol panelinde gösterilecek genel içerik bilgilerini içeri aktarır.
listContent

/restapi/v1.0/cms/contents/filter

POSTKoşula göre filtrelenmiş bir içerik listesini içeri aktarır. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
forceDeleteContent

/restapi/v1.0/cms/contents/force/{contentId}

DELETEİçeriğin bir çalma listesine ya da zamanlamaya dahil edilmiş olup olmaması fark etmeksizin içeriği siler.
deleteContent

/restapi/v1.0/cms/contents/{contentId}

DELETEİçeriğin bir çalma listesine ya da zamanlamaya dahil edilmemiş olduğunu onayladıktan sonra içeriği siler. Bir çalma listesine veya zamanlamaya dahil edilmiş bir içerik silinmeye çalışılıyorsa içerik silinmez ve bir hata kodu döndürülür.
getActiveContentInfo

/restapi/v1.0/cms/contents/{contentId}

GETİçeriğin aktifleştirilmiş bir sürümünün detaylarını içeri aktarır. İçerik her düzenlendiğinde sürümü güncellenir.
approveContents

/restapi/v1.0/cms/contents/{contentId}/approval

PUTİçeriği onaylar veya reddeder. Onaylanan içerik genel içerik listesine aktarılır ve çalma listelerinde veya zamanlamalarda kullanılabilir.
uploadContent

/restapi/v1.0/cms/contents/{groupId}

POSTYeni içeriği karşıya yükler.

listDefaultGroup

/restapi/v1.0/cms/contents/groups

GETVarsayılan içerik gruplarının listesini içeri aktarır.
getGroup

/restapi/v1.0/cms/contents/groups/{groupId}

GET{groupId} grubunun detaylarını içeri aktarır.
listChildGroup

/restapi/v1.0/cms/contents/groups/{groupId}/child

GET{groupId} grubunun altındaki alt grupların listesini içeri aktarır.


Oynatma listesi

İçeriği kullanarak çalma listeleri oluşturun, düzenleyin veya silin. Çalma listesiyle ilgili hizmetlere içerik okuma, yazma ve yönetme izni olan doğrulanmış kullanıcıların erişimi vardır.

Kullanılabilir çalma listesi yönetimi hizmetleri şunlardır:

Hizmet Adı

API çağrısı

Çağrı TürüAçıklama
listAllPlaylist

/restapi/v1.0/cms/playlists

GETTüm çalma listelerinin listesini içeri aktarır. Listede çalma listesi isimleri, ana içeriğin küçük resimleri, çalma listesi türleri ve diğer temel bilgiler bulunur. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
createPlaylist

/restapi/v1.0/cms/playlists

POSTYeni bir çalma listesi oluşturur.

getDashboardPlaylistInfo

/restapi/v1.0/cms/playlists/dashboard

GETKontrol panelinden gerekli çalma listesi bilgilerini içeri aktarır.

listPlaylist

/restapi/v1.0/cms/playlists/filter

POSTKoşula göre filtrelenmiş çalma listelerinin bir listesini içeri aktarır. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.

deletePlaylist

/restapi/v1.0/cms/playlists/{playlistId}

DELETESeçilen çalma listesini siler. Bir zamanlamaya dahil edilmiş bir çalma listesi silinmeye çalışılıyorsa çalma listesi silinmez ve bir hata kodu döndürülür.

getActivePlaylistInfo

/restapi/v1.0/cms/playlists/{playlistId}

GETÇalma listesinin aktifleştirilmiş bir sürümünün detaylarını içeri aktarır. Çalma listesi her düzenlendiğinde sürümü güncellenir.

editPlaylist

/restapi/v1.0/cms/playlists/{playlistId}

PUT{playlistId} çalma listesini düzenler. Bir çalma listesi düzenlenlendiğinde çalma listesi sürümü güncellenir ve çalma listesini oynatan aygıt, güncellenmiş çalma listesini otomatik olarak oynatır.

copyPlaylist

/restapi/v1.0/cms/playlists/{playlistId}/copy

PUT{playlistId} çalma listesini kopyalar. Çalma listesinin bir kopyası oluşturulur.
listDefaultGroup

/restapi/v1.0/cms/playlists/groups

GETVarsayılan çalma listesi gruplarının bir listesini içeri aktarır.

getGroup

/restapi/v1.0/cms/playlists/groups/{groupId}

GET{groupId} grubunun detaylarını içeri aktarır.
listChildGroup/restapi/v1.0/cms/playlists/groups/{groupId}/childGET

{groupId} grubunun altındaki alt grupların listesini içeri aktarır.

Zamanlama

Yeni içerik ya da mesaj zamanlamaları oluşturun. Zamanlamaları oynatma için aygıtlara yayınlayın. Zamanlamaları düzenleyin veya silin.

Zamanlama ile ilgili hizmetlere zamanlamaları okuma, yazma ve yönetme izni olan doğrulanmış kullanıcıların erişimi vardır.

Kullanılabilir zamanlama yönetimi hizmetleri şunlardır:

Hizmet Adı

API çağrısı

Çağrı TürüAçıklama
listContentScheduleAll

/restapi/v1.0/dms/schedule/contents

GETİçerik zamanlamalarının listesini içeri aktarır. Listede içerik zamanlamalarının isimleri, oluşturulma tarihleri, aygıt türleri ve diğer temel bilgiler bulunur. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
createContentSchedule

/restapi/v1.0/dms/schedule/contents

POSTYeni bir içerik zamanlaması oluşturur. İçerik zamanlamaları birden fazla kanal ve çerçeve içerebilir. Aygıtlara bir zamanlama yayınlayıp arzu edilen içerik ya da çalma listesini belirlenen zamanda oynatın.
listDashboardScheduleInfo

/restapi/v1.0/dms/schedule/contents/dashboard

GETKontrol panelinden gerekli içerik zamanlama bilgilerini içeri aktarır.
listContentScheduleByGroup

/restapi/v1.0/dms/schedule/contents/filter

POSTFarklı koşullara göre filtrelenmiş bir içerik zamanlaması listesini içeri aktarır. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
deleteContentSchedule

/restapi/v1.0/dms/schedule/contents/{programId}

DELETEİçerik zamanlamasını siler. Daha önce bir aygıta yayınlanmış bir zamanlama siliniyorsa aygıt otomatik olarak varsayılan içeriği oynatır.
getProgramInfo

/restapi/v1.0/dms/schedule/contents/{programId}

GETSeçilen grubun detaylarını içeri aktarır.
editContentSchedule

/restapi/v1.0/dms/schedule/contents/{programId}

PUTİçerik zamanlamasını düzenler. Daha önce bir aygıta yayınlanmış bir zamanlama düzenleniyorsa aygıt otomatik olarak düzenlenmiş içeriği oynatır.
copyContentSchedule

/restapi/v1.0/dms/schedule/contents/{programId}/copy

PUT{programId} içerik zamanlamasını kopyalar. {programId} içerik zamanlamasının bir kopyası oluşturulur.
deployContentSchedule

/restapi/v1.0/dms/schedule/contents/{programId}/deploy

PUTİçerik zamanlamasını belirli bir aygıt grubuna yayınlar.
getPublishStatus

/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus

GETGerçek zamanlı içerik zamanlaması indirme durumunu bir aygıttan içeri aktarır.
getRootGroups

/restapi/v1.0/dms/schedule/contents/groups

GETİçerik zamanlaması için kök grupların listesini içeri aktarır.
listContentScheduleGroupInfo/restapi/v1.0/dms/schedule/contents/groups/{groupId}GET{groupId} grubunun detaylarını içeri aktarır.
listAllMessageSchedule

/restapi/v1.0/dms/schedule/messages

GETTüm mesaj zamanlamalarının listesini içeri aktarır.
createMessageSchedule

/restapi/v1.0/dms/schedule/messages

POSTYeni bir mesaj programı oluşturur.
listMessage

/restapi/v1.0/dms/schedule/messages/filter

POST

Farklı koşullara göre filtrelenmiş bir mesaj zamanlaması listesini içeri aktarır. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
deleteMessageSchedule

/restapi/v1.0/dms/schedule/messages/{messageId}

DELETESeçilen mesaj zamanlamasını siler. Daha önce bir aygıta yayınlanmış bir mesaj zamanlaması siliniyorsa değişiklik otomatik olarak aygıta uygulanır.
getMessageInfo

/restapi/v1.0/dms/schedule/messages/{messageId}

GETSeçilen mesaj zamanlamasının detaylarını içeri aktarır.
editMessageSchedule

/restapi/v1.0/dms/schedule/messages/{messageId}

PUTSeçilen mesaj zamanlamasını düzenler. Daha önce bir aygıta yayınlanmış bir mesaj zamanlaması düzenleniyorsa değişiklik otomatik olarak aygıta uygulanır.
copyMessageSchedule

/restapi/v1.0/dms/schedule/messages/{messageId}/copy

PUTSeçilen mesaj zamanlamasını kopyalar. Mesaj zamanlamasının bir kopyası oluşturulur.
deployMessageSchedule

/restapi/v1.0/dms/schedule/messages/{messageId}/deploy

PUTSeçilen mesaj zamanlamasını bir aygıt grubuna yayınlar.
getRootGroups

/restapi/v1.0/dms/schedule/messages/groups

GETİçerik zamanlaması için kök grupların listesini içeri aktarır.
listMessageScheduleGroupInfo

/restapi/v1.0/dms/schedule/messages/groups/{groupId}

GET{groupId} grubunun detaylarını içeri aktarır.
getChildGroups

/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child

GETBelirli bir grubun altındaki alt grupların listesini içeri aktarır.

Aygıt

Aygıtları kontrol edin ve yönetin. Aygıtlarla ilgili hizmetlere aygıtları okuma, yazma ve yönetme izni olan doğrulanmış kullanıcıların erişimi vardır.

Mevcut aygıt yönetimi hizmetleri şunlardır:

Hizmet Adı

API çağrısı

Çağrı TürüAçıklama
listAllDevice

/restapi/v1.0/rms/devices

GETTüm aygıtların listesini içeri aktarır. Listede aygıt güç durumları, küçük resim bilgisi, aygıt hata durumları ve diğer temel bilgiler bulunur. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
getDashboardDeviceInfo

/restapi/v1.0/rms/devices/dashboard

GETKontrol panelinden gerekli aygıt bilgilerini içeri aktarır.
filterDeviceList

/restapi/v1.0/rms/devices/filter

POSTFarklı koşullara göre filtrelenmiş bir aygıt listesini içeri aktarır. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
deleteDevice

/restapi/v1.0/rms/devices/{deviceId}

DELETESeçilen aygıtı siler.
getDevice

/restapi/v1.0/rms/devices/{deviceId}

GETSeçilen aygıtın detaylarını içeri aktarır.
approveDevice

/restapi/v1.0/rms/devices/{deviceId}/approval

PUTSeçilen aygıtı belirli bir grup için onaylar.
getCabinetList

/restapi/v1.0/rms/devices/{deviceId}/cabinet

POSTLED aygıtına bağlanmış cabinet'ler hakkındaki bilgileri içeri aktarır. İçeri aktarılan bilgiler sadece cabinet'ler bir LED aygıtına bağlı olduğu zaman geçerlidir.
updateCabinetInfo

/restapi/v1.0/rms/devices/{deviceId}/cabinet

PUTLED aygıtına bağlanmış cabinet'ler hakkındaki bilgileri düzenler.
getDisplayControlInfo

/restapi/v1.0/rms/devices/{deviceId}/display

GETVeri tabanından aygıt ekran kontrol bilgilerini içeri aktarır. Kontrol bilgisi yoksa aygıta bir bilgi isteği gönderilmelidir.
updateDisplayInfo

/restapi/v1.0/rms/devices/{deviceId}/display

PUTDüzenlenmiş ekran kontrol bilgilerini bir aygıta gönderir. Aygıta sadece ekran bilgisindeki düzenlenmiş değerler protokol olarak gönderilir.
getUpdatedDisplayInfoResult

/restapi/v1.0/rms/devices/{deviceId}/display/{requestId}

GETAygıttan düzenlenmiş ekran kontrol bilgilerini alır. Bu API, updateDisplayInfo API’si yürütüldükten sonra yürütülebilir.
getGeneralInfo

/restapi/v1.0/rms/devices/{deviceId}/general

GETVeri tabanından genel aygıt bilgilerini içeri aktarır. Genel aygıt bilgisi, aygıt sunucuya bağlandığında güncellenir.
updateGeneralInfo

/restapi/v1.0/rms/devices/{deviceId}/general/info

PUTDüzenlenmiş aygıt bilgilerini bir aygıta gönderir. Aygıta sadece temel aygıt bilgisindeki düzenlenmiş değerler protokol olarak gönderilir.
getUpdatedGeneralInfoResult

/restapi/v1.0/rms/devices/{deviceId}/general/{requestId}

GETAygıttan düzenlenmiş aygıt bilgilerini alır. Bu API, updateGeneralInfo API’si yürütüldükten sonra yürütülebilir.
moveDevice

/restapi/v1.0/rms/devices/{deviceId}/move

PUTAygıtı farklı bir gruba taşır.
startRmServerVnc

/restapi/v1.0/rms/devices/{deviceId}/rmserver/start

GETAygıta bir RM başlatma protokolü gönderir. RM başlatma protokolü alan bir aygıt, Uzaktan Kumanda Sunucusu aracılığıyla düzenli aralıklarla bilgi gönderir.
stopRmServerVnc

/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop

GETRM durdurma protokolünü bir aygıta gönderir. RM durdurma protokolü alan bir aygıt ilgili işlevi anında durdurur.
getSetupInfo

/restapi/v1.0/rms/devices/{deviceId}/setup

GETAygıt ayarlarını içeri aktarır. Aygıt ayarları, aygıt sunucuya bağlandığında güncellenir.
updateSetupInfo

/restapi/v1.0/rms/devices/{deviceId}/setup

PUTDüzenlenmiş aygıt ayarlarını bir aygıta gönderir. Aygıta sadece ayarlardaki düzenlenmiş değerler protokol olarak gönderilir.
getUpdatedSetupInfoResult

/restapi/v1.0/rms/devices/{deviceId}/setup/{requestId}

GETAygıttan düzenlenmiş aygıt ayarlarını alır. Bu API, updateSetupInfo API’si yürütüldükten sonra yürütülebilir.
getCurrentStatusDisplay

/restapi/v1.0/rms/devices/{deviceId}/status/display

GETAygıta mevcut ekran kontrol bilgileri için bir istek gönderir. Bu API çağırılırsa requestId cevap değeri olarak döndürülür.
getCurrentStatusDisplay

/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}

GETAygıttan gönderilen ekran kontrol bilgisini içeri aktarır. Bu seçenek iki eylem için kullanılır: aygıta bilgi isteği göndermek ve asıl aygıt bilgisini almak.
getCurrentStatusTime

/restapi/v1.0/rms/devices/{deviceId}/status/time

GETAygıta mevcut zaman bilgisi için bir istek gönderir. Bu API çağırılırsa requestId cevap değeri olarak döndürülür.
getCurrentStatusTime

/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}

GETAygıttan gönderilen zaman bilgisini içeri aktarır. Bu seçenek iki eylem için kullanılır: aygıta bilgi isteği göndermek ve asıl aygıt bilgisini almak.
getTimeInfo

/restapi/v1.0/rms/devices/{deviceId}/time

GETVeritabanından aygıt zaman bilgilerini içeri aktarır. Kontrol bilgisi yoksa aygıta bir bilgi isteği gönderilmelidir.
updateTimeInfo

/restapi/v1.0/rms/devices/{deviceId}/time

PUTAygıta düzenlenmiş zaman bilgilerini gönderir. Aygıta sadece zaman bilgisindeki düzenlenmiş değerler protokol olarak gönderilir.
getUpdatedTimeInfoResult

/restapi/v1.0/rms/devices/{deviceId}/time/{requestId}

GET

Aygıttan düzenlenmiş aygıt zaman bilgilerini alır. Bu API, getUpdatedTimeInfoResult API’si yürütüldükten sonra yürütülebilir.

listDeviceGroupOrgan

/restapi/v1.0/rms/devices/groups

GETOrganizasyonların listesini içeri aktarır.
listDeviceGroupInfo

/restapi/v1.0/rms/devices/groups/{groupId}

GET{groupId} grubunun detaylarını içeri aktarır.
listDeviceGroupChild

/restapi/v1.0/rms/devices/groups/{groupId}/child

GET{groupId} grubunun altındaki alt gruplar hakkındaki bilgileri içeri aktarır.

Kullanıcı

Kullanıcı ekleyip kullanıcı bilgilerini yönetin. Kullanıcılarla ilgili hizmetlere kullanıcı bilgilerini okuma, yazma ve yönetme izni olan doğrulanmış kullanıcıların erişimi vardır.

Mevcut kullanıcı yönetimi hizmetleri şunlardır:

Hizmet Adı

API çağrısı

Çağrı TürüAçıklama
createUser/restapi/v1.0/ums/usersPOSTKullanıcı ekler.
listDashboardUserInfo

/restapi/v1.0/ums/users/dashboard

GETKontrol panelinden gerekli kullanıcı bilgilerini içeri aktarır.
updateMyInfo

/restapi/v1.0/ums/users/me

PUTKullanıcı bilgisini düzenler.
listUserOrgan

/restapi/v1.0/ums/users/organization

GETOrganizasyonların listesini içeri aktarır. Bu seçenek bir grup ağacını yapılandırmak için kullanılabilir.
listUserGroupOrgan

/restapi/v1.0/ums/users/groups

GETOrganizasyonların listesini içeri aktarır.
listUserGroupInfo

/restapi/v1.0/ums/users/groups/{groupId}

GET{groupId} grubunun detaylarını içeri aktarır.
listUserGroupChild

/restapi/v1.0/ums/users/groups/{groupId}/child

GET{groupId} grubunun altındaki alt grupların listesini içeri aktarır.

Ayar

Ana işlevlere ek olarak, birçok diğer işlevi kullanarak da etiket ve kategorileri oluşturup yönetebilir ve kontrol panelini düzenleyebilirsiniz.

Hizmet Adı

API çağrısı

Çağrı TürüAçıklama
getCategoryInfo

/restapi/v1.0/ems/category/{categoryId}

GETKategorilerin listesini içeri aktarır.
deleteDashboard

/restapi/v1.0/ems/dashboard

DELETEBelirli bir kontrol paneli bilgisini siler.
listDashboardInfo

/restapi/v1.0/ems/dashboard

GETÖzelleştirilmiş kontrol panelinde gösterilecek içeriği içeri aktarır. Kontrol panelinde sadece belirli bilgiler gösterilebilir.
updateDashboardPriority

/restapi/v1.0/ems/dashboard

PUTKontrol panelinde gösterilen öğelerin sıralamasını değiştirir.
createDashboard

/restapi/v1.0/ems/dashboard/create

GETBoştaki bir kontrol panelini aktifleştirir.

listDashboardLoginInfo

/restapi/v1.0/ems/dashboard/login

GETKontrol panelinde gösterilecek giriş bilgilerini içeri aktarır.
listDashboardNoticeInfo

/restapi/v1.0/ems/dashboard/notice

GETKontrol panelinde gösterilecek ilan panosu bilgilerini içeri aktarır.
deleteNoticeInfo

/restapi/v1.0/ems/dashboard/notice/edit

DELETEİlan panosundan bir gönderiyi siler.
listEditNoticeInfo

/restapi/v1.0/ems/dashboard/notice/edit

GETSeçilen gönderinin detaylarını içeri aktarır.
createNoticeInfo

/restapi/v1.0/ems/dashboard/notice/edit

POSTİlan panosuna gönderiler ekler.
updateNoticeInfo

/restapi/v1.0/ems/dashboard/notice/edit

PUTİlan panosunda seçili gönderiyi düzenler.
listDashboardStorageInfo

/restapi/v1.0/ems/dashboard/storage

GETKontrol panelinde gösterilecek depolama bilgilerini içeri aktarır.

listLicense

/restapi/v1.0/ems/license

GETSunucudaki kayıtlı lisansların listesini içeri aktarır.
getServerSetupInfo

/restapi/v1.0/ems/setup

GETSunucu ayarlarını içeri aktarır. Sunucu ayarı öğeleri, sunucudaki farklı işlevleri kapatıp açabilecek seçenekler içerir.
getTagListInfo

/restapi/v1.0/ems/tag

POSTSunucuda kayıtlı etiketlerin listesini içeri aktarır.


Open API Detayları (swagger UI)

http://184.169.167.38:7001/MagicInfo/swagger-ui.html



Sv translation
languagesv


I MagicINFO Server kan du implementera innehållshantering, schemahantering, enhetshantering och andra funktioner genom att anropa Open API (v2.0).

Om du vill använda Open API (v2.0) måste du först gå igenom en autentiseringsprocess. Använd en särskild swagger-sida för att testa varje API.

Autentisering

När du anropar alla Open API (v2.0)-objekt, måste api_token ingå i huvudet. Om detta inte tas med returneras felet "401 Unauthorized".

En erhållen token upphör att gälla och blir omöjlig att använda efter en viss tid. Om så är fallet bör du skaffa en ny token.

api_token kan erhållas genom att man anropar följande api.

Servicenamn

API-anrop

AnropstypBeskrivning
authenticationRequest

/auth

POSTImporterar ett token-värde för autentisering med hjälp av användar-ID:t och lösenordet.
authenticationRequest

/auth/refresh

GETSkapar en ny token för att förlänga giltighetstiden. Det är möjligt att anropa REST API utan att logga in igen.

OPEN API (v2.0)

MagicINFO Server Open API (v2.0) innehåller en mängd olika funktioner. Konfiguration av varje funktion visas nedan.

KategoriStyrenhetBeskrivning
Innehållcontent-controllerHantering av innehåll
content-group-controllerHantering av innehållsgrupper
Spellistaplaylist-controllerHantera spellistor
playlist-group-controllerHantering av spellistegrupper
Schemacontent-schedule-controllerHantering av innehållsscheman
content-schedule-group-controllerHantering av grupper av innehållsscheman
message-schedule-controllerHantering av meddelandescheman
message-schedule-group-controllerHantering av grupper av meddelandescheman
Enhetdevice-controllerEnhetshantering
device-group-controllerHantering av enhetsgrupper
Användareuser-controllerAnvändarhantering
user-group-controllerHantering av användargrupper
Inställningenvironment-controllerInställning

Innehåll

Överföra, godkänna och radera innehåll. Hantera innehållslistor. Innehållsrelaterade tjänster är tillgängliga för autentiserade användare med behörighet att läsa, skriva och hantera innehåll.

Följande innehållshanteringstjänster är tillgängliga:

Servicenamn

API-anrop

AnropstypBeskrivning
listAllContent

/restapi/v1.0/cms/contents

GETImporterar en lista med överfört innehåll. Innehållsminiatyrer, namn, filtyper och andra grundläggande uppgifter ingår i listan. Listor kan importeras per sida med hjälp av sidindelningsinformation.
listDashboardContentInfo

/restapi/v1.0/cms/contents/dashboard

GETImporterar allmän innehållsinformation som ska visas på instrumentpanelen.
listContent

/restapi/v1.0/cms/contents/filter

POSTImporterar en lista med innehåll som filtrerats baserat på villkor. Listor kan importeras per sida med hjälp av sidindelningsinformation.
forceDeleteContent

/restapi/v1.0/cms/contents/force/{contentId}

DELETETar bort innehållet, oavsett om innehållet ingår i en spellista eller ett schema.
deleteContent

/restapi/v1.0/cms/contents/{contentId}

DELETETar bort innehåll efter en kontroll av att innehållet inte ingår i en spellista eller ett schema. Om du försöker ta bort innehåll som ingår i en spellista eller ett schema, tas innehållet inte bort och en felkod returneras.
getActiveContentInfo

/restapi/v1.0/cms/contents/{contentId}

GETImporterar information om en aktiverad version av ett visst innehåll. Innehållets version uppdateras varje gång innehållet redigeras.
approveContents

/restapi/v1.0/cms/contents/{contentId}/approval

PUTGodkänner/avvisar innehåll. Godkänt innehåll flyttas till den allmänna innehållslistan och kan användas i spellistor och scheman.
uploadContent

/restapi/v1.0/cms/contents/{groupId}

POSTÖverför nytt innehåll.

listDefaultGroup

/restapi/v1.0/cms/contents/groups

GETImporterar en lista med standardinnehållsgrupper.
getGroup

/restapi/v1.0/cms/contents/groups/{groupId}

GETImporterar information om gruppen {groupId}.
listChildGroup

/restapi/v1.0/cms/contents/groups/{groupId}/child

GETImporterar en lista med undergrupper under gruppen {groupId}.


Spellista

Använd innehåll för att skapa, redigera och ta bort spellistor. Spellisterelaterade tjänster är tillgängliga för autentiserade användare med behörighet att läsa, skriva och hantera innehåll.

Följande spellistehanteringstjänster är tillgängliga:

Servicenamn

API-anrop

AnropstypBeskrivning
listAllPlaylist

/restapi/v1.0/cms/playlists

GETImporterar en lista med samtliga spellistor. Spellistenamn, huvudinnehållsminiatyrer, spellistetyper och annan grundläggande information ingår i listan. Listor kan importeras per sida med hjälp av sidindelningsinformation.
createPlaylist

/restapi/v1.0/cms/playlists

POSTSkapa en ny spellista.

getDashboardPlaylistInfo

/restapi/v1.0/cms/playlists/dashboard

GETImporterar nödvändig spellisteinformation från instrumentpanelen.

listPlaylist

/restapi/v1.0/cms/playlists/filter

POSTImporterar en lista med spellistor som filtrerats baserat på villkor. Listor kan importeras per sida med hjälp av sidindelningsinformation.

deletePlaylist

/restapi/v1.0/cms/playlists/{playlistId}

DELETETa bort den markerade spellistan. Om du försöker ta bort en spellista som ingår i en ett schema, tas spellistan inte bort och en felkod returneras.

getActivePlaylistInfo

/restapi/v1.0/cms/playlists/{playlistId}

GETImporterar information om en aktiverad version av en spellista. Spellistans version uppdateras varje gång spellistan redigeras.

editPlaylist

/restapi/v1.0/cms/playlists/{playlistId}

PUTRedigerar spellistan {playlistId}. När en spellista redigeras uppdateras dess version, och den spelare som spelar upp spellistan spelar automatiskt upp den uppdaterade spellistan.

copyPlaylist

/restapi/v1.0/cms/playlists/{playlistId}/copy

PUTKopierar spellistan {playlistId}. En kopia av spellistan skapas.
listDefaultGroup

/restapi/v1.0/cms/playlists/groups

GETImporterar en lista med grupper av standardspellistor.

getGroup

/restapi/v1.0/cms/playlists/groups/{groupId}

GETImporterar information om gruppen {groupId}.
listChildGroup/restapi/v1.0/cms/playlists/groups/{groupId}/childGET

Importerar en lista med undergrupper under gruppen {groupId}.

Schema

Skapa nya innehålls- eller meddelandescheman. Publicera scheman till enheter för uppspelning. Redigera eller ta bort scheman.

Schemarelaterade tjänster är tillgängliga för autentiserade användare med behörighet att läsa, skriva och hantera scheman.

Följande schemahanteringstjänster är tillgängliga:

Servicenamn

API-anrop

AnropstypBeskrivning
listContentScheduleAll

/restapi/v1.0/dms/schedule/contents

GETImporterar en lista med alla innehållsscheman. Innehållsschemanamn, tillkomstdatum, spellistetyper och annan grundläggande information ingår i listan. Listor kan importeras per sida med hjälp av sidindelningsinformation.
createContentSchedule

/restapi/v1.0/dms/schedule/contents

POSTSkapar ett nytt innehållsschema. Ett innehållsschema kan innehålla flera kanaler och ramar. Publicera ett schema till enheter och spela upp önskat innehåll eller en önskad spellista vid en angiven tidpunkt.
listDashboardScheduleInfo

/restapi/v1.0/dms/schedule/contents/dashboard

GETImport nödvändig innehållsschemainformation från instrumentpanelen.
listContentScheduleByGroup

/restapi/v1.0/dms/schedule/contents/filter

POSTImporterar en lista med innehållsscheman som filtrerats baserat på olika villkor. Listor kan importeras per sida med hjälp av sidindelningsinformation.
deleteContentSchedule

/restapi/v1.0/dms/schedule/contents/{programId}

DELETETa bort ett innehållsschema. Om du tar bort ett schema som tidigare har publicerats till en enhet, spelar enheten automatiskt upp standardinnehållet.
getProgramInfo

/restapi/v1.0/dms/schedule/contents/{programId}

GETImporterar information om det markerade schemat.
editContentSchedule

/restapi/v1.0/dms/schedule/contents/{programId}

PUTRedigerar ett innehållsschema. Om du redigerar ett schema som tidigare har publicerats till en enhet, spelar enheten automatiskt upp det redigerade schemat.
copyContentSchedule

/restapi/v1.0/dms/schedule/contents/{programId}/copy

PUTKopierar innehållsschemat {programId}. En kopia av innehållsschemat {programId} skapas.
deployContentSchedule

/restapi/v1.0/dms/schedule/contents/{programId}/deploy

PUTPublicerar ett innehållsschema till en specifik enhetsgrupp.
getPublishStatus

/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus

GETImporterar hämtningsstatus för innehållsscheman i realtid från en enhet.
getRootGroups

/restapi/v1.0/dms/schedule/contents/groups

GETImporterar en lista med rotgrupper för ett innehållsschema.
listContentScheduleGroupInfo/restapi/v1.0/dms/schedule/contents/groups/{groupId}GETImporterar information om gruppen {groupId}.
listAllMessageSchedule

/restapi/v1.0/dms/schedule/messages

GETImporterar en lista med samtliga meddelandescheman.
createMessageSchedule

/restapi/v1.0/dms/schedule/messages

POSTSkapar ett nytt meddelandeschema.
listMessage

/restapi/v1.0/dms/schedule/messages/filter

POST

Importerar en lista med meddelandescheman som filtrerats baserat på olika villkor. Listor kan importeras per sida med hjälp av sidindelningsinformation.
deleteMessageSchedule

/restapi/v1.0/dms/schedule/messages/{messageId}

DELETETar bort det markerade meddelandeschemat. Om du tar bort ett meddelandeschema som tidigare har publicerats till en enhet, tillämpas ändringen automatiskt på enheten.
getMessageInfo

/restapi/v1.0/dms/schedule/messages/{messageId}

GETImporterar information om det markerade meddelandeschemat.
editMessageSchedule

/restapi/v1.0/dms/schedule/messages/{messageId}

PUTRedigerar det markerade meddelandeschemat. Om du redigerar ett meddelandeschema som tidigare har publicerats till en enhet, tillämpas ändringen automatiskt på enheten.
copyMessageSchedule

/restapi/v1.0/dms/schedule/messages/{messageId}/copy

PUTKopierar det markerade meddelandeschemat. En kopia av meddelandeschemat skapas.
deployMessageSchedule

/restapi/v1.0/dms/schedule/messages/{messageId}/deploy

PUTPublicerar det markerade meddelandeschemat till en enhetsgrupp.
getRootGroups

/restapi/v1.0/dms/schedule/messages/groups

GETImporterar en lista med rotgrupper för ett innehållsschema.
listMessageScheduleGroupInfo

/restapi/v1.0/dms/schedule/messages/groups/{groupId}

GETImporterar information om gruppen {groupId}.
getChildGroups

/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child

GETImporterar en lista med undergrupper under en specifik grupp.

Enhet

Styr och hantera enheter. Enhetsrelaterade tjänster är tillgängliga för autentiserade användare med behörighet att läsa, skriva och hantera enheter.

Följande enhetshanteringstjänster är tillgängliga:

Servicenamn

API-anrop

AnropstypBeskrivning
listAllDevice

/restapi/v1.0/rms/devices

GETImporterar en lista med samtliga enheter. Enheters strömstatus, information om miniatyrer, enheters felstatus och annan grundläggande information ingår i listan. Listor kan importeras per sida med hjälp av sidindelningsinformation.
getDashboardDeviceInfo

/restapi/v1.0/rms/devices/dashboard

GETImporterar nödvändig enhetsinformation från instrumentpanelen.
filterDeviceList

/restapi/v1.0/rms/devices/filter

POSTImporterar en lista med enheter som filtrerats baserat på olika villkor. Listor kan importeras per sida med hjälp av sidindelningsinformation.
deleteDevice

/restapi/v1.0/rms/devices/{deviceId}

DELETETar bort den markerade enheten.
getDevice

/restapi/v1.0/rms/devices/{deviceId}

GETImporterar information om markerade enheter.
approveDevice

/restapi/v1.0/rms/devices/{deviceId}/approval

PUTGodkänner den markerade enheten för en specifik grupp.
getCabinetList

/restapi/v1.0/rms/devices/{deviceId}/cabinet

POSTImporterar information om Cabinet som är anslutna till en LED-enhet. Den importerade informationen är endast giltig när dina Cabinet är anslutna till en LED-enhet.
updateCabinetInfo

/restapi/v1.0/rms/devices/{deviceId}/cabinet

PUTRedigerar information om Cabinet som är anslutna till en LED-enhet.
getDisplayControlInfo

/restapi/v1.0/rms/devices/{deviceId}/display

GETImporterar enhetens skärmstyrningsinformation från databasen. Om det inte finns någon styrningsinformation ska en informationsbegäran skickas till enheten.
updateDisplayInfo

/restapi/v1.0/rms/devices/{deviceId}/display

PUTSkickar redigerad skärmstyrningsinformation till en enhet. Bara redigerade värden i skärminformationen skickas som ett protokoll till enheten.
getUpdatedDisplayInfoResult

/restapi/v1.0/rms/devices/{deviceId}/display/{requestId}

GETTar emot redigerad skärmstyrningsinformation från en enhet. Detta API kan köras efter att API:t updateDisplayInfo har körts.
getGeneralInfo

/restapi/v1.0/rms/devices/{deviceId}/general

GETImporterar allmän enhetsinformation från databasen. Allmän enhetsinformation uppdateras när enheten ansluts till servern.
updateGeneralInfo

/restapi/v1.0/rms/devices/{deviceId}/general/info

PUTSkickar redigerad enhetsinformation till en enhet. Bara redigerade värden i den grundläggande enhetsinformationen skickas som ett protokoll till enheten.
getUpdatedGeneralInfoResult

/restapi/v1.0/rms/devices/{deviceId}/general/{requestId}

GETTar emot redigerad enhetsinformation från en enhet. Detta API kan köras efter att API:t updateGeneralInfo har körts.
moveDevice

/restapi/v1.0/rms/devices/{deviceId}/move

PUTFlyttar en enhet till en annan grupp.
startRmServerVnc

/restapi/v1.0/rms/devices/{deviceId}/rmserver/start

GETSkickar ett RM-startprotokoll till en enhet. En enhet som fått ett RM-startprotokoll skickar med jämna mellanrum information via fjärrservern.
stopRmServerVnc

/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop

GETSkickar ett RM-stopprotokoll till en enhet. En enhet som fått ett stopprotokoll stoppar motsvarande funktion omedelbart.
getSetupInfo

/restapi/v1.0/rms/devices/{deviceId}/setup

GETImporterar enhetsinställningar. Enhetens inställningar uppdateras när enheten ansluts till servern.
updateSetupInfo

/restapi/v1.0/rms/devices/{deviceId}/setup

PUTSkickar redigerade enhetsinställningar till en enhet. Bara redigerade värden i inställningarna skickas som ett protokoll till enheten.
getUpdatedSetupInfoResult

/restapi/v1.0/rms/devices/{deviceId}/setup/{requestId}

GETTar emot redigerade enhetsinställningar från en enhet. Detta API kan köras efter att API:t updateSetupInfo har körts.
getCurrentStatusDisplay

/restapi/v1.0/rms/devices/{deviceId}/status/display

GETSkickar en aktuell begäran om skärmstyrningsinformation till en enhet. Om detta API anropas, returneras requestId som svarsvärde.
getCurrentStatusDisplay

/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}

GETImporterar skärmstyrningsinformation som skickats från en enhet. Det här alternativet används för två åtgärder: för att skicka en begäran om information till en enhet och för att ta emot själva enhetsinformationen.
getCurrentStatusTime

/restapi/v1.0/rms/devices/{deviceId}/status/time

GETSkickar en begäran om aktuell tidsinformation till en enhet. Om detta API anropas, returneras requestId som svarsvärde.
getCurrentStatusTime

/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}

GETImporterar tidsinformation som skickats från en enhet. Det här alternativet används för två åtgärder: för att skicka en begäran om information till en enhet och för att ta emot själva enhetsinformationen.
getTimeInfo

/restapi/v1.0/rms/devices/{deviceId}/time

GETImporterar tidsinformation för en enhet från databasen. Om det inte finns någon styrningsinformation ska en informationsbegäran skickas till enheten.
updateTimeInfo

/restapi/v1.0/rms/devices/{deviceId}/time

PUTSkickar redigerad tidsinformation till en enhet. Bara redigerade värden i tidsinformationen skickas som ett protokoll till enheten.
getUpdatedTimeInfoResult

/restapi/v1.0/rms/devices/{deviceId}/time/{requestId}

GET

Tar emot redigerad enhetstidsinformation från en enhet. Detta API kan köras efter att API:t getUpdatedTimeInfoResult har körts.

listDeviceGroupOrgan

/restapi/v1.0/rms/devices/groups

GETImporterar en lista med organisationer.
listDeviceGroupInfo

/restapi/v1.0/rms/devices/groups/{groupId}

GETImporterar information om gruppen {groupId}.
listDeviceGroupChild

/restapi/v1.0/rms/devices/groups/{groupId}/child

GETImporterar information om undergrupper under {groupId}.

Användare

Lägg till användare och hantera användarinformation. Användarrelaterade tjänster är tillgängliga för autentiserade användare med behörighet att läsa, skriva och hantera användarinformation.

Följande användarhanteringstjänster är tillgängliga:

Servicenamn

API-anrop

AnropstypBeskrivning
createUser/restapi/v1.0/ums/usersPOSTLägger till en användare.
listDashboardUserInfo

/restapi/v1.0/ums/users/dashboard

GETImporterar nödvändig användarinformation från instrumentpanelen.
updateMyInfo

/restapi/v1.0/ums/users/me

PUTRedigerar användarinformation.
listUserOrgan

/restapi/v1.0/ums/users/organization

GETImporterar en lista med organisationer. Det här alternativet kan användas för att konfigurera ett gruppträd.
listUserGroupOrgan

/restapi/v1.0/ums/users/groups

GETImporterar en lista med organisationer.
listUserGroupInfo

/restapi/v1.0/ums/users/groups/{groupId}

GETImporterar information om gruppen {groupId}.
listUserGroupChild

/restapi/v1.0/ums/users/groups/{groupId}/child

GETImporterar en lista med undergrupper under gruppen {groupId}.

Inställning

Förutom huvudfunktionerna kan du använda många andra funktioner till att skapa och hantera taggar och kategorier samt redigera instrumentpanelen.

Servicenamn

API-anrop

AnropstypBeskrivning
getCategoryInfo

/restapi/v1.0/ems/category/{categoryId}

GETImporterar en lista med kategorier.
deleteDashboard

/restapi/v1.0/ems/dashboard

DELETETar bort specifik instrumentpanelsinformation.
listDashboardInfo

/restapi/v1.0/ems/dashboard

GETImporterar innehåll som ska visas på den anpassade instrumentpanelen. Det går att visa endast specifik information på instrumentpanelen.
updateDashboardPriority

/restapi/v1.0/ems/dashboard

PUTÄndrar ordning på de objekt som visas på instrumentpanelen.
createDashboard

/restapi/v1.0/ems/dashboard/create

GETAktiverar en inaktiv instrumentpanel.

listDashboardLoginInfo

/restapi/v1.0/ems/dashboard/login

GETImporterar inloggningsinformation som ska visas på instrumentpanelen.
listDashboardNoticeInfo

/restapi/v1.0/ems/dashboard/notice

GETImporterar anslagstavleinformation som ska visas på instrumentpanelen.
deleteNoticeInfo

/restapi/v1.0/ems/dashboard/notice/edit

DELETETar bort ett inlägg från anslagstavlan.
listEditNoticeInfo

/restapi/v1.0/ems/dashboard/notice/edit

GETImporterar information om det markerade inlägget.
createNoticeInfo

/restapi/v1.0/ems/dashboard/notice/edit

POSTLägger till inlägg på anslagstavlan.
updateNoticeInfo

/restapi/v1.0/ems/dashboard/notice/edit

PUTRedigerar det markerade inlägget på anslagstavlan.
listDashboardStorageInfo

/restapi/v1.0/ems/dashboard/storage

GETImporterar lagringsinformation som ska visas på instrumentpanelen.

listLicense

/restapi/v1.0/ems/license

GETImporterar en lista med licenser som registrerats på servern.
getServerSetupInfo

/restapi/v1.0/ems/setup

GETImporterar serverinställningar. Serverinställningsobjekt inkluderar alternativ som kan slå på och av olika funktioner på servern.
getTagListInfo

/restapi/v1.0/ems/tag

POSTImporterar en lista med taggar som registrerats på servern.


Open API-information (swagger UI)

http://184.169.167.38:7001/MagicInfo/swagger-ui.html