Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Índice

Índice
outlinetrue
exclude.*ndice
stylenone


Hablando de servicios

...

...

Los servicios REST permiten que  permiten acceder, de manera segura, a recursos y servicios externos  accedan con seguridad externos a la plataforma, utilizando los protocolos de autenticación   autenticación OAuth 1, OAuth 2 y Basic authentication.

En este recurso se puede pueden registrar , y configurar y probar estos los servicios.  Se puede Puede obtener información más técnica y detallada en Autorización para client cliente de Servicios REST.

 

Ruta básica



...

Visualizar los servicios existentes

...

01. En el menú principal, active activar Panel de Controlcontrol y a continuación verificar el agrupador Desarrollo y activarlo Servicios.

02. Active la guía WCM.

03. Active Servicios REST.

04. Visualice los servicios REST existentes.

 

Rutas alternativas

 

Agregar servicio REST

Visualizar los servicios existentes.



Filtrar por tipo

...

01. Seleccione el (los) tipo(s) de servicio(s) que desea visualizar: SOAP, JDBC o REST.

02. Los datos del (los) filtro(s) elegido(s) se enumeran a continuación.



Agregar servicio

...

...

01. En la ventana Servicios REST, active Agregaractivar Nuevo servicio.

02.. Seleccione el tipo de servicio que desea agregar: SOAPJDBC o REST.

03. Introducir  Introduzca la información solicitada.Conozca más

Painel

Los campos destacados con asterisco (*) son obligatorios.

...

Código
Código de identificación del servicio.

Dominio
Dirección correspondiente al dominio del servicio. Ejemplo: http://127.0.0.1:8080

Tipo de autenticación
Protocolo de autenticación que se utilizará por el servicio. Las opciones disponibles son:
- OAuth 1.
- OAuth 2.
- Basic.

Consumer key
LLave de acceso al servicio. Este campo solo aparece cuando la opción seleccionada en el campo de Tipo de autenticación es "Rest OAuth 1". 

Consumer secret
Clave secreta para acceder al servicio. Este campo solo aparece cuando la opción seleccionada en el campo de Tipo de autenticación es "Rest OAuth 1". 

Token de acceso
Token de acceso al servicio. Este campo solo aparece cuando la opción seleccionada en el campo de Tipo de autenticación es "Rest OAuth 1" o «Rest OAuth 2».

Token secreto
Token secreto de acceso al servicio. Este campo solo aparece cuando la opción seleccionada en el campo de Tipo de autenticación es "Rest OAuth 1".

URL token de acceso
URL al token  de acceso al proveedor. Este campo solo aparece cuando la opción seleccionada en el campo de Tipo de autenticación es "Rest OAuth 1".

URL solicitud de token
URL al token de solicitud al proveedor. Este campo solo aparece cuando la opción seleccionada en el campo de Tipo de autenticación es "Rest OAuth 1".

URL autorización de usuario
URL para autorización de acceso del usuario al proveedor. Este campo solo aparece cuando la opción seleccionada en el campo de Tipo de autenticación es "Rest OAuth 1".

Id cliente
Clave única del cliente. Este campo solo aparece cuando la opción seleccionada en el campo de Tipo de autenticación es "Rest OAuth 2". 

Client secret
Clave secreta del cliente. Este campo solo aparece cuando la opción seleccionada en el campo de Tipo de autenticación es "Rest OAuth 2".  

Refresh token
Clave para actualizar el token. Este campo solo aparece cuando la opción seleccionada en el campo de Tipo de autenticación es "Rest OAuth 2".  

URL refresh token
URL para actualizar el token. Este campo solo aparece cuando la opción seleccionada en el campo de Tipo de autenticación es "Rest OAuth 2".

Usuario
Usuario que se va a enviar en el encabezado de la solicitud.

Contraseña
Contraseña que se va a enviar en el encabezado de la solicitud. 

Confirmación de contraseña
Confirmación de la contraseña que se va a enviar en el encabezado de la solicitud.

URL para prueba de servicio
Endpoint GET para probar autenticación de acceso al proveedor.

03. Active Guardar.

 

Editar servicio REST

 

01. En la ventana Servicios REST, seleccione el servicio a editar.

02. Active Editar.

03. Modificar la información deseada.

Conozca más

Pueden obtener más detalles sobre los campos que aparecen en el path Agregar servicio REST.

04. Active Guardar.

 

Eliminar servicio REST

 

01. En la ventana Servicios REST, seleccione el servicio a eliminar.

02. Activar Eliminar.

