CAYIN SDK v2.0

CAYIN SDK v2.0

El sistema de CAYIN Señalización Digital proporciona un potente SDK (kit de desarrollo de software), permitiendo crear su propia herramienta de administración mediante APIs basados en HTTP. Aquí hay cinco principales secciones:

Habilitar/Inhabilitar CAYIN SDK

Habilitar/Inhabilitar CAYIN SDK

Inicie sesión en el Administrador Web CMS y vaya a la página SISTEMA > Servicios > Configuración SDK.
Hay 3 modos para CAYIN SDK

  1. Inhabilitar
  2. Habilitar sin clave de autenticación
  3. Habilitar con clave de autenticación
    • Introducir manualmente la clave
    • Haga clic en Aleatorio para generar una clave aleatoria. (Guarde la clave para su uso posterior.)
Nota

Clave de autenticación: 4 – 64 caracteres del alfabeto ingles y números

Volver arriba

Uso del CAYIN SDK

Envíe una solicitud HTTP GET o POST al servidor web interno del SMP o CMS. Para enviar la solucitud puede diseñar su propio programa mediante casi cualquier lenguaje moderno. Si desea intentar enviar una solicitud HTTP GET al SMP/CMS, la manera más facil es ingresar el comando en la barra de direcciones de un navegador.
El siguiente es un ejemplo de cómo enviar un comando:

http://ip/cysdk/?cmd1=value1&cmd2=value2

o

http://ip/cysdk/?cmd1=attribute1:value1;attribute2:value2

Nota

ip es la dirección IP (o nombre de dominio) del SMP/CMS.

Interfaz API:

  • Soporta los métodos HTTP GET y POST
  • Un comando puede contener muchos atributos.
  • El caracter ‘;’ separa cada atributo
  • El caracter ‘:’ separa el nombre y el valor de cada atributo
  • El caracter ‘&’ separa cada comando
  • Primero en la primera ejecución

Ejemplo: establecer la resolución de pantalla con comandos CySDK

http://ip/cysdk/?k=0000&dpyOutput=mode:distinct;rotate:left
&dpy1=output:HDMI1;size:1920x1080@60&dpy2=output:auto;size:1024x768

  • Autenticación: k=0000 (You can ignore it if you choose to disable the authentication)
  • Comando 1: dpyOutput=mode:distinct;rotate:left
    • Atributo 1: mode:distinct
    • Atributo 2: rotate:left
  • Comando 2: dpy1=output:HDMI1;size:1920x1080@60
    • Atributo 1: output:HDMI1
    • Atributo 2: size:1920x1080@60
  • Comando 3: dpy2=output:auto;size:1024x768
    • Atributo 1: output:auto
    • Atributo 2: size:1024x768

Resultado de Comando

Función 1~8:

El SMP/CMS responde con el código de estado HTTP al cliente o programa.

  • OK: devuelve el código 200 (OK) con una página html en blanco.
  • Error: devuelve código 500 (Error interno del servidor)
Nota

Para más información sobre códigos de estado HTTP, tenga como referencia la siguiente página de Wiki: https://en.wikipedia.org/wiki/List_of_HTTP_status_codes

Función 9~28:

All responses of the commands are in json format in HTTP body. You can use json library to decode and further process the results (responses).


Volver arriba

Funciones

