Ekranlarınızı kendi yazılımınızdan yönetin

OmrarCast REST API'si ile ekranları eşleştirin, gruplayın ve yönetin; medya, playlist, widget ve şablon tasarımlarını oluşturun; fiyat panolarını ve ürün fiyatlarını güncelleyin; raporları indirin. Panelde yaptığınız her işi kendi sisteminizden, API anahtarıyla yapın.

API anahtarı oluşturun OpenAPI belgesi

Nasıl çalışır?

Panelde Ayarlar bölümünden bir API anahtarı oluşturursunuz. Anahtara okuma, içerik yazma, ekran komutu, ekran yönetimi ya da ürün ve fiyat yetkisi verirsiniz.
İsteklerde anahtarı Authorization: Bearer başlığıyla gönderirsiniz. Yanıtlar JSON biçimindedir.
Her çağrı denetim kaydına yazılır; anahtarı istediğiniz an iptal edebilirsiniz.
Ekran çevrimdışı ya da çevrimiçi olduğunda, eşleştiğinde ya da silindiğinde, komut onaylandığında, medya işlendiğinde ve fiyatlar değiştiğinde sisteminize imzalı bildirim (webhook) gönderilir.

Temel API erişimi bütün paketlere dahildir, ücretsiz denemede de kullanabilirsiniz. Yüksek hacimli kullanım için bize yazın.

Ekranları listeleyincurl

curl https://omrarcast.com/api/public/v1/screens \
  -H "Authorization: Bearer $OMRARCAST_API_KEY" \
  -H "Accept: application/json"

Bir ekrana liste atayıncurl

curl -X POST https://omrarcast.com/api/public/v1/screens/42/playlist \
  -H "Authorization: Bearer $OMRARCAST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"playlist_id": 7}'

Toplu fiyat zammını önizleyincurl

curl -X POST https://omrarcast.com/api/public/v1/products/adjust \
  -H "Authorization: Bearer $OMRARCAST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"percent": 10, "category": "Burgerler", "rounding": "1", "dry_run": true}'

Anahtarınızı panelden oluşturun

Panelin sol menüsünde API ve entegrasyonlar sayfasını açın.
Anahtar adı yazın, Yetkiler bölümünden anahtarın neler yapabileceğini seçin ve Anahtar oluştur düğmesine basın.
Anahtar yalnız bir kez gösterilir. Kopyala ile alıp güvenli bir yere kaydedin; gerektiğinde aynı sayfadan iptal edin.

API anahtarı oluşturun

API ve entegrasyonlar sayfasında yeni oluşturulan API anahtarı: Yeni API anahtarınız hazır kutusu, anahtar değeri ve Kopyala düğmesi, altında okuma, içerik yazma, ekran komutu gibi yetki seçenekleri

Uç noktalar

Her grubu açarak uç noktalarını görün. Gövde alanları, yanıtlar, gerekli yetkiler ve hata kodları OpenAPI belgesinde. Taban adres: https://omrarcast.com/api/public/v1

EkranlarEşleştirme, adlandırma, silme, komut, zamanlama, içerik kopyalama, fiyat listesi

GET/screensEkranları ve durumlarını listeler

GET/screens/{id}Ayrıntı, şu an oynayan içerik, atamalar

PATCH/screens/{id}Ekranı yeniden adlandırır

DELETE/screens/{id}Ekranı hesaptan siler

POST/screens/pairEkrandaki eşleştirme koduyla ekranı ekler

POST/screens/{id}/commandsYenile, eşitle, tanıt, parlaklık

POST/screens/bulk/commandAynı komutu en fazla 500 ekrana gönderir

POST/screens/bulk/deleteBirden çok ekranı siler

POST/screens/bulk/groupBirden çok ekranı gruba ekler

POST/screens/bulk/playlistBirden çok ekrana playlist atar

POST/screens/distributePlaylistleri ekranlara sırayla ya da bölerek dağıtır

POST/screens/{id}/playlistEkrana playlist atar ya da atamayı kaldırır

POST/screens/{id}/schedulesGün ve saate bağlı playlist ekler

DELETE/screens/{id}/schedules/{assignment}Zamanlanmış kuralı siler

POST/screens/{id}/copy-contentİçeriği başka ekranlara kopyalar

PUT/screens/{id}/price-listEkranın fiyat listesini ayarlar

AğlarEkranların bağlandığı ağları listeleyin ve adlandırın

GET/networksAğları ve içindeki ekranları listeler

PUT/networks/{key}Ağa ad verir ya da adı siler

GruplarGrup ağacı, üyelik, playlist, dağıtım, zamanlama, fiyat listesi

GET/groupsGrupları listeler

POST/groupsGrup oluşturur

GET/groups/{id}Alt gruplar, ekranlar ve ayarlarla birlikte grup

PUT/groups/{id}Grubu yeniden adlandırır ya da taşır

DELETE/groups/{id}Grubu siler, ekranları gruptan çıkarır

POST/groups/{id}/membersGruba ekran ekler

DELETE/groups/{id}/members/{screen}Ekranı gruptan çıkarır

POST/groups/{id}/playlistGruba playlist atar

POST/groups/{id}/distributePlaylistleri grubun ekranlarına dağıtır