03. Active Confirmar en el mensaje que aparece para hacer efectiva la eliminación del servicio.

 

Probar servicio REST

 

01. En la ventana Servicios REST, seleccione el servicio que desea probar.

02. Active Probar servicio.

03. En la ventana que aparece, Active Probar servicionuevamente.

04. Visualice el resultado en el recuadro Retorno de la prueba, que aparece una vez que finaliza la prueba del servicio.

 

Deck of Cards
historyfalse
idServiços
Card
id1
labelSOAP

Al seleccionar el tipo SOAP, los campos que se deben completar son:

  • Nombre: en este campo, agregue un nombre al servicio que desea registrar.
  • Descripción: en este campo, agregue una descripción para el servicio.
  • URL: en este campo, agregue la URL del webservice que desea utilizar.
  • Archivo de binding: solo se utilizará el archivo de binding para servicios creados con API CXF. Para incluir, solo debe activar Elegir archivo en el campo Archivo de binding e incluir. Podrá obtener más detalles sobre binding en nuestra documentación técnica de Integración con aplicaciones externas.
Card
id2
labelREST

Al seleccionar el tipo REST, los campos que se deben completar son:

  • Nombre: en este campo, agregue un nombre al servicio que desea registrar.
  • Descripción: en este campo, agregue una descripción para el servicio.
  • Swagger: en este campo, agregue una dirección a un archivo en el formato JSON.
Painel

El campo Swagger solo se completa cuando el servicio creado es de tipo de REST. En este campo se incluirá la ruta swagger de API que se va a utilizar.

  • Dominio: en este campo, agregue el dominio del servicio.
  • Tipo de autenticación: en este campo, seleccione el tipo de autenticación que desea: None, Rest oauth 1, Rest oauth 2, Custom, Basic.
    Para obtener más información sobre cómo rellenar correctamente las configuraciones de autenticación, visite la documentación técnica Fluig API.
  • URL para prueba de servicio: en este campo, introduzca el endpoint GET para la prueba de autenticación provider.
Card
id3
labelJDBC

Al seleccionar el tipo JDBC, los campos que se deben completar son:

  • Nombre: en este campo, agregue un nombre al servicio que desea registrar.
  • Descripción: en este campo, agregue una descripción para el servicio.
  • Controlador: en este campo, se seleccionará el controlador deseado: MySQL, SQL Server u Oracle.
  • URL: en este campo, agregue la URL del webservice que desea utilizar.
  • Usuario: usuario de acceso a la base de datos.

Contraseña: contraseña de acceso a la base de datos

04. Activar Guardar.



Editar servicio

...

01. En la ventana Servicios, seleccione el servicio que desea editar.

02. Activar Image Added (editar), ubicado en la esquina derecha de la pantalla.

03. Modificar la información deseada.

04. Activar Guardar.



Probar servicio

...

01. En la ventana Servicios, seleccione el servicio Rest que se va a probar.

02. Activar Image Added (provar servicio)ubicado en la esquina derecha de la pantalla.

03. En el mensaje que aparece, active Probar servicio.

Painel

La prueba solo se realiza para servicios REST o JDBC. La ventana de prueba de servicio mostrará un campo que contiene la devolución de la prueba, en caso de éxito o error.



Eliminar servicio

...

01. En la ventana Servicios, seleccione el servicio que desea eliminar.

02. Activar Image Added (eliminar)ubicado en la esquina derecha de la pantalla.

03. En el mensaje que aparece, active Sí, eliminar el servicio para realizar la eliminación del servicio.



Habilitar la generación de log

...

01. En la ventana Servicios, buscar el servicio que debe generar log.

02. En la columna log, activar el botón Image Added (Estadísticas de uso).

03. En la ventana de estadísticas de uso, seleccionar ON para activar el log.

04. En el mensaje de confirmación, seleccionar la opción Sí, quiero activar el log.

05. Configurar el tiempo de caducidad del registro entre 1 y 24 horas.

Painel

Con el log habilitado, se mostrará la cantidad de solicitudes realizadas por el servicio específico. Para verificar la hora en la que caducará el registro, acceda al ícono Image Added al lado del campo Tiempo de caducidad.




Realizar el download del log

...

01. En la ventana Servicios, activar el botón Descargar del log.

Painel

Al activar esta opción, puede descargar el archivo de log del servidor, que muestra los errores que se produjeron en la integración con algún sistema externo.





Informações
title¡Esté atento!

Esta documentación es válida desde la actualización 1.6.5 .10- Liquid. Si utiliza una actualización anterior, puede contener información diferente de la que usted ve en su plataforma.