Consulta API

Proporcionar una API de tipo REST que devuelva consultas a la base de datos.

Lista de consultas API

La pantalla de listado muestra todas las API de consulta en el entorno, lo que permite a los usuarios ver el nombre del método (equivalente al punto final generado para la llamada de integración), la fecha de la última modificación, el indicador de integración activa y los parámetros de URL que se pueden enviar.

En la pestaña de acciones, puede llamar a la URL del punto final, ir a la pantalla de edición, eliminar el registro, exportar (para copias de seguridad o migración) o navegar a la pantalla de monitoreo de integración.

Crear una consulta API

Campos disponibles y sus respectivas funcionalidades:

• Nombre del método: Identificador de punto final;
• Base de datos: Registro de CadastroDB en el que se ejecutará la consulta;
• Cola de integración: Contexto de ejecución dentro del entorno, alcance de las colas de procesamiento;
• Parámetros de URL: Valores que se pueden utilizar para alimentar dinámicamente la consulta con parámetros de URL;
• Activo: Define si se puede llamar al punto final;
• Campo SQL: Define la consulta SQL que será procesada por la base de datos. Puedes recibir los valores de Parámetros URL con la sintaxis dereemplazar dedicado (: nombre del parámetro).
• Autorización: Define un encabezadoAutorización en el punto final que sirve como clave de uso para que no esté disponible abiertamente.
• Tipo de autorización de servicio web: Ninguno (público), Portador (código fijo) o Autenticación básica (asociada a un registro de Credencial de plataforma);
• Token de autenticación: Token o Credencial que se asociará con el tipo de autorización del servicio web.

Llamar a una consulta API

La URL para llamar a ConsultaAPI se puede obtener tras realizar un test de API, indicando los parámetros de la URL (si se han definido):

El punto final generado por CONNECT tiene el formato HOST/ENTORNO/FUNCIONALIDAD/IDENTIFICADORES, por ejemplo:

Ejemplo de llamada con Autorización