AYUDA EN LÍNEA
 WINDEVWEBDEV Y WINDEV MOBILE

Ayuda / WLanguage / Funciones WLanguage / Comunicación / Gestión del protocolo OAuth 2.0
  • Cómo funciona la autenticación OAuth 2.0
  • Modo de funcionamiento de la autenticación OpenID
  • Aplicación en segundo plano: Caso concreto de Android 10
WINDEV
WindowsLinuxJavaReportes y ConsultasCódigo de Usuario (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Código Navegador
WINDEV Mobile
AndroidWidget Android iPhone/iPadIOS WidgetApple WatchMac Catalyst
Otros
Procedimientos almacenados
Realiza una autenticación utilizando:
  • el protocolo OAuth 2.0 en cualquier servicio web.
  • el protocolo OpenID en cualquier servicio web.
    Novedad versión 2025
    Android Esta sintaxis ahora está disponible para Android.
  • un token JWT.
    Novedad versión 2025
    Android Esta sintaxis está disponible para Android a partir de la versión 2025 - Update 1.
Ejemplo
// Exemple permettant de récupérer un token pour effectuer une requête sur Dropbox
OAuth2Params is OAuth2Parameters
OAuth2Params.ClientID = "01234567890123456789" 
OAuth2Params.ClientSecret = "98765432109876543210"
OAuth2Params.AuthURL = "https://www.dropbox.com/oauth2/authorize"
OAuth2Params.TokenURL = "https://api.dropboxapi.com/oauth2/token"
OAuth2Params.AdditionalParameters = "force_reapprove=false"
<COMPILE IF TypeConfiguration <> Site>
	// Si ce n'est pas dans un site WEB il faut une URL de redirection en localhost
	OAuth2Params.RedirectionURL = "http://localhost:9874/"
<END>

// Demande d'authentification : ouvre la fenêtre de login
MonToken is AuthToken = AuthIdentify(OAuth2Params)

// Requête authentifiée sur une API de Dropbox
req is httpRequest
req.Method = httpPost
req.URL = "https://api.dropboxapi.com/2/files/list_folder"
req.AuthToken = MonToken // Token d'authentification
req.ContentType = "application/json"
vParamAPI is Variant
vParamAPI.path = "/Homework/math"
vParamAPI.recursive = False
vParamAPI.include_media_info = False
vParamAPI.include_deleted = False
vParamAPI.include_has_explicit_shared_members = False
req.Content = VariantToJSON(vParamAPI)

réponseHTTP is httpResponse = HTTPSend(req)
let Données = JSONToVariant(réponseHTTP.Content)
// Utilisation des données reçues ...
Sintaxis
IOS WidgetMac Catalyst Esta sintaxis no está disponible para aplicaciones en modo widget iOS o Catalyst

Autenticación mediante el protocolo OAuth 2.0 Ocultar los detalles

<Result> = AuthIdentify(<Authentication parameters>)
<Result>: Variable de tipo AuthToken
Variable de tipo AuthToken que corresponde al token que contiene la información de acceso para las siguientes solicitudes que requieran autenticación.
<Authentication parameters>: Variable de tipo OAuth2Parameters
Nombre de la variable de tipo OAuth2Parameters que contiene los parámetros que describen los elementos necesarios para obtener el token de acceso.

Autenticación mediante el protocolo OAuth 2.0 (sintaxis asíncrona) Ocultar los detalles

AuthIdentify(<Authentication parameters> , <WLanguage procedure>)
<Authentication parameters>: Variable de tipo OAuth2Parameters
Nombre de la variable de tipo OAuth2Parameters que contiene los parámetros que describen los elementos necesarios para obtener el token de acceso.
<WLanguage procedure>: Nombre del procedimiento
Nombre del procedimiento WLanguage ("callback") al que se llama durante la autenticación. Para obtener más información sobre este procedimiento, consulte Parámetros del procedimiento utilizado por la función AuthIdentify.
AndroidiPhone/iPad

Autenticación mediante el protocolo OpenID Ocultar los detalles

<Result> = AuthIdentify(<Authentication parameters>)
<Result>: Variable de tipo AuthToken
Variable de tipo AuthToken que corresponde al token que contiene la información de acceso para las siguientes solicitudes que requieran autenticación.
<Authentication parameters>: Variable de tipo OpenIDParameters
Nombre de la variable de tipo OpenIDParameters que contiene los parámetros que describen los elementos necesarios para obtener el token de acceso.

Autenticación mediante el protocolo OpenID (sintaxis asíncrona) Ocultar los detalles

AuthIdentify(<Authentication parameters> , <WLanguage procedure>)
<Authentication parameters>: Variable de tipo OpenIDParameters
Nombre de la variable de tipo OpenIDParameters que contiene los parámetros que describen los elementos necesarios para obtener el token de acceso.
<WLanguage procedure>: Nombre del procedimiento
Nombre del procedimiento WLanguage ("callback") al que se llama durante la autenticación. Para obtener más información sobre este procedimiento, consulte Parámetros del procedimiento utilizado por la función AuthIdentify.

Utilizar una autenticación JWT Ocultar los detalles

<Result> = AuthIdentify(<Authentication parameters>)
<Result>: Variable de tipo AuthToken
Variable de tipo AuthToken que corresponde al token que contiene la información de acceso para las siguientes solicitudes que requieran autenticación.
<Authentication parameters>: Variable de tipo JWTParameters
Nombre de la variable de tipo JWTParameters que contiene los parámetros que describen los elementos necesarios para obtener el token de acceso.

Utilizar una autenticación JWT (sintaxis asíncrona) Ocultar los detalles

AuthIdentify(<Authentication parameters> , <WLanguage procedure>)
<Authentication parameters>: Variable de tipo JWTParameters
Nombre de la variable de tipo JWTParameters que contiene los parámetros que describen los elementos necesarios para obtener el token de acceso.
<WLanguage procedure>: Nombre del procedimiento
Nombre del procedimiento WLanguage ("callback") al que se llama durante la autenticación. Para obtener más información sobre este procedimiento, consulte Parámetros del procedimiento utilizado por la función AuthIdentify.
Observaciones

Cómo funciona la autenticación OAuth 2.0

La función AuthIdentify realiza las siguientes acciones para implementar la autenticación OAuth 2.0:
  • Ejecución de una primera solicitud HTTP para pedir una autorización (URL de autorización especificada en la variable de tipo OAuth2Parameters).
  • Apertura de una ventana de autenticación OAuth 2.0. La ventana de autenticación la define cada servicio.
  • Tras la autenticación, el servidor devuelve un código de autorización para solicitar un token de acceso. Este código se añade en el parámetro de la segunda URL (URL del token de acceso especificado en la variable de tipo OAuth2Parameters).
  • Ejecución de una segunda solicitud HTTP para obtener el token de acceso. El resultado es un buffer JSON que contiene, entre otros elementos, el token de acceso ("access_token") que se utilizará para las solicitudes que requieran autenticación. La variable de tipo AuthToken contiene la información que se encuentra en el buffer JSON. Este token de acceso será utilizado por las llamadas a las API del servicio web.
Para usar las API del servicio web, utilice la función HTTPSend con una variable de tipo httpRequest que define la solicitud a ejecutar.
La variable AuthToken se asignará a la propiedad AuthToken de la variable httpRequest (ver ejemplo).
En este caso, el servidor recibirá la solicitud HTTP "Authorization" con un valor en el siguiente formato: "Authorization: Bearer xxx_access_token_xxx".
Atención:
  • Si el servidor no devuelve el token de acceso en formato de código JSON según el estándar OAuth2.0, se producirá un error y no se recibirá el token. La respuesta del servidor se puede obtener mediante la propiedad ServerResponse de la variable de tipo AuthToken.
  • Si el servidor no soporta el encabezado HTTP "Authorization" para transmitir el token de acceso, el desarrollador debe realizar la transmisión según el formato esperado por el servicio solicitado.
    El siguiente ejemplo permite utilizar el servicio Web de Facebook. En este caso, el token de acceso debe especificarse en la URL de la solicitud.
    • Android Ejemplo de código para Facebook
      // Exemple permettant de récupérer le nom du compte Facebook
      MonToken is AuthToken
      MonTokenParam is OAuth2Parameters
      
      MonTokenParam.ClientID = "123456789012345"
      MonTokenParam.ClientSecret = "45g8jh5kll45579021qsg5444j"
      MonTokenParam.AuthURL = "https://www.facebook.com/dialog/oauth"
      MonTokenParam.TokenURL = "https://graph.facebook.com/v2.3/oauth/access_token"
      MonTokenParam.RedirectionURL = "http://localhost:9874/"
      MonTokenParam.Scope = "email"
      
      MonToken = AuthIdentify(MonTokenParam)
      IF MonToken <> Null THEN
      	IF ErrorOccurred THEN
      		Error(ErrorInfo())
      	ELSE
      		// Token précisé sur l'URL de la requête
      		HTTPRequest("https://graph.facebook.com/me?access_token=" + MonToken.Value)
      		vMonRes is Variant = JSONToVariant(HTTPGetResult(httpResult))
      		// Récupération du nom du compte
      		Trace(vMonRes.name)
      	END
      END
    • iPhone/iPad Ejemplo de código para Facebook:
      MonToken is AuthToken
      MonTokenParam is OAuth2Parameters
      MonTokenParam.ClientID = "1705548803004741"
      MonTokenParam.ClientSecret = "7b3305a5aa1687ef04af001ec3388ecc"
      MonTokenParam.AuthURL = "https://www.facebook.com/dialog/oauth"
      MonTokenParam.TokenURL = "https://graph.facebook.com/oauth/access_token"
      MonTokenParam.RedirectionURL = "fb1705548803004741://authorize/"
      MonTokenParam.Scope = "email"
      
      MonToken = AuthIdentify(MonTokenParam)
      IF MonToken <> Null THEN
      	IF ErrorOccurred THEN
      		Error(ErrorInfo())
      	ELSE
      		// Token précisé sur l'URL de la requête
      		HTTPRequest("https://graph.facebook.com/me?access_token=" + MonToken.Value)
      		vMonRes is Variant = JSONToVariant(HTTPGetResult(httpResult))
      		// Récupération du nom du compte
      		Trace(vMonRes.name)
      	END
      END

Modo de funcionamiento de la autenticación OpenID

Las etapas de autenticación de OpenID realizadas por la función AuthIdentify son las siguientes:
  • Ejecución de una primera solicitud HTTP para pedir una autorización (URL de autorización especificada en la variable de tipo OpenIDParameters).
  • Apertura de una ventana de autenticación OpenID. La ventana de autenticación la define cada servicio.
  • Ejecución de una segunda solicitud HTTP para obtener el token de acceso después de la autenticación. El resultado es un buffer JSON que contiene, entre otros elementos, el token de acceso ("access_token") que se utilizará para las solicitudes que requieran autenticación. La variable de tipo AuthToken contiene la información que se encuentra en el buffer JSON. Este token de acceso será utilizado por las llamadas a las API del servicio web.
Para autenticar al usuario, utilice la función OpenIDReadIdentity con la variable de tipo AuthToken.
Nota: Si el servidor no devuelve el token de acceso en formato de código JSON según el estándar OAuth2.0, se producirá un error y no se recibirá el token. La respuesta del servidor se puede obtener mediante la propiedad ServerResponse de la variable de tipo AuthToken.
Android

Aplicación en segundo plano: Caso concreto de Android 10

A partir de Android 10, no se puede abrir una ventana si la aplicación está en segundo plano.
La función AuthIdentify puede abrir una ventana. Si se utiliza esta función cuando la aplicación está en segundo plano, se producirá un error fatal.
Consejos:
  • Para saber si la aplicación está en segundo plano, utilice la función InBackgroundMode.
  • Si una aplicación necesita interactuar con el usuario cuando está en segundo plano, se puede mostrar una notificación (con el tipo Notification). La aplicación volverá al primer plano cuando se haga clic en la notificación, si la propiedad ActivateApplication se establece en True. También es posible abrir una ventana desde el procedimiento pasado a la propiedad ActionClick.
Para obtener más información, consulte Android 10: Comportamiento de las aplicaciones en segundo plano.
Clasificación Lógica de negocio / UI: Lógica de negocio
Componente: wd300ggl.dll
Versión mínima requerida
  • Versión 22
Esta página también está disponible para…
Comentarios
Use case specification (Android 14) with WM 2025, Update 1
Starting with Android 14, it is necessary to indicate the use case(s) of the persistent thread when calling AuthIdentify.
android.permission.FOREGROUND_SERVICE_DATA_SYNC will be automatically added.
Not using this permission will generate an exception when using AuthIdentify: "Error switching thread to persistent mode."
MerijnW
28 02 2025

Última modificación: 04/04/2025

Señalar un error o enviar una sugerencia | Ayuda local