|
<< Click to Display Table of Contents >> Navigation: Instellingen > Instellingen - Koppelingen |
Regelneef API
De API biedt de mogelijkheid om via externe toepassingen te koppelen met de betreffende Regelneef database.
API sleutel
De API is beveiligd met een unieke code. Deze code is op te vragen met de optie API sleutel. Beschouw deze code als geheim, en deel deze alleen met degene die een koppeling met uw database moet maken.
De API is per onderdeel te activeren door het aan te vinken:
Aanvragenlijst
Doel |
Het opvragen van aanvragen uit het systeem in JSON formaat, doorgaans voor gebruik als lijst van openstaande vacatures op een website. |
Formaat |
GET https://services.sunbase.nl/api/extern/regelneef/aanvragen?apikey=[Key]&selection=[SelectionId]&statusids=[StatusIds] |
Parameters |
apikey: de bovengenoemde sleutel 2: Alle aanvragen met een actieve status 3: Alle aanvragen met een specifieke status die een vinkje 'Gepubliceerd' hebben 4: Alle aanvragen met een specifieke status
statusids: één of meer interne nummers van specifieke statussen, alleen nodig bij selection waarde 3 of 4 |
Voorbeelden |
https://services.sunbase.nl/api/extern/regelneef/aanvragen?apikey=UwApiKey&selection=1 |
Import Inbox
Doel |
Het naar Regelneef versturen van een importbestand, zodat een gebruiker dit bestand in de importmodule kan verwerken. |
Formaat |
POST https://services.sunbase.nl/api/extern/regelneef/importfiles |
Parameters |
De body moet een JSON string bevatten, zoals bijvoorbeeld "Filename": "example.xml", "Data": "SGVsbG8sIFdvcmxkIQ==", "Type": "1" } Filename: de bestandsnaam van het importbestand. De extensie is belangrijk, de importmodule zal die gebruiken om het bestand op de juiste manier te openen. Data: de inhoud van het bestand, gecodeerd als Base64 Type: 1 (vaste waarde) |
Headers |
De aanroep moet in ieder geval de volgende headers bevatten: Content-Type application/json
Authorization apikey UwApiKey |
Bestandslocaties
Exportbestanden schrijven in
In dit pad worden standaard de exportbestanden geschreven door de verschillende exportmodules.
Importbestanden lezen in
In dit pad worden standaard de importbestanden gelezen door de verschillende exportmodules.
Freepack export
Indien de vastlegging van rekeninggegevens primair in Freepack bijgehouden wordt, is het verstandig om Bankrekening gegevens van medewerker exporteren uit te vinken. Regelneef zal dan nooit bankrekening gegevens opnemen in het exportbestand, waardoor er geen bankgegevens onbedoeld overschreven kunnen worden in Freepack.
Indien WGA inhouding bij medewerker aangevinkt is, zal bij exporteren naar Freepack hier altijd Ja voor worden geschreven. Is het niet aangevinkt, dan is de standaardwaarde van Freepack van toepassing.
Vink Scholier pas aan wanneer de medewerkers die volgens Freepack scholier zijn, ook in Regelneef zijn aangevinkt.
Indien u wilt voorkomen dat er medewerkers zonder personeelsnummer naar Freepack geëxporteerd worden kan Alleen uzk exporteren met personeelsnummer worden aangevinkt. Regelneef voert dan een validatie uit alvorens het bestand te exporteren.
De Regelneef Transporter kan worden aangevinkt om het versturen van bestanden van en naar Freepack makkelijker te maken. Er worden dan extra opties zichtbaar in de verschillende export- en importschermen.
Zie ook de onderwerpen Exporteren en Importeren.