freshdesk_client: Creates a Freshdesk API client

In jjanuszczak/freshdeskr: An R Client for the Freshdesk API

Description

freshdesk_client returns an object containing Freshdesk credentials.

Usage

freshdesk_client(domain, api_key, password = "x", check_connection = FALSE,
  check_api_path = "/api/v2/settings/helpdesk")

Arguments

domain	The Freshdesk domain, e.g. https://<your-domain>.freshdesk.com.
api_key	Your Freshdesk api key. This can be found under Your API Key on your Freshdesk Profile Settings page. Otherwise set this to your user name to use basic authentication.
password	Your password. Only required if you are using basic authentication.
check_connection	If TRUE, checks internet connection and connection to the API by querying check_api_path. Note: Checking the connection consumes API call credits.
check_api_path	The API path used to test the connection if check_connection is set to TRUE.

Details

This function takes data regarding a Freshdesk account and creates a list object continaing these credentials. This list contains data that will be used to authenticate on Freshdesk when using the Freshdesk API.

Value

A list of your credentials. This list is required by the freshdesk_api function to call methods through the API.

Examples

## Not run: 
fc <- freshdesk_client("foo", "[e-mail]", "myPassword")
fc <- freshdesk_client("foo", "MyAPIKey")

## End(Not run)

jjanuszczak/freshdeskr documentation built on May 29, 2019, 11:05 p.m.