REST API: GET /catalog

Lees eerst de basisinformatie over de REST API.

Gegevens van een specifiek item

Het toegangspunt GET /catalog laat je toe om de gegevens van een specifiek item in de catalogus op te vragen.

URL parameters

• type: objecttype in Colibris (bv. 1 = boek, zie Instellingen > Collectie > Itemtypes)
• obid: objectID in Colibris (6 cijfers, op te vragen via Collectie > Item bewerken > Titelgegevens, zie screenshot hieronder)

JSON resultaat

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

API Voorbeeldcode in PHP

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://api.colibris.be/catalog/?type=1&obid=000001",
    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": [
        {
            "type": "Boek",
            "datum_invoer": "2017-03-23 09:58:34",
            "laatste_update": "2020-06-03 17:12:08",
            "barcode": "9789023438052",
            "titel": "Het laatste bed : een verhaal",
            "auteur": "Claus, Hugo",
            "jaar": 1998,
            "uitgever": "De Bezige Bij",
            "editie": "1",
            "collatie": "Hardcover - 77 p.",
            "url": "",
            "classificatie": "",
            "land_taal": "Nederlands",
            "synopsis": "Twee vrouwen komen logeren in hotel LUXOR",
            "serie": "",
            "deel": "",
            "genre": "Literatuur & Romans",
            "sp1": "",
            "sp2": "",
            "sp3": "",
            "sp4": "",
            "sp5": "",
            "foto": "https:\/\/app.colibris.be\/--covers--\/978\/90234\/9789023438052.jpg"
        }
    ]
}

Meer informatie over de verschillende velden vind je in het artikel Omschrijving titelgegevens

De URL van de foto wordt automatisch samengesteld, maar er is geen garantie dat er op die URL ook effectief een foto te vinden zal zijn.

Lijst met recente aanwinsten

Wanneer er geen parameters worden meegegeven in het toegangspunt GET /catalog, dan krijg je een lijst met recente aanwinsten. Dit zijn maximaal 50 titels die het laatst zijn toegevoegd aan de catalogus, dus gerangschikt volgens de datum van invoer (aflopend).

JSON resultaat

• code: HTTP response code (bv. 200 voor een correct resultaat)
• response: data van elk individueel item

API Voorbeeldcode in PHP

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://api.colibris.be/catalog",
    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": [
        {
            "type": "Boek",
            "datum_invoer": "2024-11-09 10:17:04",
            "laatste_update": "2024-11-09 10:17:04",
            "barcode": "9789462917934",
            "titel": "Felix",
            "auteur": "Verreth, Katleen",
            "jaar": 2024,
            "uitgever": "Uitgeverij De Eenhoorn",
            "editie": "1",
            "collatie": "Hardcover - 200 p.",
            "url": "",
            "classificatie": "",
            "land_taal": "Nederlands",
            "synopsis": "Korte inhoud",
            "serie": "",
            "deel": "",
            "genre": "Jeugdboek",
            "sp1": "",
            "sp2": "",
            "sp3": "",
            "sp4": "",
            "sp5": "",
            "foto": "https://app.colibris.be/--covers--/978/94629/9789462917934.jpg"
        },
        {
            "type": "Boek",
            "datum_invoer": "2024-11-09 09:12:19",
            "laatste_update": "2024-11-09 09:12:19",
            "barcode": "9789002266263",
            "titel": "De Kiekeboes 154 - Iemand moet het doen",
            "auteur": "Merho",
            "jaar": 2019,
            "uitgever": "Standaard Uitgeverij - Strips & Kids",
            "editie": "",
            "collatie": "48 p. - ill.",
            "url": "",
            "classificatie": "",
            "land_taal": "",
            "synopsis": "Korte inhoud",
            "serie": "",
            "deel": "",
            "genre": "Stripboeken, Manga & Graphic Novels",
            "sp1": "",
            "sp2": "",
            "sp3": "",
            "sp4": "",
            "sp5": "",
            "foto": "https:\/\/app.colibris.be\/--covers--\/978\/90022\/9789002266263.jpg"
        },
    ]
}

Meer informatie over de verschillende velden vind je in het artikel Omschrijving titelgegevens

De URL van de foto wordt automatisch samengesteld, maar er is geen garantie dat er op die URL ook effectief een foto te vinden zal zijn.