CAYIN SDK le permite controlar las siguientes funciones:

  1. Autenticación de seguridad (clave de autenticación)
  2. Operación Atributos Valor Descripción
    k   Alfabetos y números
      Clave: 4 – 64 caracteres del alfabeto inglés y números
      UI: Sistema -> Servicio -> Configuración SDK >  Autenticación

    Ejemplo

    Procesa un comando CAYIN SDK con clave de protección
    http://<ip>/cysdk/?k=0123456789abcdef&play=skin:skin-1
    Procesa un comando CAYIN SDK sin clave de protección
    http://<ip>/cysdk/?play=skin:skin-1

  3. Control de sistema (SMP y CMS)
  4. Operación Atributos Valor Descripción
    sysRestart   0, 1

    0: Ninguna acción

    1: Reiniciar reproductor/servidor

    Ejemplo

    Reinicia su sistema
    http://<ip>/cysdk/?sysRestart=1

  5. Configuración de pantalla (Sólo SMP)
  6. Operación Atributos Valor Descripción
    dpyOutput mode single, clone, extended, distinct
     
    pos 1, 2

    Posición de pantalla:
    1: Arriba - Abajo
    2: Izquierda - Derecha

    *Sólo para modo extendido

    dpy1

    dpy2
    output Auto, VGA, DVI, HDMI Configurar la salida de señal a la pantalla
    size WxH[i][@R] Establece la resolución de pantalla y refresh rate
    W: Ancho
    H: Altura
    i: Interlace (Opcional)
    @R: Refresh rate (Opcional)
    E.g.: 1920x1080@auto
    rotate 0, 1, 2 Rotación de pantalla:
    0: Ninguna rotación (Horizontal)
    1: 90° hacia la derecha (Vertical)
    2: 90° hacia la izquierta (Vertical)
    dpyPwSave   on
    off
    Configurar encendido/apagado de la pantalla
    on: enciende la pantalla
    off: apaga la pantalla

    Ejemplo

    Establece la configuración de pantalla a modo clónico y establece la Pantalla 1 a resolución 1920x1080i.

    http://<ip>/cysdk/?dpyOutput=mode:clone&dpy1=output:HDMI;size:1920x1080i@60;rotate:0

  7. Configuración de entrada de video (sólo SMP)
  8. Operación Atributos Valor Descripción
    videoIn src internal, 1, 2
    interno: tarjeta de captura de video incorporado
    1, 2: dispositivo USB UVC externo
    std NTSC, PAL Estándar de Video
    bri 0, 1, …, 100 Brillo
    con 0, 1, …, 100 Contraste
    sat 0, 1, …, 100 Saturación
    overScan 0, 1, …, 100 Over scan

    Ejemplo

    Configura la fuente de entrada de video desde la tarjeta de captura de video con NTSC

    http://<ip>/cysdk/?videoIn=src:internal;std:NTSC;bri:50;con:50;sat:50;overScan:0

  9. Configuración de Sonido (sólo SMP)
  10. Operación Atributos Valor Descripción
    sndOutput   analog
    digital
    Analógica: salida estéreo (conector jack o RCA)
    Digital: audio digital HDMI
    sound   0 – 100 Sólo para salida analógica

    Ejemplo

    Cambia la salida de sonido a salida analógica
    http://<ip>/cysdk/?sndOutput=analog

  11. Configuración de tiempo (SMP y CMS)
  12. Operación Atributos Valor Descripción
    timeSetting date YYYYMMDDhhmmss,
    YYYYMMDD,
    hhmmss
    Ejemplo:
    Configurar fecha: 20150209
    Configurar hora: 101530
    Configurar fecha y hora: 20150209101530
    timezone City or region name Vea apéndice A para los nombres válidos

    Ejemplo

    http:///cysdk/?timeSetting=timezone:Eastern Time
    http:///cysdk/?timeSetting=timezone:London
    http:///cysdk/?timeSetting=timezone:Taipei

  13. Control de reproducción (Sólo SMP)
  14. Operación Atributos Valor Descripción
    play skin [Skin Name] Nombre de Apariencia
    program [Program Name] Nombre de programa
    playlist [Playlist Name] Nombre de lista de reproducción
    centralctl 1 Programación Central
    display 1, 2 Escoger reproducción en pantalla 1 o pantalla 2
    pbVo1Play
    pbVo2Play
    src file://file
    mms://url
    http://url
    rtb://[ip:]port
    rtp://ip:port
    src://local-all
    src://video-in
    src://usb-storage
    src://central-schedule
     
    ratio auto (default), 4:3, 16:9  
    mute 0, 1  
    random 0, 1  
    display 1, 2 Establecer la zona en pantalla 1 o pantalla 2
    pbIm1Play
    pbIm2Play
    src file://file
    src://local-all
    src://usb-storage
    src://central-schedule
     
    duration 1-999 Duración de reproducción de cada imagen
    sequence forward
    backward
    random
    Secuencia
    scale_fit 0
    1 (default)
    2
    Ajustar para adaptar al área
    0: Inhabilitar
    1: Ajustar al área (Proporcionalmente)
    2: Ajustar al área (No Proporcional)
    transition_effect 0
    1
    2
    3
    4

    255
    0: Ningún efecto (predeterminado)
    1: Barrido hacia derecha (nombre previo: Izquierda a derecha)
    2: Barrido hacia izquierda (nombre previo: Derecha a izquierda)
    3: Barrido hacia abajo (nombre previo: Arriba a abajo)
    4: Barrido hacia arriba (nombre previo: Abajo a arriba)

    255: Aleatorio
    Por favor tenga como referencia el manual de usuario online para la lista completa de todos los efectos transitorios.
    display 1, 2 Establecer la zona en pantalla 1 o pantalla 2
    pbTk1Play
    pbTk2Play
    src text://file
    http://rss-feed
    rss://url
    src://file
    src://central-schedule
     
    direction 1,2 1: Izquierda a Derecha
    2: Derecha a Izquierda
    font [font name]  
    fsize 10 to 200  
    fcolor [font color] Color de fuente predeterminado: 0xFFFFFF
    Ejemplo: 0x118A3F
    • El primer 11 significa color Rojo
    • En el medio 8A significa color Verde
    • El último 3F significa color Azul
    Todos los números usan valores hexadecimales
    bcolor [background color] Color de fondo predeterminado: 0x000000
    Ejemplo: 0x118A3F
    • El primer 11 significa color Rojo
    • En el medio 8A significa color Verde
    • El último 3F significa color Azul
    Todos los números usan valores hexadecimales
    seffect 1, 2, 3, 4 Efecto de desplazamiento del texto
    1: Sin efecto de desplazamiento
    2: Arrastre sencillo
    3: Abajo-arriba sencillo
    4: Abajo-arriba y arrastre
    speed 1, 2, 3, 4, 5, 6  
    pause 0, 0.5, 1, 1.5, 2, 2.5, 3 Pausa
    spacing 0, 0.25, 0.5, 1, 1.25, 1.5 Espaciado de Línea
    display 1, 2 Establecer la zona en pantalla 1 o pantalla 2
    pbHtm1Play
    pbHtm2Play
    pbHtm3Play
    src file://file
    http://url
    https://url
    twitter://user
    weather://id
    central-schedule
     
    template 0, 1, … , 12 Twitter
    title [title] Twitter
    subject [subject] Twitter
    size 250x75
    285x170
    550x230
    Clima
    fcolor [foreground color] Clima
    bcolor [background color] Clima
    effect 0, 1 Clima
    units 0, 1 Clima
    pause 0-9 Clima
    icons 0, 1 Clima
    display 1, 2 Establecer la zona en pantalla 1 o pantalla 2
    pbAttr scrollbar auto, hide  
    hwaccel 0, 1 0: apagado, 1: encendido
    flashver 9, 24 Flash versión 9 o 24
    autoUpdate 1-999
    disable
     

    Ejemplo

    Cambia la reproducción a apariencia-1
    http://<ip>/cysdk/?play=skin:skin-1;display:1
    Configura la zona de imagen 1 a reproducir un archivo y una carpeta en carpeta multimedia
    http://<ip>/cysdk/?pbIm1Play=src:file://file1.jpg;src:file://folder/;duration:1
    Configura la zona de ticker 1 a reproducir un RSS
    http://<ip>/cysdk/?pbTk1Play=rss://url;seffect:1
    Configura la zona HTML 1 a reproducir un archivo en carpeta multimedia
    http://<ip>/cysdk/?pbHtm1Play=src:file://file1.html
    Cambia al Adobe Flash player a versión 9
    http://<ip>/cysdk/?pbAttr=flashver:9

  15. Configuración RTB (sólo CMS)
  16. Operación Atributos Valor Descripción
    rtb channel 1, 2 Puerto de entrada
    active enable
    disable
     
    port UDP port number 8100, 8102, ..., 8226
    input composite
    s-video
     
    std NTSC, PAL  
    bri 0,1…,100  
    con 0,1…,100  
    sat 0,1…,100  
    format mpeg2, mpeg4  
    bit 256k, 512k, 1M, 2M, 3M,  4M, 5M  
    bocast 1/enable
    0/disable
    1: habilitar
    0: inhabilitar
    mtcast ip, disable Multidifusión
    uncast ip, enable, disable Unidifusión

    Ejemplo

    Active el canal 1 con salida de transmisión MPEG-4 a una velocidad de 512 kbps y transmita al destino 192.168.1.2 mediante unidifusión
    http://<ip>/cysdk/?rtb=channel:1;active:enable;input:composite;format:mpeg4;bit:512k;
    uncast:192.168.1.2

  17. Comandos de inicio/cierre de sesión (sólo CMS)
  18. Comando Autenticación
    (opcional)
    Atributos Valor Nota
    login k=your_authencation_key user [User name] Log in as a specified user
    pass [Password]
    Resultado Cuerpo Nota

    {
    "result":"0",
    "session":"1038858172"
    }

    Resultado:
    0: Correcto
    Otro: Fallo

    Ejemplo:

    http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&login=user:administrator;pass:admin


    Comando Autenticación
    (opcional)
    Atributos Valor Nota
    logout k=your_authencation_key session [Session id] Logout
    Resultado Cuerpo Nota

    N/A

     

    Ejemplo:

    http://CMS_IP/cysdk/?k=UXWdFUURPmLbF &logout=session:session-id

    Nota

    Use el comando de inicio de sesión para obtener session id. Este id de sesión se usará en los siguientes comandos SDK (n.º 10-28)

  19. Obtenga la lista de SMP (sólo CMS)
  20. Comando Autenticación
    (opcional)
    Atributos Valor Nota
    query k=your_authencation_key get smplist Obtenga la lista de SMP que se conectan a este CMS
    Resultado Cuerpo Nota
    {
    "result":"string",
    "client":[
    {
    "hostname":"string",
    "model":"string",
    "version":"string",
    "IP":"string",
    "mac":"string",
    "group":"string",
    "cms":"string",
    "connect":"string"
    },
    {client2….}, {client3….}
    ]
    }
    Resultado:
    0: Correcto
    Otro: Fallo

    Ejemplo:

    Query http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&query=get:smplist;
    Response {
    "Result":"0",
    "client":[
    {
    "hostname":"1F-001",
    "model":"SMP-2100",
    "version":"2.1",
    "group":"groupA",
    "connect":"1",
    "IP":"10.0.0.10",
    "mac":"00:30:18:CD:10:01",
    "cms":"hostname"
    },
    {
    "hostname":"1F-002",
    "model":"SMP-2100",
    "version":"2.1",
    "group":"groupA",
    "connect":"1",
    "IP":"10.0.0.11",
    "mac":"00:30:18:CD:10:02",
    "cms":"hostname"
    },
    {client3….},
    {client4…},
    {client5…}
    ]
    }

  21. Obtener registros CMS/SMP (sólo CMS)
  22. Comando Autenticación
    (opcional)
    Atributos Valor Nota
    query k=your_authencation_key get log  
    target mac_address Dirección MAC de SMP o CMS
    retrivefrom YYYYMMDDhhmmss p.ej. Registro desde la fecha 20170629120000 (opcional)
    Resultado Cuerpo Nota

    {
    "result":"string",
    "logs":[
    {
    "time":"string",
    "type":"string",
    "category":"string",
    "msg":"string",
    }
    {log2….}, {log3….}
    ]
    }

    Resultado:
    0: Correcto
    Otro: Fallo

    Ejemplo:

    Consulta http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&query=get:log;
    target:4C02890A25C7;retrivefrom:20170629120000
    Response {
    "Result":"0",
    "logs":[
    {
    "time":"Mon Jun 26 15:33:44 2017",
    "type":"INFORMATION",
    "category":"SYSTEM",
    "msg":"[SMP-2100]: SYSTEM: System start up."
    },
    {log2….}, { log3….}
    ]
    }

  23. Obtener estado de hardware de SMP (p. ej., utilidad de CPU, etc.) (sólo CMS)
  24. Comando Autenticación
    (opcional)
    Atributos Valor Nota
    query k=your_authencation_key get hwinfo  
    target mac_address Dirección MAC de SMP o CMS
    Resultado Cuerpo Nota
    {
    "result":"string",
    "client":{
    "cpu":{"usage": "string", "temp": INT, "fan": INT},
    "mem":{"total": "string", "used": "string", "usage": "string"},
    "disk":{
    "system":["string", "string", "string"],
    "resource":["string", "string", "string"],
    "media":["string", "string", "string"],
    "external": ["string", "string", "string"]
    },
    "sys":{"temp":INT, "fan":INT}
    }
    }
    Resultado:
    0: Correcto
    Otro: Fallo

    Ejemplo:

    Consulta http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&query=get:hwinfo;
    target:4C02890A25C7
    Response {
    "result":"0",
    "client":{
    "cpu":{"usage":"0.7%", "temp":-1, "fan":-1},
    "mem":{"total": "3.72GB", "used":"768.14MB", "usage":"20.2%"},
    "disk":{
    "drive":["26.42GB", "522.99MB", "1.9%"],
    "system":["1.91GB", "318.22MB", "16.3%"],
    "resource":["3.81GB", "160.85MB", "4.1%"],
    "media":["20.70GB", "43.92MB","0.2%"],
    "external": ["20.70GB", "43.92MB","0.2%"]
    },
    "sys":{"temp":-1, "fan":-1}
    }
    }

  25. Obtener información de parche de CMS/SMP (sólo CMS)
  26. Comando Autenticación
    (opcional)
    Atributos Valor Nota
    query k=your_authencation_key get patchlist  
    target mac_address Dirección MAC de SMP o CMS
    Resultado Cuerpo Nota

    {
    "result":"string",
    "patch": [
    "patch1",
    "patch2",
    "patch3"
    ]
    }

    Resultado:
    0: Correcto
    Otro: Fallo

    Ejemplo:

    Consulta http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&query=get:patchlist;
    target:4C02890A25C7
    Response {
    "Result":"0",
    "patch":[
    "P17684: Fix a problem causing player not booting due to log locked by system"
    ]
    }

  27. Cargar parche en SMP (sólo CMS)
  28. Comando Autenticación
    (opcional)
    Atributos Valor Nota
    action k=your_authencation_key do upPatch  
    target mac_address Dirección MAC de SMP o CMS
    group Group name Cargar parche en los reproductores de un grupo específico
    file smb, http, or ftp URL URL del archivo del parche
    Resultado Cuerpo Nota

    {
    "result":"string",
    "detail": [
    { "hostname":"string",
    "IP":"string",
    "mac":"string",
    "result":"string"},
    {…}
    ]
    }

    Resultado:
    0: Correcto
    Otro: Fallo
    Nota

    No se puede usar el atributo de destino y grupo en un comando.

    Ejemplo:

    Consulta http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&action=do:upPatch;
    target:4C02890A25C7;file:smb://account:password@172.16.0.7/temp/P17699.psu

  29. Cambiar grupo de SMP (sólo CMS)
  30. Comando Autenticación
    (opcional)
    Atributos Valor Nota
    action k=your_authencation_key do chGroup  
    target mac_address Dirección MAC de SMP
    toGroup Group name El grupo de destino que desea cambiar
    Resultado Cuerpo Nota

    {
    "result":"string",
    }

    Resultado:
    0: Correcto
    Otro: Fallo

    Ejemplo:

    Consulta http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&action=do:chGroup;
    target:4C02890A25C7;toGroup:mygroup

  31. Cambiar programa de emergencia y activar grupos (sólo CMS)
  32. Comando Autenticación
    (opcional)
    Atributos Valor Nota
    emergency k=your_authencation_key skin Skin name  
    program Program name  
    playlist Playlist name  
    playback all, 1, 2, 3, 4 ID de reproducción
    all: toda la reproducción (default)
    1: Reproducción 1
    2: Reproducción 2
    3: Reproducción 3
    4: Reproducción 4
    group Group name  
    trigger 0, 1 0: Inhabilitar
    1: Habilitar
    Resultado Cuerpo Nota

    {
    "result":"0",
    "cms":[
    {
    "hostname":"string",
    "IP":"string",
    "mac":"string",
    "result":"0"
    },
    {cms-2},
    {cms-3},
    ]
    }

    Resultado:
    0: Correcto
    Otro: Fallo
    Nota

    No se pueden usar los atributos Máscara, Programa y Lista de reproducción al mismo tiempo.

    Ejemplo:

    Consulta http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&emergency=skin:skin1;
    playback:all;group:groupA;trigger:1
    Response {"result":"0",
    "cms":[
    {"hostname":"CMS-40-Hub","IP":"172.16.100.250","mac":"00:90:0B:26:CD:3A",
    "result":"0"},
    {"hostname":"CMS-40-Backup","IP":"172.16.12.59","mac":"00:90:0B:27:CC:FC",
    "result":"0"},
    {"hostname":"CMS-40-site2","IP":"172.16.100.251","mac":"00:0C:29:0F:AA:E2",
    "result":"0"},
    {"hostname":"CMS-40-site1","IP":"172.16.12.186","mac":"00:0C:29:03:1E:4F",
    "result":"0"}
    ]
    }
    Nota

    La respuesta incluye todos los resultados en el servidor principal, servidor de sitios y servidor de copias de seguridad.

  33. Get group list (sólo CMS)
  34. Comando Autenticación
    (opcional)
    Atributos Valor Nota
    query k=your_authencation_key get grouplist Obtener la lista de grupos completa del CMS
    Resultado Cuerpo Nota

    {
    "result":"0",
    "group": [{
    "name": "string",
    "folder": "string",
    "child": [{
    "name": "string",
    "folder": "string",
    "child": [{
    "name": "string",
    "folder": "string",
    }]
    }]
    },
    {next group}
    ]
    }

    Resultado:
    0: Correcto
    Otro: Fallo

    Ejemplo:

    Consulta http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&query=get:grouplist
    Response {
    "result": "0",
    "group": [{
    "name": "A_layer1",
    "folder": "folder_1",
    "child": [{
    "name": "A_layer2",
    "folder": "folder_2",
    "child": [{
    "name": "A_layer3",
    "folder": "folder_3",
    }]
    }]
    }, {
    "name": "B_layer1",
    "folder": "folder_4",
    }]
    }

  35. Modificar atributos de grupo (sólo CMS)
  36. Comando Autenticación
    (opcional)
    Atributos Valor Nota
    action k=your_authencation_key do modgroup  
    group group name El grupo que se va a modificar
    newgroup new group name Cambiar el nombre del grupo
    parent parent group name Cambiar el principal del grupo por uno nuevo
    top 1 Cambiar el grupo a la primera capa (no principal)
    Resultado Cuerpo Nota

    {
    "result":"string"
    }

    Resultado:
    0: Correcto
    Otro: Fallo

    Ejemplo:

    Consulta http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&action=do:modgroup;
    group:group_a;newgroup:group_c
    Response {
    "result": "0",
    }
    Nota

    El atributo superior no se puede usar con un atributo principal.

  37. Get Skin schedule (sólo CMS)
  38. Obtener programa de máscara actual para un grupo específico en la máscara actual.

    Comando Autenticación
    (opcional)
    Atributos Valor Nota
    action k=your_authencation_key get skinlist  
    group group name El grupo que se va a consultar
    Resultado Cuerpo Nota

    {
    "result":"0",
    "skin": [
    {"name": "string",
    "group": "string",
    "currentSchedule":"sting"}
    ]
    }

    Resultado:
    0: Correcto
    Otro: Fallo

    Ejemplo:

    Consulta http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&query=get:skinlist;
    group:my_group
    Response {
    "result": "0",
    "skin": [
    {"name":"skin1", "group": "A_layer3", "currentSchedule":"0"},
    {"name":"skin2", "group": "A_layer3", "currentSchedule":"0"},
    {"name":"skin4", "group": "A_layer2", "currentSchedule":"0"},
    {"name":"skin5", "group": "A_layer1", "currentSchedule":"1"},
    ]
    }

  39. Set Main CMS (sólo CMS)
  40. Ajuste el CMS como servidor principal y sus opciones.

    Comando Autenticación
    (opcional)
    Atributos Valor Nota
    redundancy k=your_authencation_key mode 1  
    mCode Authentication code El código de autenticación entre el servidor principal y el de copias de seguridad.
    port Port number  
    backupIP Backup server IP  
    reverseSync 0, 1 0: Desactivar sincronización inversa
    1: Activar sincronización inversa
    Resultado Cuerpo Nota

    {
    "result":"0",
    "mode":"1"
    }

    Resultado:
    0: Correcto
    Otro: Fallo

    Ejemplo:

    Consulta http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&&redundancy=mode:1;
    mCode:1234567890;port:40001;backupIP:IP;reverseSync:0
    Response {
    "result":"0",
    "mode":"1"
    }

  41. Set Backup CMS (sólo CMS)
  42. Ajuste el CMS como servidor de copias de seguridad y sus opciones.

    Comando Autenticación
    (opcional)
    Atributos Valor Nota
    redundancy k=your_authencation_key mode 2  
    bCode Authentication code El código de autenticación entre el servidor principal y el de copias de seguridad.
    connectIp IP address Dirección IP del servidor principal
    updateFirst 0, 1 1: Sincronizar inmediatamente
    freqType 0 Sincronizar con el servidor principal cada "período" minutos
    period minutes
    Resultado Cuerpo Nota
    {
    "result":"0",
    "mode":"2"
    }
    Resultado:
    0: Correcto
    Otro: Fallo

    Ejemplo:

    Consulta http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&redundancy=mode:2;
    bCode:1234567890;connectIp:192.168.1.8;updateFirst:1;freqType:0;period:5
    Response {
    "result":"0",
    "mode":"2"
    }

  43. Obtener configuraciones de redundancia de CMS (sólo CMS)
  44. Get CMS’ redundancy configurations.

    Comando Autenticación
    (opcional)
    Atributos Valor Nota
    query k=your_authencation_key get redundancy  
    Resultado Cuerpo Nota
    {
    "result":"0",
    "self": {
    "hostname": "string",
    "mac": "string",
    "IP": "string",
    "mode": "string"
    },
    "another": {
    "status": "string",
    "hostname": "string",
    "mac": "string",
    "IP": "string",
    "mode": "string"
    }
    }
    Resultado:
    0: Correcto
    Otro: Fallo

    Ejemplo:

    Consulta http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&query=get:redundancy
    Response {
    "result":"0",
    "self": {
    "hostname": "cms-main",
    "mac": "00:0C:29:0F:AA:E2",
    "IP": "172.16.12.59",
    "mode": "1"
    },
    "another": {
    "status": "1",
    "hostname": "cms-backup",
    "mac": "00:0C:29:0F:AA:E2",
    "IP": "172.16.12.59",
    "mode": "2"
    }
    }

  45. Obtener estado de programa de emergencia de CMS (sólo CMS)
  46. Comando Autenticación
    (opcional)
    Atributos Valor Nota
    query k=your_authencation_key get emergency  
    Resultado Cuerpo Nota
    {
    "result":"0",
    "group": [{
    "name": "string",
    "trigger": "string",
    "playback": [
    {
    "enable": "string",
    "type": "string",
    "name": "string",
    "playbackOutput": "string"
    }
    ]
    }
    ]
    }
    Resultado:
    0: Correcto
    Otro: Fallo

    Ejemplo:

    Consulta http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&query=get:emergency
    Response {
    "result":"0",
    "group": [{
    "name": "aaaaa",
    "trigger": "1",
    "playback": [
    {"enable": "1", "type": "skin", "name": "Basic-2", "playbackOutput": "1"},
    {"enable": "1", "type": "skin", "name": "Basic-3" , "playbackOutput": "2"},
    {"enable": "0", "type": "playlist", "name": "playlist1", "playbackOutput": "3"},
    {"enable": "0", "type": "program", "name": "program1", "playbackOutput": "4"}
    ]
    }
    ]
    }

  47. Ajustar manualmente el programa de emergencia de CMS del servidor de sitios (sólo CMS)
  48. Comando Autenticación
    (opcional)
    Atributos Valor Nota
    query k=your_authencation_key trigger 0, 1 0: Inhabilitar
    1: Habilitar
    group Group name  
    playback 1, 2, 3, 4  
    skin Skin name  
    program Program name  
    playlist Playlist name  
    manually 0, 1 0: Controlar con el servidor principal
    1: Activar manualmente por el servidor de sitios
    Resultado Cuerpo Nota
    {
    "result":"0",
    "cms":[
    {"hostname":"string","IP":"string","mac":"string","result":"0"}
    ]
    }
    Resultado:
    0: Correcto
    Otro: Fallo
    Nota

    No se pueden usar los atributos Máscara, Programa y Lista de reproducción al mismo tiempo.

    Ejemplo:

    Consulta http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&emergency=trigger:1;
    group:SMP-8000;playback:1;skin:Basic-2;manually:1
    Response {
    "result":"0",
    "cms":[
    {"hostname":"station_cms","IP":"172.16.100.250","mac":"00:90:0B:26:CD:3A","result":"0"}
    ]
    }

  49. Añadir cuenta de usuario y configurar derechos de acceso (sólo CMS)
  50. Comando Autenticación
    (opcional)
    Atributos Valor Nota
    action k=your_authencation_key do addacc  
    acc User name Nombre de usuario
    pass Password Contraseña de la cuenta
    group Group name Se pueden asignar varios nombres de grupos. Separe cada nombre de grupo por ",".
    r_group Access right hex code Vea las tablas a continuación. Use bit o elija varios atributos. (p.ej. 0x01011)
    r_lib
    r_sch
    r_mbyftp
    r_emergsch
    Resultado Cuerpo Nota
    {
    "result":"0"
    }
    Resultado:
    0: Correcto
    Otro: Fallo

    Ejemplo:

    Consulta http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&action=do:addacc;
    acc:user_a;pass:12345;group:aaaaa,bbbbb,ccccc;r_group:0x11;r_lib:0x111111;
    r_sch:0x1111111;r_mbyftp:0x1;r_emergsch:0x1
    Response {
    "result":"0"
    }

    Attribute codes of adding an account’s access right

    Atributos Función Código
    r_group Access-Folder 0x01
    Access-Group 0x10
    r_lib Library-File 0x000001
    Library-Font 0x000010
    Library-Clock 0x000100
    Library-Skin 0x001000
    Library-Program 0x010000
    Library-Playlist 0x100000
    r_sch Schedule-Playback 0x00000001
    Schedule-Video 0x00000010
    Schedule-Image Slideshow 0x00000100
    Schedule-Ticker 0x00001000
    Schedule-HTML 0x00010000
    Schedule-Volume 0x00100000
    Schedule-Skin 0x01000000
    Schedule-Playlist 0x10000000
    r_mbyftp Media Folder Access By FTP 0x1
    r_emergsch Trigger Emergency Schedule 0x1

  51. Eliminar una cuenta (sólo CMS)
  52. Comando Autenticación
    (opcional)
    Atributos Valor Nota
    action k=your_authencation_key do rmacc  
    acc User name  
    Resultado Cuerpo Nota
    {
    "result":"0"
    }
    Resultado:
    0: Correcto
    Otro: Fallo

    Ejemplo:

    Consulta http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&action=do:rmacc;
    acc:user_a
    Response {
    "result":"0"
    }

  53. Modificar atributos de cuenta (sólo CMS)
  54. Comando Autenticación
    (opcional)
    Atributos Valor Nota
    action k=your_authencation_key do modacc  
    acc User name  
    pass Password Contraseña para la cuenta
    newacc User name Cambiar el nombre de usuario
    newpass Password Cambia la contraseña
    r_group Group name Se pueden asignar varios nombres de grupos. Separe cada nombre de grupo por ",".
    r_lib Access right hex code Cambiar derechos de acceso. Use bit o elija varios atributos. (p.ej. 0x01011)
    r_sch
    r_mbyftp
    r_emergsch
    Resultado Cuerpo Nota
    {
    "result":"0"
    }
    Resultado:
    0: Correcto
    Otro: Fallo

    Ejemplo:

    Consulta http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&action=do:modacc;
    acc:user_a;pass:12345;newacc:user_b;newpass:67890;group:aaaaa,bbbbb,ccccc;
    r_group:0x11;r_lib:0x111111;r_sch:0x1111111
    Response {
    "result":"0"
    }

  55. Get skin layout (sólo CMS)
  56. Comando Autenticación
    (opcional)
    Atributos Valor Nota
    query k=your_authencation_key get skin  
    skin Skin name  
    group Group name  
    Resultado Cuerpo Nota
    {
    "result":"0"
    "skin":[ {
    "name":"string",
    "layout":[
    {
    "w":INT,"h":INT,
    "zones": INT,
    "zone":[
    {"type":"string","loc":{"x":INT,"y":INT,"w":INT,
    "h":INT,"z":INT}},
    {"type":"string","loc":{"x":INT,"y":INT,"w":INT,
    "h":INT,"z":INT}}
    ]
    }
    ]
    }]
    }

    Resultado:
    0: Correcto
    Otro: Fallo


    name: Apariencia nombre
    w: Apariencia anchura
    h: Apariencia altura
    zones: número de zona
    zone: información de la zona
    type: tipo multimedia
    loc: coordenada y tamaño de zona

    Ejemplo:

    Consulta http://CMS_IP/cysdk/?k=UXWdFUURPmLbF&session=session_id&query=get:skin;
    skin:Skin-1;group:group_a
    Response {
    "result":"0"
    "skin":[ {
    "name":"Skin18",
    "layout":[
    {
    "w":1920,"h":1080,
    "zones": 3,
    "zone":[
    {"type":"video","loc":{"x":67,"y":62,"w":609,"h":385,"z":1}},
    {"type":"image","loc":{"x":1037,"y":44,"w":677,"h":484,"z":7}},
    {"type":"html","loc":{"x":2,"y":514,"w":842,"h":492,"z":7}}
    ]
    }
    ]
    }]
    }