GET/groups/{id}/schedulesGrubun zamanlama kurallarını listeler

POST/groups/{id}/schedulesGruba gün ve saate bağlı playlist ekler

DELETE/groups/{id}/schedules/{assignment}Zamanlanmış kuralı siler

PUT/groups/{id}/price-listGrubun fiyat listesini ayarlar

MedyaGörsel ve video kütüphanesi

GET/mediaMedya kütüphanesini listeler, arar

POST/mediaGörsel ya da video yükler

GET/media/{id}Medyanın ayrıntısı

DELETE/media/{id}Medyayı siler

POST/media/bulk-deleteEn fazla 500 medyayı siler

PlaylistlerOluşturma, sıralama, widget ekleme, atama

GET/playlistsPlaylistleri listeler

POST/playlistsPlaylist oluşturur

GET/playlists/{id}Playlist ve öğeleri

PUT/playlists/{id}Playlisti ve sırasını günceller

DELETE/playlists/{id}Playlisti siler

POST/playlists/{id}/duplicatePlaylisti çoğaltır

POST/playlists/{id}/itemsSona medya ekler

DELETE/playlists/{id}/items/{item}Tek bir öğeyi çıkarır

POST/playlists/{id}/widgetsSona widget ekler

POST/playlists/{id}/assignPlaylisti ekranlara atar

WidgetlarSaat, hava durumu, kur, kayan yazı, web sayfası, RSS, YouTube, fiyat panosu

GET/widgets/typesWidget türleri ve ayar alanları

GET/widgetsWidgetları listeler

POST/widgetsWidget oluşturur

GET/widgets/{id}Widgetın ayarları ve kullanıldığı yerler

PUT/widgets/{id}Widgetı günceller

DELETE/widgets/{id}Widgetı siler

Şablon tasarımlarıHazır şablonlardan görsel tasarımlar

GET/templatesŞablonlar, alanları ve ölçüleri

GET/templates/designsKayıtlı tasarımları listeler

POST/templates/designsŞablondan tasarım kaydeder, görselini yükler

GET/templates/designs/{id}Tasarımın bilgileriyle birlikte ayrıntısı

PUT/templates/designs/{id}Tasarımı günceller

DELETE/templates/designs/{id}Tasarımı siler

İçerik talepleriYönetimli hizmet: değişiklik ve tasarım talepleri

GET/requestsTalepleri ve kalan hakları listeler

POST/requestsİçerik değişikliği ya da tasarım talebi açar

GET/requests/{id}Talebin durum geçmişi ve dosyaları

POST/requests/{id}/approveHazırlanan tasarımı onaylar

POST/requests/{id}/revisionTasarım için revizyon ister

Fiyat panolarıMenü görseli üzerindeki fiyat kutuları

GET/price-boardsPanoları listeler

POST/price-boardsMenü görseli ve fiyat kutularıyla pano oluşturur

GET/price-boards/{id}Pano, kutular ve güncel fiyat metinleri

PUT/price-boards/{id}Panoyu günceller

DELETE/price-boards/{id}Panoyu siler

GET/price-boards/{id}/targetsPanonun gönderilebileceği playlist, ekran ve gruplar

POST/price-boards/{id}/sendPanoyu playlist, ekran ya da gruba ekler

Ürünler ve fiyatlarKatalog, fiyat listeleri, geçmiş, toplu zam ve indirim

GET/productsÜrünleri listeler, arar

PUT/productsÜrün fiyatlarını toplu günceller (POS bağlantısı)

POST/products/adjustYüzde olarak toplu zam ya da indirim; önizleme destekler

GET/products/{code}Ürünün ayrıntısı

PATCH/products/{code}Ürünü ya da fiyat listesindeki fiyatını günceller

DELETE/products/{code}Ürünü siler

GET/products/{code}/historyÜrünün fiyat geçmişi

Hesap ve raporlarPlan, kullanım ve oynatma kayıtları

GET/meHesap, plan ve kullanım

GET/reports/playbacksOynatma kayıtları

GET/reports/playbacks/exportOynatma kayıtlarını CSV olarak indirir

Webhook olayları

Olaylar panelde tanımladığınız adrese imzalı POST ile gelir; imzayı X-OmrarCast-Signature başlığıyla doğrularsınız. Her olayın yük şeması OpenAPI belgesinin webhooks bölümünde.

POSTscreen.offlineEkran sinyal vermeyi bıraktı

POSTscreen.onlineEkran yeniden çevrimiçi oldu

POSTscreen.pairedYeni ekran eşleştirildi

POSTscreen.deletedEkran hesaptan silindi

POSTcommand.ackedEkran gönderilen komutu onayladı

POSTmedia.readyMedya işlendi, kullanıma hazır

POSTmedia.failedMedya işlenemedi

POSTproducts.prices_changedÜrün fiyatları değişti; değişiklikler tek olayda toplanır

Entegrasyonunuzu bugün başlatın

30 gün ücretsiz deneyin, panelden API anahtarınızı oluşturun ve ilk isteğinizi dakikalar içinde gönderin. Yüksek hacimli kullanım için bize yazın.

30 gün ücretsiz deneyin Bize yazın