Api segments

API Segments

Gestiona el alta, modificación y consulta de las preferencias configuradas en los distintos dispositivos de cliente.

 Consultar por segmento

POST /2.0/segments/getSegment/{segmentId}

Devuelve el valor de una preferencia de un dispositivo móvil facilitando como parámetro en la url el segmento a mostrar.

Ejemplo de petición
POST /octopus-rs/services/2.0/segments/getSegment/EDAD HTTP/1.1
Content-Type: application/json
Ejemplo de JSON 
{
    "aplicacion":"1afd7ea2f688459699d2597f878f7860",
    "dispositivo":"c0cf833a1e1cd222"
}
Ejemplo de respuesta
{
    "error": {
        "descripcion": "Todo correcto",
        "codError": "0"
    },
    "respuesta": [
        {
            "segmentId": "EDAD",
            "name": "EDAD",
            "type": "NUM"
        }
    ]
}
Parámetros JSON

Aplicación: clave de la aplicación.
Dispositivo: identificador del dispositivo sobre el que se va a consultar el segmento.

Parámetros

segmentId: identificador del segmento.

Control de errores
  • No introducir la aplicación o introducir una aplicación inexistente
  • No introducir el identificador del dispositivo o introducir una identificador de dispositivo inexistente, introducir un identificador de dispositivo no perteneciente a esa aplicación
  • Introducir un segmento inexistente

 

Consultar por dispositivo

POST /2.0/segments/getSegments

Devuelve todas las preferencias de un dispositivo.

 

Ejemplo url de petición
POST /octopus-rs/services/2.0/segments/getSegments HTTP/1.1
 Content-Type: application/json
Ejemplo JSON
{
    "aplicacion":"1afd7ea2f688459699d2597f878f7860",
    "dispositivo":"c0cf833a1e1cd222"
}
Ejemplo de respuesta
{
    "segmentId": "EDAD",
    "name": "EDAD",
    "type": "NUM"
},
{
    "segmentId": "SABORES",
    "name": "SABORES",
    "type": "MUL",
    "options": [
        {
            "code": "FR",
            "name": "Fresa"
        },
        {
            "code": "CH",
            "name": "Chocolate"
        },
        {
            "code": "VA",
            "name": "Vainilla"
        },
        {
            "code": "PL",
            "name": "Plátano",
            "selected": true
        }
    ]
},
{
    "segmentId": "no_quie",
    "name": "Tipo SI/NO",
    "type": "LOG"
},
{
    "segmentId": "FECHA",
    "name": "Fecha",
    "type": "FEC"
}
Parámetros JSON

Aplicación: clave de la aplicación.
Dispositivo: identificador del dispositivo sobre el que se va a consultar el segmento.

Control de errores
  • No introducir la aplicación o introducir una aplicación inexistente.
  • No introducir el identificador del dispositivo o introducir una identificador de dispositivo inexistente, introducir un identificador de dispositivo no perteneciente a esa aplicación.

 

Actualizar

POST /2.0/segments/updateSegments

Actualiza las preferencias de un dispositivo móvil en el sistema de Octopus. Si el dispositivo lleva identificador de usuario, se actualizarán las preferencias de demás dispositivos del mismo usuario y para la misma aplicación.

 

Ejemplo de petición
POST /octopus-rs/services/2.0/segments/updateSegments HTTP/1.1
Content-Type: application/json
Ejemplo JSON 1
{
    "aplicacion":"1afd7ea2f688459699d2597f878f7860",
    "dispositivo":"c0cf833a1e1cd222",
    "segments":[
        {
            "segmentId":"EDAD",
            "numericValue":23.5
        }
    ]
}
Ejemplo de respuesta JSON 1
{
 "error": {
 "descripcion": "Todo correcto",
 "codError": "0"
 },
 "respuesta": [
 {
 "segmentId": "EDAD",
 "name": "EDAD",
 "type": "NUM",
 "numericValue": 23.5
 }
 ]
}
Ejemplo JSON 2
{
    "aplicacion":"1afd7ea2f688459699d2597f878f7860",
    "dispositivo":"c0cf833a1e1cd222",
    "segments":[
        {
            "segmentId":"SABORES",
            "options":[
                {
                    "code":"PL",
                    "selected":true
                }
            ]
        }
    ]
}
Ejemplo de respuesta JSON 2
{
    "error": {
        "descripcion": "Todo correcto",
        "codError": "0"
    },
    "respuesta": [
        {
            "segmentId": "SABORES",
            "name": "SABORES",
            "type": "MUL",
            "options": [
                {
                    "code": "FR",
                    "name": "Fresa"
                },
                {
                    "code": "CH",
                    "name": "Chocolate"
                },
                {
                    "code": "VA",
                    "name": "Vainilla"
                },
                {
                    "code": "PL",
                    "name": "Plátano",
                    "selected": true
                }
            ]
        }
    ]
}
Parámetros JSON