Volver arriba

Apéndice A: ciudades válidas para configuración de zona horaria

(GMT-12:00) Eniwetok, Kwajalein
(GMT-11:00) MidwayIsland, Samoa
(GMT-10:00) Hawaii
(GMT-09:00) Alaska
(GMT-08:00) Pacific Time (US & Canada); Tijuana
(GMT-07:00) Arizona
(GMT-07:00) Mountain Time (US & Canada)
(GMT-06:00) Central Time (US & Canada)
(GMT-06:00) Mexico City, Tegucigalpa
(GMT-06:00) Saskatchewan
(GMT-05:00) Bogota, Lima, Quito
(GMT-05:00) Eastern Time (US & Canada)
(GMT-05:00) Indiana (East)
(GMT-04:00) Atlantic Time (Canada)
(GMT-04:00) Caracas, La Paz
(GMT-04:00) Santiago
(GMT-03:30) Newfoundland
(GMT-03:00) Brasilia
(GMT-03:00) Buenos Aires, Georgetown
(GMT-02:00) Mid-Atlantic
(GMT-01:00) Azores, Cape Verde Is.
(GMT) Casablanca, Monrovia
(GMT) Greenwich Mean Time: Dublin, Edinburgh, Lisbon, London
(GMT+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna
(GMT+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague
(GMT+01:00) Brussels, Copenhagen, Madrid, Paris, Vilnius
(GMT+01:00) Sarajevo, Skopje, Sofija, Warsaw, Zagreb
(GMT+02:00) Athens, Istanbul, Minsk
(GMT+02:00) Bucharest
(GMT+02:00) Cairo
(GMT+02:00) Harare, Pretoria
(GMT+02:00) Helsinki, Riga, Tallinn
(GMT+02:00) Israel
(GMT+03:00) Baghdad, Kuwait, Riyadh
(GMT+03:00) Moscow, St. Petersburg, Volgograd
(GMT+03:00) Nairobi
(GMT+03:30) Tehran
(GMT+04:00) Abu Dhabi, Muscat
(GMT+04:00) Baku, Tbilisi
(GMT+04:30) Kabul
(GMT+05:00) Eekaterinburg
(GMT+05:00) Islamabad, Karachi, Tashkent
(GMT+05:30) Bombay, Calcutta, Madras, New Delhi
(GMT+06:00) Almaty, Dhaka
(GMT+06:00) Colombo
(GMT+07:00) Bangkok, Hanoi, Jakarta
(GMT+08:00) Beijing, Chongqing, Hong Kong, Urumqi
(GMT+08:00) Perth
(GMT+08:00) Singapore
(GMT+08:00) Taipei
(GMT+09:00) Osaka, Sapporo, Tokyo
(GMT+09:00) Seoul
(GMT+09:00) Yakutsk
(GMT+09:30) Adelaide
(GMT+09:30) Darwin
(GMT+10:00) Brisbane
(GMT+10:00) Canberra, Melbourne, Sydney
(GMT+10:00) Guam, Port Moresby
(GMT+10:00) Hobart
(GMT+10:00) Vladivostok
(GMT+11:00) Magadan, Solomon Is., New Caledonia
(GMT+12:00) Auckland, Wellington
(GMT+12:00) Fiji, Kamchatka, Marshall Is.

Ejemplo:

http://<ip>/cysdk/?timeSetting=timezone:Eastern Time
http://<ip>/cysdk/?timeSetting=timezone:London
http://<ip>/cysdk/?timeSetting=timezone:Taipei

Volver arriba

Apéndice B: Códigos de resultados SDK

-1 : Tiempo de espera El valor predeterminado del tiempo de espera es de 30 segundos.
 0 : Correcto.
 1 : Asegúrese de que la cuenta y la contraseña son correctas.
 2 : No se pudo cerrar sesión.
 3 : La sesión no es válida.
 4 : La clave de operaciones no es válida.
 5 : La clave del atributo para el comando de consulta no es válida.
 6 : El valor del atributo obtener para el comando de consulta no es válido.
 7 : No se pudo obtener la lista de CMS.
 8 : No se pudo obtener la lista de SMP.
 9 : El destino de SMP o CMS no está conectado.
10 : El destino de SMP o CMS no se encuentra.
11 : No se pudo obtener HWInfo del SMP.
12 : No se pudo obtener PatchList del SMP o CMS.
13 : No se pudieron obtener registros del SMP o CMS. (Sucede si el registro está vacío.)
14 : Alguien está obteniendo los registros del mismo destino en este momento. Debe esperar un momento.
15 : La clave del atributo para el comando de acción no es válida.
16 : El valor del atributo -do para el comando de acción no es válido.
17 : No se pudo cambiar el grupo del SMP.
18 : Debe introducir el archivo del parche.
19 : No se puede descargar el archivo del parche.
20 : No se admite el formato de archivo del parche. Debe ser .psu.
21 : El grupo no es válido.
22 : No debe introducir un destino y un grupo al mismo tiempo.
23 : Introduzca un destino o un grupo.
24 : Espere un momento cuando se cargue un parche.
25 : No se pudo cargar un parche.
26 : La clave del atributo para el comando de consulta no es válida.
27 : El valor del atributo reproducir para el comando de emergencia no es válido.
28 : El valor del atributo grupo para el comando de emergencia no es válido. O bien este grupo no está controlado por la cuenta.
29 : Solo se permite un recurso seleccionado.
30 : El recurso seleccionado no es válido.
31 : El valor del atributo activar para el comando de emergencia no es válido.
32 : Su cuenta no tiene derechos de acceso para el programa de emergencia.
33 : No se pudo activar el programa de emergencia.
34 : No se pudo enviar la notificación.
35 : El grupo no es válido.
36 : No se puede mover el grupo al grupo superior porque este grupo tiene grupos secundarios.
37 : El nombre de grupo ya existe. No se puede añadir ni modificar el mismo nombre.
38 : El nombre del grupo no es válido. Debe contener letras (a~z o A~Z), números (0-9), subrayado (_) y guiones (-).
39 : El nombre del grupo principal no es válido o no existe.
40 : El grupo no es válido.
41 : El nombre de la cuenta no es válido. Debe contener letras (a~z), números (0-9) y subrayado (_).
42 : La cuenta ya existe.
43 : La contraseña no es válida.
44 : Algunos de los grupos no son válidos.
45 : La cuenta no es válida.
46 : No se pudo modificar la cuenta.
47 : El nombre de cuenta no es válido o no existe.
48 : La contraseña de la cuenta no es válida.
49 : El nombre de la cuenta no es válido.
50 : La nueva cuenta ya existe.
51 : La nueva contraseña no es válida.
52 : Algunos de los grupos no son válidos.
53 : El grupo no existe o no es válido.
54 : La máscara no existe en este grupo.

Volver arriba