API Octopush

API Octopush 

Octopush ofrece un completo API de servicios web para trabajar con las distintas capacidades que ofrece la plataforma.

La definición de servicios que se expone en esta documentación es válida para la versión 1.8.x de la plataforma Octopush. La versión actual de la plataforma se puede consultar en el pie de cualquier página de la consola de Octopush.

 

API Rest

Peticiones

Las peticiones contra el API de Octopush se implementan como operaciones HTTP. En las funcionalidades de consulta se utilizarán operaciones HTTP GET y en las de envío de notificaciones HTTP POST.

En las siguientes secciones, se especificará el tipo de petición y URL de cada una de las funcionalidades del API. De manera general, en las peticiones contra el API de Octopush es necesario tener en cuenta los siguientes aspectos:

  • La URL base de los servicios de Octopush será distinta según estemos atacando al entorno de test, en cuyo caso será https://test.octopush.me/octopus-rs/services/; o al de producción, en el que será https://octopush.me/octopus-rs/services/.
  • La securización de las peticiones se realizará por medio de la clave de aplicación. Ésta es una clave única que permite identificar la aplicación con la que se desea trabajar en el API. Si se envía una petición sin clave de aplicación o con una no válida, el API devolverá un mensaje de error explicando tal circunstancia. La clave de aplicación se muestra en la cabecera de la consola de octopush una vez dentro de la configuración de la propia aplicación.

 

inicio1

  • De manera general, el formato de las fechas que se intercambien con el API de servicios será siempre “dd-MM-yyyy”, donde “dd” es el día del mes, “MM” es el número del mes y “yyyy” es el año. Por ejemplo, una fecha con formato válido sería 16-05-2015. Si se requiere que la fecha informada incluya horas y minutos el formato a utilizar será: “dd-MM-yyyy HH24-mm”, donde “HH24” es la hora en formato 24 horas y “mm” son los minutos. Por ejemplo, una fecha con horas y minutos con formato válido sería 16-05-2015 16:45.

 

Respuestas

Las respuestas del API de servicios de Octopush serán, de manera general, una respuesta HTTP con código “200 OK” y con un contenido compuesto por un objeto JSON con la siguiente estructura:

{
	“error”: {
		“descripcion”: “Mensaje”,
		“codError”: “0”
	},
	“respuesta” : [
		{
			ObjetoJSON
		}
	]
}

 

Donde los atributos del código JSON son los siguientes:

  • error: Objeto JSON con el resultado de la operación.
  • descripcion: Mensaje descriptivo del resultado de la operación.
  • codError: Código numérico del resultado de la operación. El valor 0 indica que la operación se ha completado satisfactoriamente.
  • respuesta: Listado de objetos JSON con los datos que devuelve la plataforma como resultado de la operación ejecutada. El formato de estos objetos será especificado en las próximas secciones para cada una de las operaciones de la plataforma.

Además de este tipo de respuesta, y ante situaciones concretas, la plataforma puede devolver otros códigos de respuesta HTTP. En concreto:

  • HTTP 404. Cuando la URL del servicio al que se intenta acceder no está definida. En tal caso, es posible que el código de integración no esté montando adecuadamente la URL de llamada al servicio web.
  • HTTP 500. Cuando se produce un error no controlado en la plataforma Octopush. En tal caso, lo ideal es ponerse en contacto con nosotros a través de soporte@octopush.me describiendo de la forma más detallada posible la operativa que ha llevado al error. Nuestro equipo de soporte atenderá la petición a la mayor brevedad posible.

 

API Octopush