Saltar al contenido principal

Introducción al SDK

Tu Extensión necesita interactuar con todos los componentes que hay en la plataforma, como puede ser el menú lateral, el selector inferior de imágenes, avisos, modales, etc. Para cumplir con esta función proveemos un SDK para Javascript que te permitirá hacerlo.

En pocas palabras el SDK provee un mecanismo para que puedas realizar operaciones sobre la interfaz principal de la plataforma, ya sea su versión web como móvil. Por otra parte también envuelve (hace de Wrap) funciones de uso común de nuestras APIs, haciendo que llamarlas sea mucho más sencillo.

Incluir el SDK en tu código

Para incluir el SDK en tu código simplemente tienes que agregar el script público de aura-package en tu archivo HTML. Procura siempre utilizar la última versión disponible!

  <script src="https://auraview.auravant.com/sdk/v1.0/aura-package_v1.0.js"></script>

Variables globales

En el sdk, contamos con variables globales útiles para conocer el entorno de nuestra aplicación.

platform

  • platform: nos indica en qué dispositivo está corriendo nuestra aplicación, retorna "web", "android" o "ios" según corresponda.
  if(platform=='web') {
console.log("Corriendo extensión desde la plataforma web!")
}

token

  • token: nos provee un token en formato string, necesario para usar las APIs detalladas acá.
  fetch("https://api.auravant.com/api/getfields",{
headers:{
Authorization: "Bearer " + token
}
}).then(()=>{
console.log("Usando la api con mi token")
})

Organización de las funciones

Todas las funciones del SDK serán accesibles a través del namespace avt. Dentro de ese espacio hay distintos módulos y dentro de cada módulo encontrás las funciones. Por ejemplo si quisiéramos ejecutar la función 'hiAuravant()' del módulo 'test' debemos llamar a avt.test.hiAuravant()

Funciones sincrónicas y asincrónicas

Una nota importante antes de empezar. Dentro de las funciones disponibles veras que todas tienen una versión asincrónica (te darás cuenta dado que tienen 'async' en su nombre) como en algunos casos habrá disponible versiones sincrónicas. Es importante mencionar que recomendamos siempre usar las versiones asincrónicas que retornan una promesa.