Properties specific to the description of OAuth2Parameters variables

Property name	Type used	Effect
AdditionalParameters	Character string	Parameters of first authentication query. This string must be formatted like the URL parameters.
AuthURL	Character string	Authorization URL to be used (first URL of OAuth 2.0 specification).
ClientID	Character string	Client identifier supplied by the service when registering the application.
ClientSecret	Character string	Secret access code of application. This code is given by the service when saving the application.
RedirectionURL	Character string	Redirection URL to use during the authentication mechanism. For a Windows or Android application, this URL must have the following format "http://localhost:PortNumber". This value must be strictly identical to the one specified when declaring the application in the relevant Web service.
ResponseType	Character string or constant	Type of response expected. The possible values are: oauth2ResponseTypeCode (or "Code"): The response is of type "Code". oauth2ResponseTypeToken (or "Token"): The response is of type "Token". oauth2ResponseTypeToken is the default value. Remark: For a "personal" authentication, the response type must be "Token". In the case of an authentication for an API or service (e.g. Google mail server), the response type must be "Code".
Scope	Character string	Requested permissions. The possible values are specific to the Web service used.
TokenURL	Character string	URL for retrieving the access token to use (second URL of OAuth 2.0 standard).

Operating mode of OAuth 2.0 authentication

• Running a first HTTP request to ask for an authorization (authorization URL specified in the OAuth2Parameters variable).
• Opening a window for user identification according to the OAuth 2.0 protocol. The identification interface is given by the service accessed.
• After identification, the server returns a first authorization code allowing you to ask the resources for an access token. This code is added as parameter of second URL (access token URL specified in the OAuth2Parameters variable).
• Running the second HTTP request to ask for the access token. The result is a JSON buffer that contains, among other things, the access token ("access_token") that will be used for the authenticated requests. The AuthToken variable contains the information found in this JSON buffer. This access token will be used by the calls to the APIs of Web service.

• If the server does not return the access token in the format of JSON code according to the OAuth2.0 standard, an error will occur and the token will not be retrieved. The server response can be retrieved via the ServerResponse property of the AuthToken variable.
• If the server does not support the HTTP "Authorization" header for transmitting the access token, this transmission must be done by the developer according to the format expected by the requested service.
  The following example allows you to use the Web service of Facebook. In this case, the access token must be specified on the request URL.
  • Code sample for Facebook
    
    // Example used to retrieve the name of the Facebook account
    MyToken is AuthToken
    MyTokenParam is OAuth2Parameters
     
    MyTokenParam.ClientID = "123456789012345"
    MyTokenParam.ClientSecret = "45g8jh5kll45579021qsg5444j"
    MyTokenParam.AuthURL = "https://www.facebook.com/dialog/oauth"
    MyTokenParam.TokenURL = "https://graph.facebook.com/v2.3/oauth/access_token"
    MyTokenParam.RedirectionURL = "http://localhost:9874/"
    MyTokenParam.Scope = "email"
     
    MyToken = AuthIdentify(MyTokenParam)
    IF MyToken <> Null THEN
    IF ErrorOccurred THEN
    Error(ErrorInfo())
    ELSE
    // Token specified on the request URL
    HTTPRequest("https://graph.facebook.com/me?access_token=" + MyToken.Value)
    vMyRes is Variant = JSONToVariant(HTTPGetResult(httpResult))
    // Retrieve the account name
    Trace(vMyRes.name)
    END
    END