Documentación para el servicio de API REST.

Estructura General.

Última actualización 18 Enero 2018.

Tramitador: Persona que realiza la acción de tomar fotografías y notas dentro la aplicación móvil, este usuario es general ya que puede ver y aceptar todos los previos generados por el usuario del sistema web.
El tramitador es el encargado de subir las imágenes y la descripción a todas las partidas de un determinado contenedor.
Estado: Indica si el tramitador en cuestión está activado o no, en caso de no estar activado no se aceptarán acciones dentro del sistema, además de que no podrá acceder a la aplicación móvil.

Usuario: Persona que realiza la acción de precarga en cuanto a la información que se le mostrará al tramitador dentro de la aplicación móvil.
Usuario encargado de crear el contenedor para que el tramitador pueda subir la información.
Estado: Indica si el usuario en cuestión está activado o no, en caso de no estar activado no se aceptarán acciones dentro del sistema, además de que no podrá acceder a la aplicación web. Tipo: Indica si es Ejecutivo o Administrador.

Cliente: Organización vinculada a uno o más usuarios dentro de la plataforma, es decir, un cliente sólo puede ser accedido para determinados usuarios.

Contenedor: Entidad donde se pueden crear y capturar las partidas de la factura incluyendo número de partes y descripción.
Estado:

  • Pendiente: El contenedor está pre-cargado y es enviado a la aplicación móvil, esperando a que un tramitador lo acepte, durante este estado se puede editar la información del contenedor.
  • Aceptado: El contenedor es aceptado por el tramitador para realizar el previo, durante este estado, ningún otro tramitador puede aceptar el contenedor, además de que el ejecutivo o tramitador, no puede modificar la información del mismo.
  • Enviado: Es cuando se finaliza la captura de fotografías dentro de cada partida del contenedor y es enviado para su clasificación
  • Terminado: Todas las partidas dentro del contenedor han sido clasificadas con éxito

  • Partida: Campo en el cual se incluye número de parte, descripción y fotografía de la mercancía.
    Tipo:
  • No encontrado: Indica que el tramitador no ha encontrado la partida dentro del contenedor.
  • Encontrado: Indica que el tramitador ha encontrado la partida dentro del contenedor. Agregado: Indica que el tramitador ha encontrado esta partida dentro del contenedor y la ha agregado.
  • Estado:
  • Pendiente: Indica que la partida no ha sido clasificada.
  • Clasificado: Indica que la partida ya ha sido clasificada pero que no se ha especificado un resultado.
  • Terminado: Es cuando la partida ha sido clasificada y se ha especificado el resultado correcto.


  • Clasificación: Entidad que realiza una transacción en el núcleo de clasificación para poder convertir la partida en una fracción arancelaria posible a nivel de subpartida.

    Fracción: Con los resultados obtenidos de la clasificación se puede consultar toda la información de la fracción arancelaria.

    Tipos de usuarios dentro del sistema web.

    Dentro de la aplicación web existen tres tipos de usuarios que realizan actividades diferentes de acuerdo a cada rol.

    Administrador: Usuario que cuenta con todos los permisos dentro del sistema también puede referir al gerente general de la agencia aduanal, comercializadora o empresas de importación. Este usuario tiene permitido visualizar métricas de productividad, además de crear otro tipo de usuario, crear previos y clasificar partidas.

    Clasificador: Usuario con los permisos para poder crear otros ejecutivos y clasificadores, clientes y contenedores, también cuenta con las credenciales que le permiten realizar la clasificación de mercancía al igual que la asignación de clientes a cada uno de los clasificadores.

    Ejecutivo: Usuario con los permisos de crear nuevos contenedores de acuerdo al cliente asignado por el administrador o clasificador, realizar clasificaciones y visualizar los reportes de dicho contenedores.