Api Aplication

API Aplication

Gestiona consultas a la aplicación en función de distintos parámetros  como dispositivos registrados o  usuarios.
 

Dispositivos registrados  

GET /2.0/application/getRegisteredDevices/{claveAplicacion}/{tipo}


Devuelve una lista con los dispositivos activos de la aplicación introduciendo por parámetro si los dispositivos tienen un usuario registrado o son anónimos.

Ejemplo de petición
GET /octopus-rs/services/2.0/application/getRegisteredDevices/1afd7ea2f688459699d2597f878f7860/2 HTTP/1.1
Content-Type: application/json
Ejemplo de respuesta
{
    "error": {
        "descripcion": "Todo correcto",
        "codError": "0"
    },
    "respuesta": [
        {
            "tipoDisp": 3,
            "idDispositivo": "88DB041A-DC40-49B0-AFCD-A1183E39F262",
            "idioma": "es",
            "versionSO": "7.1.1",
            "modelo": "iPhone OS"
        },
        {
            "tipoDisp": 3,
            "idDispositivo": "6FBDA364-249A-4B97-A762-B0BA003D5051",
            "idioma": "es",
            "versionSO": "8.1.1",
            "modelo": "iPhone OS"
        },
        {
            "tipoDisp": 3,
            "idDispositivo": "C9CB268F-CD07-4696-9E89-3BE2E85D8A3E",
            "idioma": "es",
            "versionSO": "7.1.1",
             "modelo": "iPhone OS"
        }
    ]
}

Parámetros

Clave de la aplicación: identificador de la aplicación
Tipo: indica si la lista de dispositivos a buscar están registrados o no

  • Valores posibles
    1- Todos , 2- Anónimos, 3- Registrados
Control de errores:
  • Introducir una claveAplicacion inexistente.
  • Introducir un tipo inexistente.

 

Dispositivos por usuario

GET /2.0/application/getDevicesByUser/{claveAplicacion}/{idUsuario}/devices

Devuelve una lista con los dispositivos de un usuario activo existente para la aplicación introducida por parámetro.

Ejemplo de petición 
GET /octopus-rs/services/2.0/application/getDevicesByUser/1afd7ea2f688459699d2597f878f7860/usuarioDemo/devices HTTP/1.1
Content-Type: application/json
Ejemplo de respuesta
{
    "error": {
        "descripcion": "Todo correcto",
        "codError": "0"
    },
    "respuesta": [
        {
            "idUsuario": " usuarioDemo ",
            "tipoDisp": 2,
            "idDispositivo": "c0cf833a1e1cd222",
            "idioma": "es",
            "versionSO": "5.1.1",
            "modelo": "LGE Nexus 5"
        },
        {
            "idUsuario": " usuarioDemo ",
            "tipoDisp": 2,
            "idDispositivo": "581cbdb7cd83dfb5",
            "idioma": "es",
            "versionSO": "M",
            "modelo": "LGE Nexus 5"
        },
        {
            "idUsuario": " usuarioDemo ",
            "tipoDisp": 2,
            "idDispositivo": "c4009e68279fa1fd",
            "idioma": "es",
            "versionSO": "4.4.4",
            "modelo": "Samsung SM-G901F"
        }
    ]
}
Parámetros 

claveAplicacion: identificador de la aplicación.
idUsuario: identificador del usuario.

 

Control de errores
  • Introducir una claveAplicacion inexistente.

Usuarios por aplicación

 POST /2.0/application/ getAllUsers
Parámetros JSON

Aplicación: clave de la aplicación.
url: Web Service al que se dará Feedback de resultados. Debe ser asíncrono
fechaDesde: Fecha desde la que el usuario se instaló la app.

Devuelve una lista todos los usuarios de una aplicación que se han creado a partir de la fecha indicada. En caso de que los usuarios se hallan desinstalado indicará tal causa. Es importante resaltar que solo se tendrá éxito en caso de que el cliente  que llame al WS indique por parámetro en la url un WS válido para tratar la respuesta. Además, este WS es asíncrono y se ejecuta en segundo plano, por lo que la respuesta la dará al WS que se indique por parámetro.

Ejemplo de petición
 POST /2.0/application/ getAllUsers

{"claveAplicacion":"230f48bbbea249ecafc301d46ef99c29",
 "url":"http://localhost:8080/octopush-rs/services/2.0/application/pruebaFeedbackUsers",
 "fechaDesde":"12-11-2016"
}
 Ejemplo de respuesta
{
 "error": {
 "descripcion": "Todo correcto",
 "codError": "0"
 } 
}
Parametros

claveAplicacion: Identidicador de la aplicación.

url: Direccion web del servicio.

fechaDesde: Fecha de comienzo para realizar la petición.

Control de errores
  • Introducir una claveAplicacion inexistente.

Botones por aplicación

GET 2.0/application/getButtonsApplication/{claveAplicacionMovil}

 Devuelve una lista de todos los botones definidos en una aplicación.

Ejemplo de petición
GET /octopus-rs/services/2.0/application/getButtonsApplication/1afd7ea2f688459699d2597f878f7860 HTTP/1.1
Content-Type: application/json
 Ejemplo de respuesta
{
    "error": {
        "descripcion": "Todo correcto.    ",
        "codError": "0"
    },
    "respuesta": [
        {
            "id": 41,
            "aplicacion": null,
            "alias": "",
            "nombre": "",
            "descripcion": "",
            "fechaCreacion": 1457429724000,
            "idPrioridad": 1,
            "descPrioridad": "Prioridad 1",
            "uiname": "Accion"
        },
        {
            "id": 42,
            "aplicacion": null,
            "alias": "Boton44",
            "nombre": "Boton44",
            "descripcion": "",
            "fechaCreacion": 1457429984000,
            "idPrioridad": 1,
            "descPrioridad": "Prioridad 1",
            "uiname": "Accion"
        }
    ]
}
 Parámetros

claveAplicacionMovil: Clave de integración móvil

Control de errores
  • Introducir una clave de integración móvil inexistente
Api Aplication