Gegevens kan je ophalen langs de GET-methode. Dit is de techniek die je ook gebruikt wanneer je eenvoudigweg een URL doorgeeft in een webbrowser.

Je kan dus bijvoorbeeld /api/v1/clients opgeven in een webbrowser om een lijst in XML te krijgen van alle klanten. Een ander voorbeeld: /api/v1/invoices/1001/payments. Wat een lijst teruggeeft met alle betalingen van factuur met ID 1001.

Geef het gewenste formaat op via de Accept-header of geef het formaat op in de querystring bijvoorbeeld ‘?format=json’. De mogelijke formaten zijn xml, json, csv en html.

Een voorbeeld in PHP hoe je  gegevens kan ophalen:

$p = curl_init('https://eenvoudigfactureren.be/api/v1/clients');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "X-API-Key: your_api_key_here",
    "Content-Type: application/json",
    "Accept: application/json"
]);
curl_setopt($p, CURLOPT_RETURNTRANSFER, TRUE);
$response = curl_exec($p);

if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
} else {
    echo $response;
}

curl_close($p);

Indien je een verkeerde URL opgeeft omdat bijvoorbeeld de gevraagde klant niet bestaat dan krijg je als response ook een JSON (of het gevraagde formaat) terug met de reden van de fout.

Vraagt je bijvoorbeeld de gegevens aan voor de onbestaande klant met ID 1001 met URL /api/v1/clients/1001 dan krijg je terug:

{
  "error": "client_id unknown"
}