¿Cómo usar API Cliente de Android?

Owned by DevPortal Editor (Unlicensed)
Last updated: 10/03/22 by Onesait Platform
3 min read

Introducción 

La primera versión de la API de Android para la plataforma onesait está disponible para los desarrolladores de móviles. Esta API da a los desarrolladores para móviles las capacidades de la plataforma al permitirles insertar datos de sus aplicaciones en la plataforma.

En esta versión hemos implementado tres operaciones sobre la plataforma, todas ellas usando comunicación REST:

  • JOIN: Esta operación permite al dispositivo obtener una sesión en la plataforma. Resulta necesario para realizar una inserción con la siguiente operación. La salida de esta operación es una sessionKey.

  • INSERT: Esta operación permite la inserción en una Ontología. Se necesita una sessionKey y una instancia válida de Ontología para realizar esta operación.

  • LEAVE: Esta operación cierra la sesión actual.

Uso

Para poder utilizar la API, es necesario añadir estas líneas al fichero build.gradle de Android Studio: La primera dentro de la sección de repositories y la segunda dentro de dependencies

  • maven{ url "http://nexus.onesaitplatform.com/nexus/content/repositories/releases/"}
  • compile 'com.minsait.onesait.platform:onesaitplatform-android-client:1.0.0'

Después de la sincronización de Gradle, puedes usar la clase RestClient para comunicarte con la plataforma:

El constructor requiere tener un Cliente Digital válido (clientPlatform) registrado en la plataforma, y su token asociado. El Cliente Digital es la interfaz cliente de la plataforma, que sirve como punto de entrada al sistema y a las ontologías seleccionadas para los dispositivos permitidos. Para llegar a la página del Cliente, sólo hay que navegar hasta:

Dentro del menú de creación, debes darle un nombre a tu cliente y añadir las ontologías a las que quieres acceder a través del cliente. Se generará un token, y ése es el token que la API necesita para acceder a la plataforma:



Si quieres insertar datos en una Ontología, tendrás que crear una y asociarla a tu IoTClient, que has creado recientemente.

Una vez que los elementos de la plataforma estén listos, puedes ir a Android Studio y empezar a desarrollar tu aplicación. Lo primero que necesitarás hacer es instanciar los parámetros necesarios para crear tu instancia RestClient:

Y entonces puedes instanciar el objeto RestClient:



Una vez que esto está hecho, es bastante sencillo implementar cualquiera de las tres operaciones definidas. Por ejemplo, con este simple y breve código, estarás realizando un JOIN y un INSERT en sólo tres líneas:

Para insertar, es necesario proporcionar una instancia de ontología en forma de String y que se ajuste a la plantilla. La mayoría de los marcos comunes de JSON, como GSON y Jackson, permiten una fácil composición y encadenamiento de objetos, pero para este ejemplo, construye un String personalizado como éste:



Éste se ajusta al esquema original JSON de la instancia de Ontología :

{"androidIoTFrame":{ "geometry":{"type":"Point", "coordinates":[9,19.3]},"email":"string","accelX":28.6,"accelY":28.6,"accelZ":28.6,"event":true}}

Si tienes algún problema con la API, por favor háznoslo saber en support@onesaitplatform.com.