APIs
Las APIs convierten a ZetaSoftware en una plataforma sobre la que otros desarrolladores de software podrán construir soluciones profesionales, extendiendo las funcionalidades del producto y resolviendo necesidades puntuales de los usuarios.
¿Qué es una API?
Una API es un conjunto de tecnologías que permite compartir datos entre aplicaciones o programas, evitando la necesidad de tener que importar o exportar información en forma manual. Las APIs de ZetaSoftware disponibilizan ciertos datos de las empresas de manera que, utilizando el desarrollo de programas o aplicaciones de terceros, se pueda agregar, consultar y visualizar datos a las mismas. Estos servicios web quedan disponibles en diferentes direcciones (URL) a las que se deberá acceder para utilizarlos.
Por parte de ZetaSoftware se genera la publicación de esta URL y se permite interactuar con el sistema, ya sea importando datos desde otros programas o exportando datos hacia los mismos. La integración de datos entre la empresa en ZetaSoftware y programas o aplicaciones de terceros corresponde exclusivamente al cliente, quien deberá contactar con técnicos o empresas con conocimientos para la programación, implementación y consumo de los Web Services o APIs.
Las APIs solo estarán disponibles para empresas que utilicen el módulo Gestión y Contabilidad.
Datos de Conexión
Para que la integración sea posible, tanto la Empresa como el Desarrollador dispondrán de credenciales (Código y Contraseña) de acceso.
Datos proporcionados por ZetaSoftware al Desarrollador:
Credenciales del Desarrollador
Las credenciales del Desarrollador se solicitarán a ZetaSoftware.
ZetaSoftware enviará al desarrollador su Código (DesarrolladorCodigo) y su contraseña (DesarrolladorClave).
Tanto el Código como la Contraseña serán únicos por Desarrollador, servirán para identificarse cada vez que utilizan las APIs (sin importar la empresa cliente), y no serán modificados a no ser que el Desarrollador lo solicite.
Datos proporcionados por la Empresa al Desarrollador:
Credenciales de la Empresa
El código de la empresa (EmpresaCodigo) será único, no así la contraseña (EmpresaClave) de acceso a las APIs, que será generada para cada Desarrollador/Empresa, tal como se explica a continuación.
Rol de Usuario
El Desarrollador deberá conocer además con que Rol de Usuario se conecta para poder trabajar con las APIs.
El usuario (RolCodigo) deberá ser informado por la empresa que contrató al Desarrollador.
Podrá ser cualquier código de los roles ya existentes en Configuración > Roles de Usuario, o bien un nuevo rol creado específicamente para el Desarrollador.
El sistema de conexión con las APIs solo validará la existencia del código de rol enviado por el Desarrollador al momento de conectarse con las APIs.
Habilitar las APIs al Desarrollador
Para poder utilizar las APIs, la empresa que contrató al Desarrollador generará las credenciales de integración. Para ello el usuario Administrador ingresará a Configuración > APIs y en el campo indicado deberá escribir el código del Desarrollador; proporcionado por el mismo Desarrollador.
Al pulsar Agregar y confirmar la acción con la opción Sí, se creará el registro con las credenciales. El dato relevante es la Clave de Conexión, la que será enviada vía email al Desarrollador y al usuario comunicando que se ha dado acceso a la empresa.
Observe que el usuario podrá en cualquier momento Desvincular (eliminar) al Desarrollador de la empresa, inactivarlo o volverlo a activar, como también cambiarle la Clave de Conexión.
Desde esta grilla podrá también ver la fecha y hora de la última vez que el Desarrollador ejecutó alguna API con los datos de la empresa.
El email enviado al Desarrollador tendrá el formato mostrado en la imagen. Irá una copia al usuario que vinculó al desarrollador con las APIs de la empresa.
Si se Cambia la Clave se debe notificar al Desarrollador, ya que no se le vuelve a enviar un email en forma automática.
Documentación
La documentación que se presenta a continuación contiene información relevante, tanto para le empresa (cliente de ZetaSoftware), como para el Desarrollador.
Por un lado, la Empresa podrá comprender la operativa de integración y su participación durante la implementación. Por otro, el Desarrollador tendrá a disposición el material técnico-descriptivo sobre cada API.