FileAPI voor dossierbestanden

[#1]

Wat
Het uitwisselen van bestanden met documenten vanuit Personeelsdossier en Salarisdossier vindt momenteel plaats via 'Zenden en Ontvangen' en de IBU. Dit geldt ook voor het aanbieden van bulkbestanden met documenten aan Personeelsdossier. Vanaf nu is het ook mogelijk om deze bestanden uit te wisselen met behulp van de FileAPI.

Waarom

De FileAPI is een modern alternatief voor 'Zenden en Ontvangen' die verdere integratie mogelijk maakt met de applicatie die de bestanden verwerkt. De FileAPI maakt gebruikt van nieuwere technieken waarmee er geen lokaal geïnstalleerde applicatie IBU) meer nodig is en ook het gebruik van een gebruikerscertificaat vervalt. 

In juli 2022 hebben we het artikel 'Van IBU naar File API' gepubliceerd in de Youforce API’s en Youforce Portaal communities om je te informeren over deze migratie en haar fasen. Hier lees je ook meer over de achtergrond van de overgang naar de FileAPI.

Hoe

Vanaf nu is het mogelijk om de FileAPI te gebruiken om exportbestanden uit Salarisdossier en Personeelsdossier te downloaden, en om importbestanden voor Personeelsdossier te uploaden. Hiervoor zijn een viertal 'business types' toegevoegd aan de FileAPI:

• BT 107000 Personeelsdossier Imports
• BT 107001 Personeelsdossier Exports
• BT 106000 Salarisdossier Gemal Export
• BT 136000 Salarisdossier Business Export

Om van de FileAPI gebruik van te maken is een account nodig op de Visma Developer Portal. Hier kun je een applicatie definiëren die gebruik gaat maken van één of meerdere van deze business types. Na acceptatie door Visma | Raet zullen de exportbestanden via de FileAPI beschikbaar worden gesteld. 

Voor het uploaden van bulkbestanden voor Personeelsdossier geldt dat deze via de FileAPI aangeboden kunnen worden en de bestanden worden vervolgens geimporteerd in Personeelsdossier.

Vooralsnog zullen de exportbestanden ook nog via 'Zenden en Ontvangen' worden aangeboden. Als de bestanden automatisch via de FileAPI worden opgehaald kun je deze verder negeren. Wel is het hierdoor mogelijk om de bestanden ook nog via 'Zenden en Ontvangen' op te halen als dat nodig is.

Indien u handmatig de bestanden op wilt halen kunt u gebruik blijven maken van 'Zenden en Ontvangen' en IBU. Op een later moment (Fase 3 van 'Van IBU naar File API' ) zal deze functionaliteit worden vervangen door een alternatief wat ook op de FileAPI zal worden gebaseerd.