Roosterplaats API: koppelen met uw eigen administratie

Met de Roosterplaats API koppelt u Roosterplaats aan uw eigen administratie. Zo haalt u gegevens op of wisselt u ze uit, bijvoorbeeld roosters, medewerkers, beschikbaarheid, verlof, ziekmeldingen en gewerkte uren. De API is bereikbaar op https://roosterplaats.nl/api/v1/ en geeft antwoord in JSON.

De API inschakelen

  1. Ga naar Instellingen en kies API-toegang.
  2. Zet API inschakelen aan. Op deze pagina zet u de API ook weer uit.
  3. Vul bij Toegestane IP-adressen de IP-adressen in die de API mogen gebruiken. Met + IP-adres voegt u er meer toe.
  4. Gebruik de beveiligingscode (token) van deze pagina bij elk verzoek. Met Nieuwe code maakt u een nieuwe; de oude werkt dan na opslaan niet meer.

De pagina API-toegang in de instellingen van Roosterplaats, met beveiligingscode en toegestane IP-adressen

Berichtformaat

De API geeft het resultaat terug in JSON, met deze opbouw:

  • [request] bevat de parameters van het verzoek en de status van het antwoord.
  • [data] bevat de gegevens volgens de specificatie van het endpoint.

Voorbeeld van een antwoord:

{
    "[request]": {
        "path": "/api/v1/schedule/employees/2024/8/",
        "arguments": {
            "year": "2024",
            "week": "8"
        },
        "status": "success",
        "date": "2024-03-29 15:39:25"
    },
    "[data]": [
        {
            "id": 1512,
            "firstName": "Joanne",
            "lastName": "de Vries",
            "hourlyRate": 10,
            "contractType": "vast",
            "contractHours": 32,
            "totalScheduledHours": 9,
            "totalScheduledCosts": 90,
            "scheduledShifts": [
                {
                    "departmentName": "Balie",
                    "departmentId": 869228,
                    "shiftName": "Dagdienst",
                    "shiftId": 2332577,
                    "AllowancePercentage": 100,
                    "scheduledStart": "2024-02-19 09:00",
                    "scheduledEnd": "2024-02-19 18:00",
                    "scheduledHours": 9,
                    "scheduledBreakTime": 0.5,
                    "scheduledCosts": 90
                }
            ]
        }
    ]
}

Voorbeeldscript in PHP

Dit eenvoudige PHP-script (gebaseerd op cURL) is een basis om verbinding te maken met de Roosterplaats API:

<?php

$apiKey = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx'; // Roosterplaats beveiligingscode (token)
$baseurl = 'https://roosterplaats.nl/api/v1/';
$endpoint = 'schedule/details/2024/8/';

$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => $baseurl . $endpoint,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "x-api-key: $apiKey"
    ]
]);

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

$data = json_decode($response, true);

echo "<pre>";
print_r($data);
echo "</pre>";

Beschikbare endpoints

Heeft u vragen of suggesties voor de API? Neem contact met ons op.

Laatst bijgewerkt:

Stel uw vraag via WhatsApp