Check user credentials

Used for SSO systems using "POST".

Request

For every API request you make, you'll need to present the API access key in the HTTP Header as X-API-Key to be authenticated.

Parameters

Name	Required	Value	Description
username	required	string	Username
password	required	string	Password
create_login_url	optional	boolean	Pass true to create a short lived MyPage login url (Valid for 15 minutes)

Example code in PHP

$request_url = 'https://api.frontcore.com/v2/check-user-credentials';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $request_url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); 
curl_setopt($ch, CURLOPT_POST, true);

curl_setopt($ch, CURLOPT_HTTPHEADER, array(
  'X-API-Key: {your-api-key}',
  'Accept: application/json',
));
$result = curl_exec($ch);
curl_close($ch);
               

Response

If the method is successful it responds with an JSON structure, as it is shown below.

{
    "error": "Missing field(s): username,password"
}

Unsuccessful response sample:

{
    "error": "Wrong API Key"
}