Wiki

Contenido

Discusión

Historial

Backlinks


Contenido a enviar:

Apis Integración de Aplicaciones

GXportal provee un conjunto de APIs (Procedimientos) que le permitirán acceder a la base de datos de GXportal desde su aplicación.
La siguiente tabla detalla la lista de procedimientos provistos y describe su funcionalidad de cada uno de ellos:

Procedimiento	Descripción
GXPCheckSecurity	Chequear la seguridad para acceder a un objeto de su aplicación, verifica que el usuario autenticado tenga permisos de acceso al mismo.
GXPValidSession	Validar el estado de la sesión actual, verifica que exista una sesión válida para poder ejecutar un programa.
GXPListActiveSessions	Retorna la lista las sesiones activas en el portal.
GXPKillSession	Permite “matar” una sesión activa de un usuario, da por finalizada la misma, dando por finalizada su autenticación.
GXPAPIUser	Permite administrar la información de los usuarios del portal desde la aplicación integrada, permitiendo agregar nuevos usuarios, actualizar datos y eliminar los mismos.
GXPAPIUserMemberRole	Asignar y quita Roles a un usuario específico.
GXPUserRecoveryPassword	Recuperar la contraseña de un usuario, generándole una nueva contraseña en forma randómica.
GXPListUsers	Retorna la lista de usuarios del portal.
GXPListUserRoles	Retorna la lista de roles de un usuario.
GXPListRoles	Retorna la lista de roles del portal.
GXPSetSharedData	Grabar información a ser compartida entre las aplicaciones integradas al portal, la misma es por sesión de usuario y caduca al finalizar la sesión.
GXPGetSharedData	Permite obtener la información compartida almacenada de la sesión activa.
GXPGetCatalogedPageUrl	Retorna la URL de un link catalogado indicado por parámetro.
GXPGenerateAuditoryProductActivity
GXPListAuditoryActivities

CONSIDERACIONES

La mayoría de las APIs de GXportal validan que exista una sesión válida para ser ejecutada, por lo tanto el API GXPValidSession se ejecuta automáticamente antes de ejecutarse cualquier acción sobre la base de datos. Las APIs que no utilizan dicha validación están documentadas explícitamente.
El API GXPValidSession según su parámetro GenerateAcytivityLog genera un log de auditoría ejecutando GXPGenerateAuditoryProductActivity, pero de ser necesario se puede utilizar el API GXPGenerateAuditoryProductActivity en forma independiente para generar un log en particular.

Para ver ejemplos de utilización de estas APIs se provee un archivo comprimido con un xpz mostrando el uso de alguno de los procedimientos detallados anteriormente, para obtener los ejemplos para GeneXus 9.0 dar clic aquí, para obtener los ejemplos para GeneXus X dar clic aquí. Junto con los ejemplos se provee un Export de una Aplicación integrada a GXportal.

Todos los procedimientos consolidados reciben el parámetro &GXPConnInf y retornan el parámetro &GXPStatus.

El parámetro &GXPConnInf es un parámetro de entrada/salida, en el mismo se deberá especificar como conecta la aplicación con GXportal y que método utiliza para identificar la sesión, también el mismo retorna información de la sesión del usuario y de GXportal. Éste parámetro es una variable de tipo SDT con la siguiente estructura:

Authentication	Type		Es el tipo de verificación de la autenticación. El mismo puede ser: • GXPAuthenticationType.UserKey: Clave de seguridad que provee GXportal, dependiente de la sesión del usuario. • GXPAuthenticationType.Cookie: Clave de seguridad se lee desde una cookie, para esto GXportal y la aplicación deben estar bajo el mismo dominio y mismo puerto. •GXPAuthenticationType.ExternalLogin: No implementado en esta versión.
	UserKey	Key	Clave de seguridad brindada por GXportal.
	ExternalLogin		No implementado en esta versión.
	DBConnection	Type	Es el tipo de conexión a GXportal, por el momento el único tipo implementado es GXPDBConnectionType.LAN, configurado a través del DataStore.
UserKey			Retorna la clave de seguridad el usuario autenticado.
ExternaKey			Retorna la clave de seguridad externa.
GXportalData	LanguageId	Datos de GXportal	Idioma del portal.
	PortalId		Identificador del portal.
	ChannelId		Identificador del canal.
	PageId		Identificador de página.
	SectorId		Identificador del sector de la aplicación externa .
	Status		Estado de la página visualizada
RepositoryData	Id	Datos del repositorio	Identificador del Repositorio del Portal.
	AuthenticationType		Identificador de la sesión.
	UserIdentification		Indica si es identificador de usuario es el Nick name o el Email.
	ActivationAutomatic		Indica si al crearse un usuario el mismo queda activado en el portal o requiere de una activación del usuario (dominio GAMRepUsrAutAct).
	ActivationTimeout		Tiempo máximo aceptable para Activar una cuenta de usuario definida previamente.
	UserLoginAttempts		Número máximo de reintentos de autenticación para no bloquear el login.
	SecurityPolicyId		Identificador de la política de seguridad.
	GenerateAuditory		Indica si el repositorio genera auditoría (Dominio GAMRepAud).
	Key		Clave de encriptación de datos.
SessionData	Date	Datos de la sesión leída	Fecha de la sesión.
	Id		Identificador de la sesión
	InitialURL		URL desde donde se inició la sesión del usuario.
	IPAddress		Dirección IP desde donde inició la sesión del usuario.
	BrowserId		Identificador del Browser desde donde inició la sesión del usuario.
	OperationSystemId		Identificador del Sistema Operativo desde donde inició la sesión del usuario.
	LoginDate		Fecha y hora de inicio de sesión.
	UserId		Identificador del usuario autenticado.
	SharedData		Datos compartidos en la sesión del usuario.
	TimeOut		Tiempo de expiración de la sesión de usuario.
	AnonymouseUser		Booleano que indica si la sesión de usuario anónimo.
	LastAccess		Fecha y hora del último acceso a una página de GXportal.
GenerateActivityLog			Flag (Dominio GXpBoolean) indicando si se desea grabar el LOG de la actividad a ejecutar.

El parámetro &GXPStatus es un parámetro de salida, en el mismo retorna información sobre la utilización del procedimiento. Este parámetro es una variable de tipo SDT con la siguiente estructura:

Módulo	Identificador del módulo donde fue generado el error.
Id	Identificador del error, si el procedimiento retorna nulo, la ejecución de fue exitosa.
Message	Descripción del mensaje del error.

Categorías:
Integración de aplicaciones

TOUR

EMPRESA