acoustic_auth: Connect to API and Obtain Access Token

Description Usage Arguments Details Value Examples

View source: R/acoustic_auth.R

Description

Prior to attempting this you must have a Client Id, Client Secret and Refresh Token. The first two are assigned on an organization level; the latter must be created by someone with an admin role in Acoustic and assigned to you.

Usage

1
acoustic_auth(org_client_id, org_client_secret, my_refresh_token, pod_number)

Arguments

org_client_id

Organization's Client Id.

org_client_secret

Organization's Client Secret.

my_refresh_token

Your personal Refresh Token.

pod_number

Pod number is the number in the URL, e.g. engage1.silverpop.com.

Details

Access tokens expire after four hours. Thus, this function should be run each time you utilize the package and may need to be re-called periodically if you have a session open for a long duration.

It is not recommended that these authentication parameters be stored directly in your code. There are various methods and packages available that are more secure; this package does not require you to use any one in particular.

More information on this available at https://developer.ibm.com/ customer-engagement/tutorials/ getting-started-oauth-watson-campaign-automation/ .

Value

A vector with the session's access token.

Examples

1
2
3
4
5
6
## Not run: 
access_token <- acoustic_auth(org_client_id = "abc",
org_client_secret = "xyz",
my_refresh_token = "123")

## End(Not run)

ibmAcousticR documentation built on Aug. 28, 2020, 9:06 a.m.