vosonSML (version 0.29.13)

Authenticate.twitter: Twitter API authentication

Description

Twitter authentication uses OAuth and typically requires four developer API keys generated when you create a twitter app via the twitter developer web site.

There is another method available commonly used by third-party apps in which an app can be authorized by a user to use the twitter API on their behalf. The implementation of this method in vosonSML does not require a developer account but does still require the user to have access to a developers apps two consumer API keys. This allows multiple users to access the twitter API with vosonSML via a single developer account and app.

The twitter OAuth process is described here: https://developer.twitter.com/en/docs/basics/authentication/overview/oauth.

Usage

# S3 method for twitter
Authenticate(
  socialmedia,
  appName,
  apiKey,
  apiSecret,
  accessToken,
  accessTokenSecret,
  ...
)

Value

A credential object containing an access token $auth and social media type descriptor $socialmedia set to "twitter". Object has the class names "credential" and "twitter".

Arguments

socialmedia

Character string. Identifier for social media API to authenticate, set to "twitter".

appName

Character string. Registered twitter app name associated with the API keys.

apiKey

Character string. API consumer key to authenticate.

apiSecret

Character string. API consumer secret to authenticate.

accessToken

Character string. API access token to authenticate.

accessTokenSecret

Character string. API access token secret to authenticate.

...

Additional parameters passed to function. Not used in this method.

Examples

if (FALSE) {
# twitter authentication using developer app API keys
myDevKeys <- list(appName = "My App", apiKey = "xxxxxxxxxxxx",
  apiSecret = "xxxxxxxxxxxx", accessToken = "xxxxxxxxxxxx",
  accessTokenSecret = "xxxxxxxxxxxx")

twitterAuth <- Authenticate("twitter", appName = myDevKeys$appName, 
  apiKey = myDevKeys$apiKey, apiSecret = myDevKeys$apiSecret, accessToken = myDevKeys$accessToken, 
  accessTokenSecret = myDevKeys$accessTokenSecret)

# twitter authentication via authorization of an app to their user account
# requires the apps consumer API keys
# apiKey and apiSecret parameters are equivalent to the apps consumer key and secret
# will open a web browser to twitter prompting the user to log in and authorize the app
twitterAuth <- Authenticate("twitter", appName = "An App",
  apiKey = "xxxxxxxxxxxx", apiSecret = "xxxxxxxxxxxx"
)
}