Salesking API interface

since 1.0.0
package SalesKing PHP SDK

 Methods

Constructor method which is used to set some config stuff

__construct(\$config $config) 

since 1.0.0

Parameters

$config

\$config

array

Exceptions

\SaleskingException

Construct accesstoken URL

accessTokenUrl($code) : string

since 1.0.0

Parameters

$code

Exceptions

\SaleskingException

Returns

stringAccessToken

get the current AccessToken

getAccessToken() : null | string

since 1.0.0

Returns

nullstringaccess token

get the current app id

getAppID() : string

since 1.0.0

Returns

stringapplication id

get the current app secret

getAppSecret() : string

since 1.0.0

Returns

stringapplication secret

Returns a new SaleskingCollection object

getCollection(\$config $config) : \SaleskingCollection

since 1.0.0

Parameters

$config

\$config

mixed configuration options

Returns

Returns a new SaleskingObject

getObject(\$type $type) : \SaleskingObject

since 1.0.0

Parameters

$type

\$type

string object type

Returns

get current redirect url

getRedirectUrl() : string

since 1.0.0

Returns

stringapplication url

get current Salesking API URL

getSkUrl() : string

since 1.0.0

Returns

stringsalesking subdomain url

Make a request against the Salesking API

request(null $url, string $method, null $data) : array

since 1.0.0

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

\SaleskingException

Returns

arrayResult with message body and status code

request accesstoken from Salesking API

requestAccessToken($code) : string

since 1.0.0

Parameters

$code

Exceptions

\SaleskingException

Returns

stringAccessToken

Generate an Authorization URL

requestAuthorizationURL(string $scope) : string

since 1.0.0

Parameters

$scope

string

optional scope, if not set uses app_scope

Returns

stringauthorization url

Set a new accessToken

setAccessToken($accessToken) : \Salesking

since 1.0.0

Parameters

$accessToken

Returns

set a new app id

setAppID($app_id) : \Salesking

since 1.0.0

Parameters

$app_id

Returns

Set a new app secret

setAppSecret($app_secret) : \Salesking

since 1.0.0

Parameters

$app_secret

Returns

set a new redirect URL

setRedirectUrl($redirect_url) : \Salesking

since 1.0.0

Parameters

$redirect_url

Returns

Set a new Salesking API URL

setSkUrl($sk_url) : \Salesking

since 1.0.0

Parameters

$sk_url

Returns

 Properties

 

access token

$accessToken : string

since 1.0.0
 

app id

$app_id : string

since 1.0.0
 

app scope

$app_scope : string

since 1.0.0
 

app secret

$app_secret : string

since 1.0.0
 

common curl options

$curl_options : array

since 1.0.0
 

debugging switch

$debug : boolean

since 1.0.0
 

app url

$redirect_url : string

since 1.0.0
 

api url

$sk_url : string

since 1.0.0

 Constants

 

current SDK Version

VERSION 

const VERSION current SDK version
since 1.0.0