TURL_SendAuthorizationPIN (function reference)

By June 1, 2017 March 21st, 2019 Online Help, Troi URL plug-in
Troi URL Plug-in > Functions reference > TURL_SendAuthorizationPIN
Troi URL Plug-in for FileMaker Pro

TURL_SendAuthorizationPIN

This will send the PIN (obtained while granting access) to the web service to complete the authorization.

SyntaxFunction badge

TURL_SendAuthorizationPIN ( switches ; method ; accessTokenURL ; PIN )

Parameters

switchesdetermine the behaviour of the function
methodeither POST or GET
accessTokenURLURL to obtain the final access token (and access token secret) from the web service
PINthe PIN (obtained by the user while granting access)

Switches

switches must be set to:

-OAuthProtocolthe plug-in is using the OAuth protocol

you can also use:

-ReturnDataAfterErrorreturn the error code followed by the data

Returned Result

Data type returned

text

Result

If successful this function returns several named parameters separated by ampersands. In this result are the two credentials access_token and access_token_secret

Originated in

Troi URL Plug-in 2.6

Compatibility

FileMaker Pro 14 to 17

Considerations

This function provides the second step and completes the authorization.
The plug-in currently only supports the OAuth 1.0A Authorization protocol.

The credentials access_token and access_token_secret need to be stored, to be able to perform requests in the future. Normally you can keep using these two credentials, until the user revokes them (on the web service site). Take care to keep the credentials secret, as they are tied to the userID on the web service.

Example

Set Variable [ $PIN ; "123456" ] 
Set Variable [ $Twitter_Access_token_step_URL ; "https://api.twitter.com/oauth/access_token" ] 
#send the PIN to Twitter to complete the authorization:
Set Variable [ $Twitter_Result ; TURL_SendAuthorizationPIN ( "-OAuthProtocol" ; "POST" ;
 		$Twitter_Access_token_step_URL ; $PIN ) ]

if succesfull $Twitter_Result will be like:

oauth_token=123456-1w4FgHt&oauth_token_secret=SN4M6F99GG&user_id=12345&screen_name=troi

See the example on how to parse this into separate fields.

Related functionsFunction badge

TURL_GetAuthorizationURL
TURL_SendAuthorizedRequest
TURL_SetAuthCredentials

Related script stepScript step badge

Send Authorization PIN URL

Related topics

Troi URL Plug-in online help (overview)


Online Help Page for Troi URL Plug-in for 14 to 17 –> TURL_SendAuthorizationPIN (urlp4415) 2019-0320 17:15:52