Scripts

This API let you combine yours scripts with social networks or services in Botize.


How it functions

Los scripts se ejecutan cuando sucede un evento, por ejemplo un nuevo follower, una mención en Twitter, una determinada fecha, cada cierto número de horas, etc.

Para ello solo es necesario indicar en el panel de control de Botize la opción "Ejecutar un script" e indicar la URL donde este se encuentre alojado.

How it functions


Parameters to be sent when sending requests to script

Junto con cada llamada que Botize realiza al script se facilita por método POST una serie de parámetros cuya utilidad dependerá de las necesidades del programador.

Los parámetros enviados son:

  • account (string)
    Indica el nombre de la cuenta de Botize que está llamado al script.

  • id_action (integer)
    Indica el Id de la tarea.

  • task (JSON)
    Estructura completa de la tarea definida en el panel de control de Botize.

  • botize (JSON)
    Información obtenida del evento que ha accionado la tarea (trigger). Es el parámetro de más utilidad, pues contiene toda la información obtenida del trigger.

  • status (string)
    El estado del script la última vez que se ejecutó.


Receiving a response from server

El script debe finalizar respondiendo con una cadena JSON. Esta será capturada por Botize y enviada al action indicado en la tarea.

La cadena JSON debe seguir la siguiente estructura:

{
   "meta":{
      "code":"200",
      "error_message":""
   },
   "data":{
      "object":"Car",
      "color":"Red",
      "status":"last update 2015-01-01 00:00:00"
   },
   
}
  • code
    "200" si el script ha concluido satisfactoriamente. En caso contrario puede indicarse un valor entre 201 y 300 para indicar a Botize que ha sucedido un error.

  • error_message
    Mensaje de error para mostrar al usuario si fuese necesario.

  • data
    Conjunto valores que opcionalmente el script devuelve a Botize. Estos valores podrán ser usados en el siguiente paso (Action) indicado de la tarea.

  • status
    Cadena de texto para uso exclusivo del propio script. Botize no realizará ninguna operación con el contenido indicado en status, sin embargo en la próxima ejecución que Botize realice del script, enviará el contenido aquí indicado al script por POST en la variable status.

    El objetivo por lo tanto de status es servir de contenedor para que el script pueda almacenar variables y cadenas para su propio uso y funcionamiento.

Ejemplo de uso »