REST API: GET /users/{id}

Lees eerst de basisinformatie over de REST API.

Gegevens van een specifieke lener

Het toegangspunt GET /users/{id} laat je toe om de gegevens van een specifieke lener op te vragen.

URL parameters

• id: Colibris ID van de lener, of het e-mailadres van de lener

JSON resultaat

• code: HTTP response code (bv. 200 voor een correct resultaat)
• response: data van de lener

API Voorbeeldcode in PHP

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://api.colibris.be/users/000002",
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_CONNECTTIMEOUT => 5,
    CURLOPT_TIMEOUT => 15,
    CURLOPT_HTTPHEADER => array(
	'X-Api-User: API_USER',
	'X-Api-Login: API_LOGIN',
	'X-Api-Key: API_KEY',
	'Content-Type: application/json'
    ),
));

$data = curl_exec($curl);
$http_code = curl_getinfo($curl, CURLINFO_HTTP_CODE);
$err = curl_error($curl);
curl_close($curl);

if ($err) {
    echo "Error #:" . $err;
} else {
    print_r($data);
}
?>

API Voorbeeldantwoord

{
    "code": "200",
    "response": [
        {
            "id": "000002",
            "naam": "Peeters",
            "voornaam": "Lili",
            "email": "lili@peeters.be",
            "email_melding": "",
            "pass": "",
            "taal": "nl",
            "sp1": "2C",
            "sp2": "",
            "externe_id": "00006789",
            "groep": "|",
            "notitie": ""
        }
    ]
}

Het wachtwoord zal steeds leeg zijn.

Meer informatie over de verschillende velden vind je in het artikel over het importeren van leners.