Aplicación: clave de la aplicación
Dispositivo: identificador del dispositivo sobre el que se va a consultar el segmento
segments: Lista de objetos RegistroPreferenciaDispositivoDTO.

  • Parámetros necesarios
    • segmentId: nombre de segmento
    • numericValue: valor numérico que se le asignará al segmentId de ese dispositivo.
    • textValue: texto que se le asignará al segmentId de ese dispositivo.
    • dateValue: fecha que se le asignará al segmentId de ese dispositivo.
    • boolValue: valor booleano que se le asignará al segmentId de ese dispositivo.
    • options: Lista de objetos OptionDTO.
      • Parámetros necesarios:
        • Code: Código del dato tipificado a actualizar (debe conocerlo el desarrollador).
        • Selected: parámetro booleano que indica si está seleccionado en ese dispositivo.
Control de errores
  • No introducir la aplicación o introducir una aplicación inexistente.
  • No introducir el identificador del dispositivo o introducir una identificador de dispositivo inexistente, introducir un identificador de dispositivo no perteneciente a esa aplicación.
  • Introducir un valor de parámetro que no coincide con su tipo.

 

Asignar 

POST /2.0/segments/setSegments

Registra las preferencias de un dispositivo móvil en el sistema de Octopus. Si el dispositivo lleva identificador de usuario, se actualizarán las preferencias de los demás dispositivos del mismo usuario y para la misma aplicación.

 

Ejemplo de petición
POST /octopus-rs/services/2.0/segments/setSegments HTTP/1.1
Content-Type: application/json
Ejemplo JSON
{
    "aplicacion":"1afd7ea2f688459699d2597f878f7860",
    "dispositivo":"c0cf833a1e1cd222",
    "segments": [
        {
            "segmentId":"EDAD",
            "numericValue":23.5
        },
        {
            "segmentId":"FECHA",
            "dateValue":"22/07/1985"
        }, 
        {
            "segmentId":"SABORES",
            "options": [
                {
                    "code":"VA" ,
                    "selected":true 
                }
            ]
        }
    ]
}
Ejemplo de respuesta
{
    "error": {
        "descripcion": "Todo correcto",
        "codError": "0"
    },
    "respuesta": [
        {
            "segmentId": "EDAD",
            "name": "EDAD",
            "type": "NUM",
            "numericValue": 23.5
    	},
		{
            "segmentId": "SABORES",
            "name": " SABORES ",
            "type": "MUL",
            "options": [
                {
                    "code": "FR",
                    "name": "Fresa"
                },
                {
                    "code": "CH",
                    "name": "Chocolate"
                },
                {
                    "code": "VA",
                    "name": "Vainilla",
                    "selected": true
                },
                {
                    "code": "PL",
                    "name": "Plátano",
                    "selected": true
                }
            ]
        },
        {
            "segmentId": "FECHA",
            "name": "Fecha",
            "type": "FEC",
            "dateValue": "22/07/1985"
        }
	]
}
Parámetros JSON

Aplicación: clave de la aplicación.
Dispositivo: identificador del dispositivo sobre el que se va a consultar el segmento.
segments: Lista de objetos RegistroPreferenciaDispositivoDTO.

  • Parámetros necesarios
    • segmentId: nombre de segmento.
    • numericValue: valor numérico que se le asignará al segmentId de ese dispositivo.
    • textValue: texto que se le asignará al segmentId de ese dispositivo.
    • dateValue: fecha que se le asignará al segmentId de ese dispositivo.
    • boolValue: valor booleano que se le asignará al segmentId de ese dispositivo.
    • options: Lista de objetos OptionDTO.
      • Parámetros necesarios:
        • Code: Código del dato tipificado a actualizar (debe conocerlo el desarrollador).
        • Selected: parámetro booleano que indica si está seleccionado en ese dispositivo.
Control de errores
  • No introducir la aplicación o introducir una aplicación inexistente.
  • No introducir el identificador del dispositivo o introducir una identificador de dispositivo inexistente, introducir un identificador de dispositivo no perteneciente a esa aplicación.
  • Introducir un valor de parámetro que no coincide con su tipo.
Api segments