Roosterplaats API

Gewijzigd op Mon, 01 Apr 2024 om 04:36 PM

Wilt u gegevens importeren, exporteren vanuit Roosterplaats voor het koppelen aan uw eigen administratie? Door middel van onze API kan er een koppeling gerealiseerd worden en kunnen gegevens uitgewisseld worden. Hierbij moet u denken aan het ophalen van roosters, medewerkers, toevoegen van beschikbaarheid, etc..

Inschakelen van de API
De API kan ingesteld worden door in het menu te gaan naar "Instellingen" en vervolgens in het submenu te kiezen voor "API Toegang". Het is mogelijk om meerdere IP-adressen op de Whitelist te zetten. Op deze pagina is het tevens mogelijk om de API in en uit te schakelen.

De API is bereikbaar op: https://roosterplaats.nl/api/v1/

Berichtformaat

De API geeft resultaat terug in JSON formaat en kent de volgende opbouw:

[Request] bevat de input parameters van het verzoek en de status van de response.
[Data] bevat een array met de response data volgens de endpoint definities

{
    "[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
                }
            ]
        }
    ]
}

Voorbeeld script

Het onderstaande eenvoudige PHP script (gebaseerd op cURL) biedt de 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>";
?>

Endpoint beschrijving

De endpoint specificaties kunt uw hier vinden: API endpoints

Neem contact met ons op voor verdere support of suggesties.