Cliente MQTT - Foro Electrónica

API MQTT de ForoElectro.Net

API para publicar un mensaje MQTT:

URL:

https://www.foroelectro.net/arduino/api/<ApiKey>/mqtt/publish

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

Parámetros:

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

• message - Mensaje a enviar.
• client - Opcional. Nombre del cliente. Por defecto es ForoElectroNetAPI
• topic - Opcional. Extra del nombre del topic (recuerda que tu ApiKey es el prefijo de cualquier topic)
• f - Opcional. Formato de salida. Si añades f=json la respuesta se dará en JSON; en cualquier otro caso se dará en texto.

Retorno:

Modo texto:

• 1 - Todo ha funcionado correctamente.
• 0|<error> - Error. Tras el símbolo '|' hay una breve descripción.

Modo JSON:

{

• "result": 1 si todo ha funcionado correctamente, 0 si hay error
• "error": Sólo existe si el resultado es 0; breve descripción del error.

}

API para revisar mensajes MQTT:

URL:

https://www.foroelectro.net/arduino/api/<ApiKey>/mqtt/get

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

Parámetros:

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

• wait - Opcional. Segundos de espera de la llamada si no hay mensajes.
• last - Opcional. Id numérica del último mensaje ya leido.

Retorno:

El formato de salida es siempre JSON:

{

• "result": 1 si todo ha funcionado correctamente, 0 si hay error
• "error": Sólo existe si el resultado es 0; breve descripción del error.
• "data": Sólo existe si el resultado es 1; Array de mensajes: [
  • {
  • • "utime": UNIX timestamp del mensaje.
    • "payload": Mensaje.
    • "topic": Topic completo del mensaje.
  • }
  }

}

Antes de usar la API MQTT:

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

¿Cómo obtener una ApiKey?

Para crear tu ApiKey se requieren 2 campos: Nombre y email.

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á.