API significa Interfaz de programación de aplicaciones. Cualquier software con una función específica se denomina aplicación cuando se habla de API. Puede comparar la interfaz API con un acuerdo de servicio entre dos programas que especifican solicitudes y respuestas. Si es nuevo en las API, le recomendamos que consulte nuestro Guía para principiantes de API y Descripción general de las API REST blog antes de leer este.
API REST le permite acceder a los datos de CRM a través del protocolo HTTP/HTTPS. Puede realizar acciones como crear, actualizar, recuperar o eliminar operaciones en cualquier información de registro de CRM. También le permitirá almacenar datos de configuración específicos de la extensión y del usuario o conectarse a aplicaciones externas utilizando los datos almacenados específicos de la extensión. A todos estos datos se puede acceder mediante autorización básica, es decir, mediante el nombre de usuario y la clave de acceso.
Creación de una API REST
Los siguientes son los cinco pasos generales que puede usar para construir cualquier API:
- Planifica la API: Las pautas para diseñar su API las proporcionan las especificaciones de API como OpenAPI. Es preferible considerar varios casos de uso de antemano y asegurarse de que la API cumpla con los estándares actuales de desarrollo de API.
- Cree la API: Los diseñadores de API crean prototipos de nuevas API con pocas modificaciones a las API existentes. Los desarrolladores pueden adaptar el prototipo a los requisitos internos después de que se haya sometido a pruebas.
- Probar la API: Similar a las pruebas de software, las pruebas de API son necesarias para protegerse contra errores y fallas. Pruebe la resistencia de la API contra ataques en línea utilizando herramientas para pruebas de API.
- Documentar la API: Aunque las API se explican por sí mismas, la documentación puede ayudar a los usuarios más fácilmente. En una arquitectura orientada a servicios, se utilizan con mayor frecuencia API bien documentadas con varias funciones y casos de uso. Escriba un documento de ayuda para orientar y ayudar a otros a crear sus API.
- Comercializar la API: Hay mercados en línea donde los desarrolladores pueden comprar y vender API a otros, al igual que los productos minoristas en eBay, Amazon y Flipkart. Puede ganar dinero con su API si la incluye.
Este blog le enseñará cómo crear un comando de API REST personalizado utilizando el diseñador de API de Vtiger. Entonces empecemos.
¿Qué es un diseñador de API?
El diseñador de API es una herramienta o una aplicación que los desarrolladores pueden usar para crear API de servicios web personalizadas. Puede definir sus puntos finales de servicio personalizados y parámetros de consulta. Estas API se pueden usar para interactuar con los datos de CRM, integrarse con aplicaciones externas y también exponer estos datos a las API de Javascript de VTAP para usarlas en páginas personalizadas o widgets en la interfaz de usuario de Vtiger.
Puede crear API utilizando el lenguaje de diseño de aplicaciones Vtiger (VADL), que se basa libremente en la sintaxis XML. El VADL permite a los administradores o desarrolladores sin habilidades de programación de alto nivel definir API fácilmente, pero con una comprensión básica de la programación, puede crear API efectivas rápidamente.
Las API REST siguen el protocolo API REST estándar y puede definir sus puntos finales de la siguiente manera:
| https://instance.odx.vtiger.com/restapi/vtap/api/YOUR_CUSTOM_API_PATH |
|---|
Para la API REST, se admiten los siguientes métodos de solicitud HTTP:
- PUBLICAR
- PUT
- BORRAR
Veamos cómo puede usar VTAP para crear su API REST personalizada.
Los usuarios de Vtiger CRM pueden crear API REST que conectarán el CRM a otras aplicaciones de terceros o crear otras nuevas que amplíen la funcionalidad del CRM. Aquí hay un ejemplo:
Vamos a crear una API REST que pueda acceder a datos de especifico módulo utilizando el VTAP.
A continuación se muestra un ejemplo de la API que recupera datos desde el módulo de CRM llamado Organizaciones para mostrar las cinco organizaciones principales con los ingresos anuales más altos con un nombre de API como principales_organizaciones. Puede ir con un nombre diferente para mantenerlo único.
Antes de comenzar, comprendamos los componentes XML y VDAL que se utilizarán para definir las acciones del ejemplo de API anterior.
La siguiente tabla describe los componentes XML y VDAL que se usarán para definir la API REST personalizada para acceder y mostrar datos de CRM:
| Componente XML y VDAL | la columna Acción |
|---|---|
| método api = "obtener" | Definición del método de solicitud HTTP |
| seleccione módulo = "Cuentas" | Defina el módulo para recuperar datos del uso selecciona |
| grabar nombre del campo=”nombre de la cuenta”> | Defina los campos en el registro para recuperar datos usando grabar |
| sort nombre del campo = "ingresos_anuales" pedido = "descendente" /campo /clasificar |
Defina las condiciones para el resultado de la tabla usando sort |
| límite max=”5″ página=”@página” /límite | Defina el número de detalles de registro que se mostrarán usando límitar |
| /Seleccione /api |
Termine cerrando todas las etiquetas abiertas. |
Note que todos los componentes XML y VDAL de la tabla anterior se incluyan con etiquetas (<>).
Siga estos pasos para construir la API REST discutida anteriormente:
- Inicie sesión en su cuenta Vtiger CRM.
- Haga clic en el Menú principal.
- Haga Clic en Productos.
- Seleccione Diseñador de API.
- Haga Clic en +Añadir API.
- Haga Clic en Crear junto a la API REST. Se abre la ventana Añadir API REST.
- Añadir API REST: Ingrese o seleccione información para lo siguiente:
- Módulo: seleccione el módulo de CRM desde el que se debe acceder a los datos.
- Nombre: Ingrese un identificador único para la API.
- Estado: Haga clic en la casilla de verificación para activar la API.
- Haga Clic en Guardar.
- Después de agregar la API, verá un IDE integrado en el que utilizará VADL para definir API y nodos XML para recuperar datos de CRM. Consulte la tabla anterior para comprender los componentes XML y VADL.
- Haga Clic en Guardar y publicar para publicar la API construida.
Puede acceder y probar la API REST anterior desde cualquier aplicación externa utilizando la siguiente URL.
| https://instance.odx.vtiger.com/restapi/vtap/api/top_organizations |
|---|
Note que la URL anterior es un ejemplo, y tendrá que definir el punto final según su instancia de CRM.
¿Sabía usted qué…?
Los datos anteriores pueden usarse para mostrarse como una lista en una página personalizada o usarse para un gráfico de barras y otros resultados dinámicos usando componentes de JavaScript para definir sus API. También se puede acceder a todas las API REST personalizadas integradas en API Designer mediante API de VTAP Javascript.
Para obtener más información sobre la creación de API personalizadas y VTAP, consulte Documentación VTAP.
