Ir al contenido
Inicio » Introducción a VTAP API Designer - Parte 2

Introducción a VTAP API Designer - Parte 2

Anteriormente, en nuestra serie de blogs Vtiger Application Platform (VTAP), discutimos cómo personalizar la interfaz de Vtiger e incorporar botones y widgets personalizados para satisfacer las necesidades comerciales específicas. Esta es solo una de las capacidades que ofrece la plataforma.

VTAP le brinda muchas funciones de este tipo que le ayudan a:

  • Cree una API REST personalizada
  • Conéctese a otras aplicaciones que tengan API REST disponible
  • Conectarse a aplicaciones habilitadas para OAuth

En este blog, discutiré cómo podemos crear una API REST personalizada.
Primero, déjame hablar un poco sobre las API REST de Vtiger. Se puede acceder a él con el siguiente punto final, que será específico para su instancia de CRM.

Por ejemplo,https://your_instance.odx.vtiger.com/restapi/v1/vtiger/default

Si conoce el Vtiger API de descanso, luego puede omitir la sección a continuación. Para conocer los módulos accesibles, puede utilizar el tipos de lista API.

Aquí hay una captura de pantalla de cómo puede acceder a la API utilizando el cliente de cartero.

API de listtypes

Vtiger ya proporciona un conjunto estándar de API, pero con la nueva herramienta API Designer, ahora puede escribir sus propias API REST personalizadas.

Diseñador de API

API Designer proporciona un entorno de trabajo para que los desarrolladores desarrollen API basadas en HTTP que se pueden exponer a las API de VTAP Javascript o la aplicación externa para una fácil integración. Las API se pueden definir usando VADL especificaciones.
El acceso a la API necesita la autorización del usuario y sigue la configuración estándar de acceso a registros realizada dentro del CRM.
API Designer proporciona IDE para escribir API personalizadas. Si escribe una API REST personalizada para un módulo en particular, debe nombrar la API y seleccionar el módulo.

Sub-imagen-2

Hemos definido Vtiger Application Definition Language (VADL), que se basa en la sintaxis XML para permitir a los administradores o desarrolladores novatos definir API sin experiencia en programación.

VADL Te permite:

  • Definir CURD
    • API (crear, actualizar, recuperar, eliminar) en módulos de entidad
    • Invocar el punto final basado en HTTP (REST / SOAP) a través de los métodos (GET / POST / PUT / DELETE)
      • Con autenticación (básica / basada en token de portador)
    • Acepta los parámetros de solicitud y enlaza como entradas de API

Tomemos un ejemplo de creación de una API REST personalizada que buscará contactos que coincidan con el dominio de correo electrónico. Agregaremos una nueva API con el nombre 'fetch_email_contact' y seleccionaremos el módulo Contactos

Código-sub-imagen-1

Todas las definiciones se colocan dentro de un API nodo con tipo HTTP estándar (obtener, publicar, colocar y eliminar). Dado que estamos obteniendo datos de CRM, usaremos seleccionar nodos y pasar los nombres de los módulos. Tendremos campos que deben buscarse dentro del nodo de registros y cualquier condición de filtro dentro del donde nodo. Apoyamos diferentes tipos de condiciones como igual, no igual, como, mayor que, menor que, etc.

Arriba hay un ejemplo simple, que también se puede lograr utilizando el pregunta API REST El poder real se hace evidente cuando combina varias API en una.

Considere este ejemplo. Actualiza un registro si existe o crea uno si no existe. Si usa una API existente, necesitará varias llamadas para realizar estas operaciones. Pero cuando usa API Designer, puede combinar estas operaciones en una sola llamada API.

Código-sub-imagen-2

En el ejemplo anterior, colocamos la definición dentro del reafirmar nodo. Esto comprende el actualización y Para crear nodo, que actualizará un registro si existe o creará un registro si no existe. Para identificar el registro que debe actualizarse, puede utilizar dónde filtrar y encontrar entradas relevantes. Al final de la definición, el nodo de retorno devolverá los campos definidos al cliente.
Puede guardar y publicar estas API para que estén disponibles para aplicaciones externas, así como para JavaScript interno de VTAP.

Acceder a una API personalizada publicada a través de API Designer

  • Para acceder a cualquier API personalizada publicada a través de API Designer, deberá utilizar el siguiente punto final.
  • https://your_instance.odx.vtiger.com/restapi/vtap/api/API_NAME? PARAMETROS
  • API_NAME debe reemplazarse con el nombre dado a la API. Además, asegúrese de que está utilizando el tipo HTTP apropiado y Cartas credenciales(nombre de usuario y clave de acceso) para acceder.

Accediendo a un creado recientemente buscar_email_contacto API usando cartero

  • Para acceder a un creado recientemente buscar_email_contacto API usando cartero, debe usar el siguiente.
  • https://your_instance.odx.vtiger.com/restapi/vtap/api/fetch_email_contact?domain=%vtiger.com%

Note : https://your_instance.odx.vtiger.com/restapi/v1/ApiDesigner/api/fetch_email_contact?domain=%vtiger.com% está obsoleto.

Sub-imagen-3 (1)

Se puede acceder a estas API internamente en Module Designer utilizando la API de JavaScript de VTAP VTAP.CustomApi.Obtener para mostrar dentro de un widget o páginas personalizadas en la interfaz de usuario de Vtiger.

Código-sub-imagen-3


Para concluir, vimos cómo la herramienta API Designer le permite escribir API REST personalizadas y usarlas internamente y en otras aplicaciones para consumir datos CRM sin problemas.
Para cualquier otra consulta, envíe un correo electrónico a [email protected]. Regístrese en la edición para desarrolladores aquí.