Methods
Constructor method which is used to set some config stuff
__construct(\$config $config)
Construct accesstoken URL
accessTokenUrl($code) : string
Parameters
$code
Exceptions
Returns
string
AccessToken
get the current AccessToken
getAccessToken() : null | string
Returns
null
string
access token
get the current app id
getAppID() : string
Returns
string
application id
get the current app secret
getAppSecret() : string
Returns
string
application secret
Returns a new SaleskingCollection object
getCollection(\$config $config) : \SaleskingCollection
Parameters
$config
\$config
mixed configuration options
Returns
Returns a new SaleskingObject
getObject(\$type $type) : \SaleskingObject
Parameters
$type
\$type
string object type
Returns
get current redirect url
getRedirectUrl() : string
Returns
string
application url
get current Salesking API URL
getSkUrl() : string
Returns
string
salesking subdomain url
Make a request against the Salesking API
request(null $url, string $method, null $data) : array
Parameters
$url
null
the url endpoint including a starting /
$method
string
the HTTP Method (GET; POST; PUT; DELETE)
$data
null
The json_encoded data to send with to the api
Exceptions
Returns
array
Result with message body and status code
request accesstoken from Salesking API
requestAccessToken($code) : string
Parameters
$code
Exceptions
Returns
string
AccessToken
Generate an Authorization URL
requestAuthorizationURL(string $scope) : string
Parameters
$scope
string
optional scope, if not set uses app_scope
Returns
string
authorization url
Set a new accessToken
setAccessToken($accessToken) : \Salesking
Parameters
$accessToken
Returns
set a new app id
setAppID($app_id) : \Salesking
Parameters
$app_id
Returns
Set a new app secret
setAppSecret($app_secret) : \Salesking
Parameters
$app_secret
Returns
set a new redirect URL
setRedirectUrl($redirect_url) : \Salesking
Parameters
$redirect_url
Returns
Set a new Salesking API URL
setSkUrl($sk_url) : \Salesking
Parameters
$sk_url
Returns
Properties
access token
$accessToken : string
app scope
$app_scope : string
app secret
$app_secret : string
common curl options
$curl_options : array
debugging switch
$debug : boolean
app url
$redirect_url : string
Constants
current SDK Version
VERSION
const |
VERSION current SDK version |
since |
1.0.0 |