Skip to main content

Veritran Docs

Crea o edita un SDK

Importante

Solo el equipo Mobile puede crear o editar un SDK. Si no tiene los permisos, no tendrá estas opciones disponibles. Ponte en contacto con el equipo de Mobile Builder para obtener ayuda.

Crea un SDK

Para crear un SDK en Mobile Builder, sigue estos pasos:

Mejores prácticas

Asegúrate de que la información proporcionada aquí coincida con la de la documentación del SDK.

Create_sdk.gif

  1. Ve a la página SDKs y haz clic en + Create.

  2. En el panel que se abre, escribe un nombre único para identificar el SDK. Para este ejemplo, escribe CallAPI Availability.

    Mejores prácticas

    No uses "lib" o "sdk" en el nombre, ya que está implícito. Si se trata de un SDK asociado a una call API, indícalo en el nombre, como en el ejemplo anterior.

  3. En el campo Description, introduce información relevante sobre el propósito del SDK (máx. 100 caracteres). Esta descripción se muestra en el panel Add SDK al agregar el SDK a una app. Para este ejemplo, escribe CallAPI Availability SDK verifies the existence of a call API or a specific call API function.

  4. A continuación, selecciona la plataforma o plataformas (iOS, Android o Harmony) para las que deseas crear el SDK. Para este ejemplo, selecciona las tres plataformas.

  5. Completa el campo Library con la librería del SDK creada en GIT. Se realiza una validación para comprobar que la librería exista en el repositorio de GIT. Para este ejemplo, escribe callapi_availability.

  6. Si el SDK tiene dependencias con otras integraciones, activa el interruptor y selecciona las dependencias para cada plataforma desde el menú desplegable correspondiente. Para este ejemplo, no hay dependencias.

  7. Por último, elige un estado para el SDK. Los estados disponibles son: Beta, que indica que el SDK aún está en desarrollo por parte del equipo Mobile y que su uso implica asumir los riesgos asociados, y Prod, que indica que el equipo Mobile ha completado el desarrollo del SDK. Para este ejemplo, eligeBeta.

    Nota

    Cuando agregas un SDK Beta a una app, se muestra un mensaje informativo para que los usuarios sepan que el SDK solo debe usarse con fines de prueba.

  8. Finalmente, si el SDK requiere de la configuración de parámetros específicos para integrarse a una app, debes definirlos en esta página. Para ello, sigue los pasos detallados a continuación:

    1. Haz clic en + Add parameter en la parte superior derecha de la página. Un panel se abre a la derecha de la pantalla.

    2. Selecciona un nombre para el campo a configurar. Por ejemplo, API ID.

    3. Selecciona un tipo de campo. Las opciones disponibles son: TextInput, TextArea, DropDown, DropDownMultiple y Toggle. Dependiendo de la opción seleccionada, deberás configurar lo siguiente:

      TextInput

      • Validación de Mail: Entrada de texto que valida el formato de correo electrónico.

      • Validación de URL: Entrada de texto que valida el formato de URL.

      • Validación custom: Campo adicional en el cual se agrega una expresión regular para validar el formato.

      TextArea

      • Validación de JSON: Entrada de texto que valida el formato JSON.

      • Validación de XML: Entrada de texto que valida el formato XML.

      • Validación custom: Campo adicional en el cual se agrega una expresión regular para validar el formato.

      DropDown

      • Label: Nombre de la opción que se mostrará en el menú selector.

      • Value: Valor referenciado por la opción definida en el campo Label.

      • + Add: Agrega la opción definida en los campos anteriores y muestra los campos vacíos para agregar una opción nueva.

      DropDownMultiple

      Requiere la configuración de los mismos campos que el DropDown, pero el usuario verá un multiselector al agregar el SDK.

      Toggle

      • True value: Valor mostrado cuando el interruptor se enciende, es decir, se configura como true.

      • False value: Valor mostrado cuando el interruptor se apaga, es decir, se configura como false.

      Para este ejemplo, selecciona TextInput y agrega la siguiente validación custom para definir las limitaciones de caracteres: ^[a-zA-Z0-9-_./]+$, que indica que solo se permiten letras de la a a la z minúsculas y mayúsculas, números del 0 al 9, guiones, guiones bajos, puntos, barras diagonales y símbolos de moneda.

    4. Si no quieres que el valor introducido por el usuario se muestre en la pantalla, enciende el interruptor Hide Value que aparece al definir el tipo de campo.

    5. Agrega un tooltip que describa brevemente el campo. El tooltip debe indicar al usuario que agrega el SDK cómo configurar el campo y si existe algún tipo de limitación. Asegúrate de que la información provista aquí coincida con la de la documentación del SDK. Para este ejemplo, ingresa API ID whose existence you want to validate..

    6. Agrega una key para ubicar el parámetro en el código mobile. El usuario solo necesita ingresar el nombre de la key ya que el campo agrega automáticamente el prefijo: "vtua.ini.lib". Por ejemplo, el usuario ingresa callapi_availability, pero el back-end envía vtua.ini.lib.callapi_availability.

    7. Selecciona la sección donde se mostrará el parámetro en el panel Add SDK: Global, si el parámetro aplica a todas las plataformas, o Android, iOS o Harmony. Para este ejemplo, selecciona Global.

    8. Selecciona un estado para el parámetro: required, si el parámetro es obligatorio, u optional, si no lo es. Para este ejemplo, selecciona optional.

    9. Una vez que haya configurado los campos necesarios, haz clic en Save para finalizar el proceso. El panel se cierra y el parámetro nuevo se visualiza en el listado de parámetros. Repite este proceso para cada parámetro. Una vez que se agrega cada parámetro, haz clic en el icono de lápiz para editarlo o en el icono de papelera para eliminarlo.

  9. Una vez que hayas configurado los campos necesarios y agregado los parámetros requeridos, haz clic en Add para finalizar el proceso de creación. Se te redirigirá a la página SDKs y aparecerá un mensaje que confirma que el SDK se ha creado correctamente. De forma predeterminada, los nuevos SDK aparecen como habilitados.

Edita un SDK

Para editar un SDK existente, busca el SDK en el listado y haz clic en el icono de lápiz a la derecha. Se abre el panel Edit SDK. Los campos de nombre y librería no se pueden editar. Una vez que hayas editado todos los campos necesarios, haz clic en Save para implementar los cambios. Se te redirigirá a la página SDKs y aparecerá un mensaje que confirma que el SDK se actualizó correctamente.

Nota

Una vez finalizado el desarrollo y las pruebas de un SDK, se debe modificar su estado de Beta a Prod desde este panel.

: