Definición manual del servicio
Este tema describe la definición manual de una llamada a una API HTTP. Para poder configurar manualmente una llamada a una API HTTP, abra el cuadro de diálogo Configuración de la llamada al servicio web y seleccione Manual en la sección Definición del servicio. Los parámetros que puede configurar se describen en las subsecciones siguientes.
La imagen siguiente ilustra la definición manual de una llamada de ejemplo a una API HTTP.
Opcionalmente, si dispone del archivo WADL del servicio web, puede importar la configuración del servicio web haciendo clic en Importar desde WADL (ver Importar desde WADL). Además, si desea extraer los parámetros del servicio web de una URL, haga clic en el botón Importar desde URL (ver Importar desde una URL).
Método de solicitud
Esta opción de configuración le permite definir el método HTTP (por ejemplo, GET, POST, PUT, etc.) que MapForce debe utilizar para llamar al servicio web. Puede seleccionar un valor de la lista o escribir el nombre del método que desea usar. Debe tener en cuenta el uso de mayúsculas y minúsculas en los nombres de métodos HTTP.
Configuración de la conexión
URL | URL especifica la dirección (URL) del servicio web al que desea llamar.
| ||
Usar URL dinámicas dadas por la asignación | Si quiere suministrar la URL del servicio web desde una asignación, marque la casilla Usar URL dinámicas dadas por la asignación. Esto crea otro conector de entrada en el componente del servicio web dentro de la asignación al que puede conectar un componente de entrada que proporcione la URL del servicio web.
Con las URL total o parcialmente dinámicas, puede ajustarlas con flexibilidad en función de lo que necesite. Por ejemplo, puede ejecutar la asignación con una URL específica durante el desarrollo y usar una URL diferente en producción, sin tener que modificar la asignación. Esto sería posible con una URL como https://{host}/some/path/to/service, siempre que el nombre de host sea la única diferencia entre la URL de desarrollo y la de producción, y que la suministre como parámetro de la asignación. Observe que las URLs parcialmente dinámicas requieren una validación más escrita, ya que solo se reemplazan con valores asignables o en tiempo de ejecución las partes designadas de la URL.
Con las URLs completamente dinámicas se puede asignar toda la URL y tiene control absoluto sobre ella; el único requisito es que la URL empiece por http:// o https:// y que sea un URL válido. Es decir, con las URLs dinámicas puede suministrar la URL devuelta por una llamada a un servicio web como entrada de otro componente que puede llamar al mismo servicio web (o a otro).
| ||
Tiempo de espera | El parámetro Tiempo de espera define el plazo de tiempo pasado el cual la llamada al servicio web expirará si no se obtiene respuesta del servidor. Seleccione Infinito si la llamada debe esperar una respuesta durante un plazo indefinido de tiempo.
|
Notas sobre los parámetros en la URL
Opcionalmente, puede convertir partes específicas de la URL en parámetros y suministrar valores a estos parámetros desde la asignación principal. Si la URL del servicio web usa esos parámetros, debe tener en cuenta que:
•Si llama a un servicio web con parámetros de estilo plantilla o matriz, ponga los parámetros entre llaves, por ejemplo: http://example.org/api/products/{id}. Después defina la configuración de cada parámetro en la tabla Parámetros. En tiempo de ejecución, MapForce procesa los nombres de parámetro que están entre llaves y produce la URL final que incluye valores reales.
•Si llama a un servicio web con parámetros de consulta URL (por ejemplo, http://example.org/api/products?sort=asc&category=1&page=1), no introduzca la parte de consulta en el cuadro de texto URL. En su lugar, defina los parámetros en la tabla Parámetros y asegúrese de designarlos como parámetros de tipo consulta.
Estructuras
Esta sección del cuadro de diálogo le permite seleccionar las estructuras de solicitud y respuesta de su llamada al servicio web. Cuando llame a servicios web que esperan contenido en la parte del cuerpo del mensaje de solicitud o devuelven contenido en la parte del cuerpo del mensaje de respuesta, puede configurar las estructuras de solicitud y respuesta como:
•sin estructura
•XML
•JSON
Nota: | en llamadas a servicios web creados en MapForce puede usar JSON estándar como estructura de solicitud o de respuesta; no se admiten estructuras en JSON 5 o líneas JSON. |
La estructura seleccionada aquí determina los elementos que se pueden asignar que aparecen en la asignación como secundarios del elemento Body .
Para más detalles sobre las estructuras de solicitud y respuesta, consulte Estructuras de solicitud/respuesta.
Parámetros
Si llama a un servicio web con parámetros URL, debe definir los parámetros en la sección Parámetros del cuadro de diálogo Configuración de la llamada al servicio web (imagen siguiente). Este cuadro de diálogo también sirve para configurar la solicitud del servicio web con encabezados personales.
Como alternativa a la definición manual, también puede rellenar los parámetros del servicio web automáticamente, importándolos de una URL existente o de un archivo WADL.
Para más detalles sobre los parámetros, consulte Parámetros.
Configuración de seguridad HTTP
Puede que necesite configurar las opciones de configuración de seguridad HTTP en estas situaciones:
•Al servicio web se le llama a través de HTTPS y requiere un certificado de cliente.
•El servidor utiliza un certificado incorrecto y a usted le gustaría permitir un nombre de host no coincidente entre el certificado y la solicitud.
•El servicio web requiere autenticación HTTP básica o autorización OAuth 2.0.
Para más información, consulte Configuración de seguridad HTTP.
Guardar todas las rutas de acceso de archivos como relativas al archivo MFD
Cuando esta opción está habilitada, MapForce guarda las rutas de acceso al archivo que aparecen en el cuadro de diálogo Configuración del componente relativas a la ubicación del archivo de diseño de MapForce (.mfd). Consulte también Rutas de acceso relativas y absolutas.