API - User Authentication¶

Login¶

URL: /account/login/
Method: POST

Code sample:¶

$api_id = 1;
$api_key = 'testpass';
$hostname = 'https://example.com'; // no trailing slash

# fetch data
$url = '/account/login/';
$post_data = array(
    'email' => 'test@example.com',
    'password' => 'pass',
);
$user_token = 'xxx'; // is required here. Get it from Your DB after Token generation
$extra_headers = array(
    'X-API-ID: ' . $api_id,
    'X-API-Hash: ' . md5($api_key . $url. http_build_query($post_data)),
    'X-User-Token: ' . $user_token
);

header('Content-Type: application/json; charset=utf-8');
echo sendRequest($hostname . $url, $post_data, $extra_headers);

Succes message: request_message contains the customer ID

{
    has_error: false,
    messages: [],
    results: {
        request_status: "ok",
        request_message: "1234" 
    }
}

Error message :

{
    has_error: true,
    messages: [
        "Already logged in" 
    ],
    results: [ ]
}

Logout¶

URL: /logout/
Method: GET

// ...
$url = '/logout/';
$post_data = array();
// ...

Succes message:

{
    has_error: false,
    messages: [ ],
    results: {
        request_status: "ok",
        request_message: "" 
    }
}