interface ApiInterface (View source)

Enforce implementation rules on all classes that need to implement and access the API Methods

Methods

string
getBaseUrl()

Returns the API base url.

array
_get(string $url = null, array $parameters = [])

Send a GET request.

array
_head(string $url = null, array $parameters = [])

Send a HEAD request.

array
_delete(string $url = null, array $parameters = [])

Send a DELETE request.

array
_put(string $url = null, array $parameters = [])

Send a PUT request.

array
_patch(string $url = null, array $parameters = [])

Send a PATCH request.

array
_post(string $url = null, array $parameters = [])

Send a POST request.

array
_options(string $url = null, array $parameters = [])

Send an OPTIONS request.

array
execute(string $httpMethod, string $url, array $parameters = [])

Executes the HTTP request.

Details

string getBaseUrl()

Returns the API base url.

Return Value

string

array _get(string $url = null, array $parameters = [])

Send a GET request.

Parameters

string $url
array $parameters

Return Value

array

array _head(string $url = null, array $parameters = [])

Send a HEAD request.

Parameters

string $url
array $parameters

Return Value

array

array _delete(string $url = null, array $parameters = [])

Send a DELETE request.

Parameters

string $url
array $parameters

Return Value

array

array _put(string $url = null, array $parameters = [])

Send a PUT request.

Parameters

string $url
array $parameters

Return Value

array

array _patch(string $url = null, array $parameters = [])

Send a PATCH request.

Parameters

string $url
array $parameters

Return Value

array

array _post(string $url = null, array $parameters = [])

Send a POST request.

Parameters

string $url
array $parameters

Return Value

array

array _options(string $url = null, array $parameters = [])

Send an OPTIONS request.

Parameters

string $url
array $parameters

Return Value

array

array execute(string $httpMethod, string $url, array $parameters = [])

Executes the HTTP request.

Parameters

string $httpMethod
string $url
array $parameters

Return Value

array