Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

CONFIGURACIÓN NECESARIA

  • Handlers: para poder tener acceso al API de GAM la cual permite gestionar el acceso a los servicios mediante un token de acceso, el archivo web.config debe contener en la sección de handlers el elemento:

Code Block
languagehtml
<add name="GeneXus.Http.GXOAuthAccessToken" verb="*" path="GXOAuthAccessToken.aspx" type="GeneXus.Http.GXOAuthAccessToken,GxClasses" />

  • Usuario: es recomendable crear un usuario en el GAM para para permitir el acceso exclusivo a los web services.

  • Roles y Permisos: Se debe crear un rol específico para el uso de los web services con los permisos de los web servicesexpuestos y este rol debe ser asignado al usuario que se utilizará para la conexión. Por cada web service expuesto sobre una transacción Genexus existen permisos relacionados, los cuales deben llevar el sufijo con el permiso otorgado, la estructura es

Code Block
languagehtml
[Transaccion]_Service_[Tipo de Permiso]

Entre los tipos de permisos están:

  • Execute
    Permite operaciones GET

  • Insert
    Permite operaciones POST

  • Delete
    Permite operaciones DELETE

  • Update
    Permite operaciones PUT

  • FullControl
    Permite realizar GET, POST, PUT y DELETE sobre el web service.


WEB SERVICE DE AUTENTICACIÓN

  • ACCESS TOKEN

Para obtener el token de acceso es necesario realizar POST con los parámetros (Recomendable hacerlo con aplicaciones como POSTMAN), para ello se deben tener los paramentos listados a continuación (Se indican a modo de ejemplo):

key

value

client_id

1517b36b238a42c886b4367a1d132582

client_secret

feb8098762b64fb29038bf844fce894

granttype

password

scope

FullControl

username

admin

password

admin123

Donde los parámetros client_id y client_secret deben obtenerse de los parámetros de la aplicación en el GAM, esta información puede ser revisada en el menú Configuración - Seguridad - Configuración de la Aplicación.


PETICIÓN DE ACCESO

  • Una petición POST a (Recomendable hacerlo con aplicaciones como POSTMAN).

Expand
titleInstalación de POSTMAN

Para la Autenticacion y consumo de los Web Services indicados debemos tener instalado en tu equipo de trabajo alguna aplicación para probar acceso a la REST API de SIFCO WEB, para ello recomendamos uno de los mas usados como es POSTMAN y a continuación detallamos su instalación como extensión de Google Chrome, dado a que la misma es independiente del Sistema Operativo (SO) que estés utilizando, sin embargo es importante acotar que dicha aplicación también se puede instalar directamente en tu equipo, pero el instalador a utilizar dependerá del SO que estés ejecutando en ella.

INSTALACIÓN DE POSTMAN COMO EXTENSIÓN DE GOOGLE CHROME

Primero debe acceder a siguiente link

Luego debes darle clic al botón de

Status
colourBlue
titleAgregar a chrome

Luego en la ventana del pop-up que se muestra en la imagen debes dar clic en

Status
titleAgregar app

Y luego verificar que comience la descarga en la barra inferior, y una vez culminado (debe ser un proceso bastante rápido), verificar que la aplicación esta en tu listado de extensión y aplicaciones de Google Chrome.

Una vez instalado puedes iniciarlo y configurar los parámetros indicados en esta guía para la obtención del token y el consumo de los Web Services

Si necesitas información adicional de como utilizar POSTMAN, te adjunto dos paginas que pueden ser de mucha ayuda para ello.

Paginas e Apoyo Adicionales para la Instalación y utilización de POSTMAN

Code Block
HTTP://<SERVER>/<APPDIR>/oauth/access_token

Incluyendo en el body:

Code Block
languagehtml
client_id=1234561ad52a42919a221bc796d0d6b0&client_secret=1111114313d243dd987b3aadb250e63b&granttype=password&scope=FullControl&username=admin&password=admin123

  • Como respuesta se obtendrá un JSON con el token de acceso el cual deberá utilizarse en el encabezado de petición de consumo de los objetos expuestos

Code Block
languagejson
{ 
"access token" : "c9919e10e118"
"scope" : "FullControl"
}


CONSUMO DE WEB SERVICE

  • Petición con la estructura:

Code Block
HTTP://<SERVER>/<APPDIR>/rest/WEB_SERVICE/PARM_1/PARM_2/PARM_N

  • Encabezados obligatorios:

Code Block
languagehtml
“Content-Type”, ”application/json”
“Authorization”, “OAuth ” + access_token
“GENEXUS-AGENT”, “SmartDevice Application”


Note

Respete los encabezados obligatorios para que pueda consumir el WEB SERVICE respectivo.

Warning

NO OLVIDE crear un usuario en el GAM para para permitir el acceso exclusivo a los web services. Y incluir en el archivo web.config debe contener en la sección de handlers el elemento indicado en la primera parte de esta pagina.

Live Search
spaceKeyDOC
placeholderBúsqueda en esta Pagina
typepage

Artículos Relacionados

Filter by label (Content by label)
showLabelsfalse
max5
showSpacefalse
cqllabel in ( "informacion" , "tecnica" , "rest" , "api" , "access" , "token" ) and type = "page" and space = "DOC"

Artículos Actualizados Recientemente

Recent updates
typespage
max5
spacesDOC
themeconcise
hideHeadingtrue
Change History