Get the Specified Customer

You can retrieve the properties of a customer with this request. Use the customer's ID to specify which customer's details you need to retrieve.


The Method

API Method
RESTGEThttp://[Your URL]/api/2.0/customers/:id
XML-RPCCallGetCustomer
Your URL is the address of your Everlytic install.

Your method must be structured as follows:

GetCustomer(integer $id) : object

Parameters

You must include the customer's ID in order for this request to return the correct details.

PropertyTypeDescriptionRequired
$idintegerThe id of the customer you want to retrieve.yes

Responses

TypeDescription
objectThe customer object.

Code Samples

PHP (using the REST API)

Tutorial

The rest of this document describes the example above, step-by-step.

In our Getting Started section we covered the four important components of an API request; URL, method, headers, and body.

RequestStructure

Let's analyse the code sample above to determine where each line fits into this outline.

1. Load the Everlytic API

The following line of code tells the server which API URL to access for the request:

$url = '(Your URL)/api/2.0/customers/:customer_id;

Your URL is the URL of your Everlytic installation.

2. Method

In this line of code, you tell the API which REST function to use:

$method = 'GET';

3. cURL

cURL is a tool for sending and receiving files from a web server. This line of code initialises the cURL session.

$cSession = curl_init();

4. Initiate the Headers

This section of the code opens the headers section and passes the authentication (including your API key).

$headers = array();

$auth = base64_encode($username . ':' . $apikey);

$headers[] = 'Authorization: Basic ' . $auth;

5. Set various cURL options for the session

These lines of code tell the server that we're using cURL to transfer data.

curl_setopt($cSession, CURLOPT_URL, $url);

curl_setopt($cSession, CURLOPT_RETURNTRANSFER, true);

curl_setopt($cSession, CURLOPT_HEADER, false);

curl_setopt($cSession, CURLOPT_CUSTOMREQUEST,

strtoupper($method));

curl_setopt($cSession, CURLOPT_HTTPHEADER, $headers);

6. Output the API response

$result = curl_exec($cSession);

7. Close the cURL session

curl_close($cSession);
Translate »