1. ForoElectro.Net
2. Arduino Services
3. Documentación de la API de Datos

Documentación de la API de Datos

¿Qué es?

Este espacio ofrece una API sencilla para que tus proyectos de IoT guarden sus datos de manera sencilla.

Mediante una sencilla API podrás enviar tus datos y recogerlos, quedando guardados para cuando los necesites.

Se ha usado MongoDB para poder guardar cualquier dato (mientras pueda ponerse en JSON). Además, se ofrecen varios modos de funcionamiento para poder simplificar al máximo tus aplicaciones.

Dispones de un sistema de visualización de datos tabular. Está paginado, se puede filtrar y se puede ordenar por columnas.

¿Cómo se usa?

Primero has de crear una Aplicación. Para ello se requieren 2 campos: Nombre y email. Tras ello obtienes una ApiKey.

Tras ello puedes usar la API con tu ApiKey o identificarte en la web para visualizar los datos usando tu ApiKey y tu email.

Puedes crear tantas aplicaciones quieras con el mismo email, cada una tendrá una ApiKey diferente.

Puedes modificar tu email o el nombre de la Aplicación que tu ApiKey no cambiará.

Guardar datos:

URL:

http://www.foroelectro.net/arduino/api/<ApiKey>/store

Parámetros:

Todos los parámetros pueden ser pasados con cualquier método (GET, POST, etc).

• _femode - Opcional (por defecto 1).
  • 1 - Recoge (casi) todos los parámetros y los guarda en un registro. Elimina los parámetros _femode, _edit_row_id y ApiKey.
  • 2 - Procesa el parámetro data como un JSON y, si es correcto, lo guarda

Retorno:

Objeto JSON.

• result
  • status - false - incorrecto; true - correcto.
  • message - Cuando status = false, motivo del error.
• id - Cuando status = true, ID del nuevo registro.

Sobreescribir registro:

URL:

http://www.foroelectro.net/arduino/api/<ApiKey>/overwrite/<id_registro>

Parámetros:

Todos los parámetros pueden ser pasados con cualquier método (GET, POST, etc).

• _femode - Opcional (por defecto 1).
  • 1 - Recoge (casi) todos los parámetros y los guarda en un registro. Elimina los parámetros _femode, _edit_row_id y ApiKey.
  • 2 - Procesa el parámetro data como un JSON y, si es correcto, lo guarda

Retorno:

Objeto JSON.

• result
  • status - false - incorrecto; true - correcto.
  • message - Cuando status = false, motivo del error.
• id - Cuando status = true, ID del registro sobreescrito (debe ser el mismo que el id pasado en la llamada).

Obtener todos los datos:

URL:

http://www.foroelectro.net/arduino/api/<ApiKey>/getAll

Parámetros:

Ninguno.

Retorno:

Objeto JSON.

• result
  • status - false - incorrecto; true - correcto.
  • message - Cuando status = false, motivo del error.
• data - Cuando status = true, Array con todos los registros ordenados por fecha de guardado (store_date) en GMT.

Borrar registro(s):

URL:

http://www.foroelectro.net/arduino/api/<ApiKey>/remove

Parámetros:

Todos los parámetros pueden ser pasados con cualquier método (GET, POST, etc).

• id - Id o array de ids a borrar. Debe corresponder a tu aplicación (ApiKey de la URL).

Retorno:

Objeto JSON.

• result
  • status - false - incorrecto; true - correcto.
  • message - Cuando status = false, motivo del error.
• data - Cuando status = true, array de objetos de la forma {id: id, result: boolean}. Cada objeto indica el resultado del borrado para ese registro.