Autorisatiebeheer
De Bestandsuitwisseling module is nu “Algemeen Beschikbaar” voor HR Core Online gebruikers. Dit betekent dat je geen 4Me-ticket meer hoeft in te vullen om Bestandsuitwisseling voor de gebruikers te activeren (zie hier), maar dat je zelf de autorisatie kunt toekennen in Autorisatiebeheer. Bestandsuitwisseling is de vervanger van handmatig Zenden/Ontvangen met IBU.
Vanaf heden zal de applicatie Bestandsuitwisseling standaard beschikbaar in Autorisatiebeheer. De autorisatie van elke gebruiker voor de verschillende file types kan door de Autorisatiebeheer administrator worden gedaan door het toekennen van de juiste rechten.
Jouw Actie
Volg de stappen zoals beschreven in dit artikel.
Als je gebruikers hebt die (handmatig) toegang hebben verkregen via de 4me template ‘Van Zenden & Ontvangen naar Bestandsuitwisseling HR Core Online’ autoriseer hun dan voor de juiste rollen (De handmatig toegevoegde rechten zijn niet zichtbaar in Autorisatiebeheer). De handmatig toegevoegde rechten zullen per 1 December worden verwijderd en vanaf dan gelden alleen de toegekende rechten in Autorisatiebeheer.
Nieuwe tegel op het Youforce Desktop
Bestandsuitwisseling is op dit moment beschikbaar in Mijn Youforce, maar kan ook worden bereikt via de "Bestandsuitwisseling" -tegel op de Youforce Desktop. In dat laatste geval moet de tegel wel worden geautoriseerd via Toegangsbeheer.
Met ingang van 11 oktober 2023 ondersteunt de Bestandsuitwisseling app ook de Nederlandse taal. De taal die wordt gebruikt volgt de persoonlijke instellingen die je in Mijn Youforce hebt gedaan.
Dit zijn de fixes sinds versie 1.22:
Het upload script logde nog niet in de Monitor file. Dit is verholpen.
Verbeterde afhandeling bij het verwijderen van tijdelijke bestanden
Bug opgelost waarbij het genoemde aantal bestanden voor uploaden verkeerd werd getoond als er maar 1 bestand klaar stond om te uploaden.
Upload script maakte log bestand aan met de verkeerde naam. Dit is verholpen.
Volg de instructies in ons kennisbank artikel om de nieuwste scripts (1.24) te installeren.
Op 19-02-2024 hebben wij een nieuwe versie (1.22) van de PowerShell scripts gepubliceerd met de volgende verbeteringen:
Vermelding van de minimale vereiste .NET versie 4.8 in de readme bestanden.
Verbetering van het download proces.
Verplicht gebruik van TLS 1.2 toegevoegd in het Upload script.
Vermelding van versies van: de PowerShell scripts, Windows en .NET versie tbv een betere ondersteuning.
Je vind de PowerShell scripts hier.
Het endpoint Assignment (inzet) is toegevoegd aan de learning & Recruitment API
De url van het endpoint is respectievelijk: GET https://api.youforce.com/learning/v1.0/Assignments
GET https://api.youforce.com/recruitment/v1.0/Assignments
Het endpoint laat de volgende gegevens zien:
Deze gegevens zijn afkomstig van het scherm "inzet" uit Beaufort.
De afgelopen periode zijn de volgende verbeteringen in de API's doorgevoerd:
Extensions API uitgebreid met endpoints voor de Basic API
Vanaf nu is het ook mogelijk om de Youforce Extension API te gebruiken in combinatie met de Basic API.
De nieuwe endpoint zijn:
GET ..extensions/v1.0/basic/persons
GET ..extensions/v1.0/basic/employments
Deze endpoints zijn enkel te gebruik in combinatie met de Basic API. Zie voor meer Eigen rubrieken met de Extensions API
Recruitment API uitgebreid met endpoint voor aannemen medewerker
De recruitment API is uitgebreid met een endpoint voor het aannemen van een nieuwe medewerker. Binnen dit proces wordt onderscheid gemaakt tussen het aannemen van een nieuwe medewerker en het creëren van een nieuw dienstverband voor een bestaande medewerker.
Om dit proces te ondersteunen, is er ook een endpoint ontwikkeld waarmee u kunt controleren of een persoon al in de Beaufort-omgeving bestaat.
Het endpoint "Search person" stelt u in staat om te zoeken op verschillende velden, zoals voornaam, geboortenaam, geboortedatum en geboorteplaats. Ten minste één van deze zoekvelden is verplicht. Dit endpoint geeft maximaal 10 resultaten terug.
Op basis van het resultaat van dit endpoint kan het recruitment systeem bepalen of er sprake is van een een geheel nieuwe medewerker of enkel van een nieuw dienstverband bij een bestaande medewerker. Het recruitment systeem kan vervolgens één van de volgende endpoints starten:
POST hires: Hiermee wordt een workflow voor het aannemen van een nieuwe medewerker in HR Self Service gestart, waarbij de gegevens vanuit de API als standaardwaarden worden overgenomen.
POST Contract: Hiermee wordt een workflow voor het creëren van een nieuw dienstverband in HR Self Service gestart, waarbij de gegevens vanuit de API als standaardwaarden worden overgenomen.
Tevens is een endpoint toegevoegd waarmee contractwijzigen kunnen worden doorgegeven. Dit is bijvoorbeeld relevant bij interne sollicitaties. Het endpoint is:
POST contract/adjustments: Hiermee wordt een workflow voor het wijzigen van een bestaand dienstverband in HR Self Service gestart, waarbij de gegevens uit de API als standaardwaarden worden overgenomen.
Consultancy De recruitment API biedt diverse mogelijkheden om de API nader te configureren. Deze mogelijkheden kunnen tijdens de implementatie door onze consultants toegelicht worden. Status De API is op dit moment nog Controlled Available. Zodra de eerste integraties zijn ontwikkeld zullen we u hier nader over informeren.
Nieuwe functionaliteit en verbeteringen
Toegang via Autorisatiebeheer
HR Core Online gebruikers en overige gebruikers maken nu gebruik van Autorisatiebeheer om toegang te krijgen tot de Bestandsuitwisseling module. Het toe te kennen recht is “Toegang tot Bestandsuitwisseling”.
File Type Autorisatie via Autorisatiebeheer
Op dit moment vindt de gebruikers autorisatie voor de ondersteunde file types nog plaats via een 4me request en wordt afgehandeld door Product Development
In de nabije toekomst zal deze gebruikers autorisatie voor ondersteunde file types ook via Autorisatiebeheer verlopen, en zal het 4me request niet meer nodig zijn.
Nieuw Test File Type: Bestandsuitwisseling Test
Een nieuw file type is gedefinieerd in Bestandsuitwisseling voor test doeleinden.
Dit file type kan al geautoriseerd worden via Autorisatiebeheer.
Op dit moment kan het file type worden gebruikt om te testen of bestanden correct worden ingezonden door Bestandsuitwisseling.
Doorloop de volgende stappen om dit file type te gebruiken:
1 - Voeg het nieuwe recht “Bestandsuitwisseling Test - Zenden” toe in Toegangsbeheer, onder de Applicatie “Bestandsuitwisseling”.
2 - Ga naar de Bestandsuitwisseling applicatie en click op “Send Files”.
3 - Selecteer het nieuwe file type in de dropdown en Zend een willekeurig test bestand.
4 - Als het bestand succesvol is ingestuurd verschijnt het in de “Sent Files” lijst
{English below}
Nieuw
IAM API: Nieuw endpoint voor lezen cost allocation (Loonverdelingsregels)
De IAM API is uitgebreid met een nieuw endpoint voor het ophalen of lezen van de loonverdelingsregels van een medewerker uit Beaufort. De Loonverdelingsregels van Beaufort bevatten onder andere de kostenplaats(en) waarop de medewerker werkzaam is.
Het endpoint bevat de volgende gegevens
Persoonsnummer van de medewerker
Dienstverband volgnummer van de medewerker
Volgnummer loonverdelingsregel
Kostenplaats
Kostensoort
Kostendrager
Percentage van de loonverdeling
De loonverdeling betreft altijd de actuele situatie zoals die is vastgelegd in het scherm "Loonverdeling" in Beaufort.
De loonverdelingsregels kunnen opgevraagd worden via het endpoint:
https://api.youforce.com/iam/v1.0/CostAllocations
De API kan met verschillende parameters gebruikt worden
Full list
GET https://api.youforce.com/iam/v1.0/CostAllocations
By ID
GET https://api.youforce.com/iam/v1.0/CostAllocations/35001%201%201
Filter by Person Code
GET https://api.youforce.com/iam/v1.0/CostAllocations?personCode=35001
[english]
New
IAM API: New endpoint for cost allocation (Beaufort Loonverdeldingsregels)
The IAM API has been expanded with a new endpoint for cost allocation. With this new endpoint IAM systems can get the cost allocation records of an employee from Beaufort. The cost center is one of the attributes of this new endpoint.
The cost allocation entity concerns always the current situation as it is recorded in Beaufort with the screen "Loonverdeling".
You can access the enpoint with the url:
https://api.youforce.com/iam/v1.0/CostAllocations
You can use the endpoint with the following parameters
Full list
GET https://api.youforce.com/iam/v1.0/CostAllocations
By ID
GET https://api.youforce.com/iam/v1.0/CostAllocations/35001%201%201
Filter by Person Code
GET https://api.youforce.com/iam/v1.0/CostAllocations?personCode=35001
Verbergen van bestanden in Ontvang pagina.
We hebben regelmatig vragen gekregen of het mogelijk was om in Bestandsuitwisseling in de Ontvang pagina bestanden te kunnen verwijderen als je ze niet wilt ontvangen. Sommige van jullie krijgen zoveel bestanden in de lijst die je niet echt wilt ontvangen dat deze bestanden het moeilijker maken de bestanden die je WEL wilt ontvangen te vinden en te ontvangen.
Met ingang van 1 feb 2024 is het bij Bestandsuitwisseling nu mogelijk om bestanden in de Ontvang pagina te 'Verbergen' als je ze niet wilt ontvangen.
We hebben gekozen voor de term Verbergen omdat de bestanden niet echt worden verwijderd bij deze functionaliteit, maar ze worden niet meer getoond in de Ontvang bestandslijst waardoor je eenvoudiger de bestanden die je WEL wilt ontvangen kunt vinden. Doordat de bestanden niet echt worden verwijderd is het gedurende 30 dagen nog mogelijk om met de juiste filters de verborgen bestanden weer zichtbaar te maken en eventueel alsnog te ontvangen.
Dit artikel beschrijft hoe je de Verberg functionaliteit kunt gebruiken.
LET OP! Als je bestanden verbergt zijn ze ook niet meer zichtbaar voor andere gebruikers van Bestandsuitwisseling binnen jouw bedrijf.
De bestanden worden zoals vermeld echter niet verwijderd uit Bestandsuitwisseling. Verderop in het artikel wordt uitgelegd hoe je met de juiste filters ook de verborgen bestanden weer in de lijst zichtbaar kan maken zodat je ze eventueel nog kunt ontvangen.
Nieuw Acties ikoon Verberg
Er is een nieuw Acties ikoon zichtbaar waarmee het geselecteerde bestand verborgen kan worden. Als je op het ikoon klikt dan wordt het bestand direct verborgen en is hij niet meer zichtbaar in de lijst.
Deze optie kan heel handig zijn als je meerdere bestanden tegelijkertijd wilt ontvangen maar er staan in de lijst ook bestanden die je niet wilt ontvangen. Als je de gewenste bestanden niet allemaal individueel wilt selecteren, verberg dan eerst de bestanden die je niet wilt ontvangen en vink daarna de Selectie box aan in de rij met kolomnamen om alle nog zichtbare bestanden te selecteren voor ontvangen.
Aangepaste filters
Om optimaal gebruik te kunnen maken van de nieuwe functionaliteit zijn de filters iets aangepast.
Als de Ontvang pagina wordt geopend worden standaard de bestanden die Ontvangen status 'Nog Niet Ontvangen' en Verberg status 'Zichtbaar' hebben, getoond. Dat is dezelfde functionaliteit als in de oude situatie.
Het is mogelijk de verborgen bestanden weer in de lijst te tonen door bij de Verberg status de optie 'Verborgen' te activeren.
Door op de 'Bekijk Resultaten' knop te klikken worden nu ook de verborgen bestanden getoond.
Met dit 'Verberg status' filter worden alle bestanden, Zichtbaar en Verborgen, getoond.
Verborgen bestanden kun je herkennen aan een vinkje in de Verberg kolom.
Net als bij ontvangen bestanden kun je bij verborgen bestanden op het (naar beneden) vinkje klikken in de meest linkse kolom om te zien wie het bestand verborgen heeft.
Ontvangen van verborgen bestanden.
Belangrijk om te weten is dat ook verborgen bestanden nog steeds kunnen worden ontvangen. Hiervoor moet je dan wel eerst de Verborgen optie activeren in het Verberg status filter. Als het bestand dan in de lijst wordt getoond kun je het, zoals gewend, ontvangen door op het Acties ikoon Ontvangen te klikken.
De afgelopen periode zijn de volgende verbeteringen in de API's doorgevoerd:
Extension API uitgebreid met een nieuw endpoint op basis van de historie tabel
De extension API is uitgebreid met een nieuw endpoint employment/timelines. Dit nieuwe endpoint is gebaseerd op de historie tabel in Beaufort, waardoor het mogelijk is per element een ingangdatum weer te geven. Het endpoint werkt op een vergelijkbare wijze als het employment endpoint in de extensie API.
Onderstaand voorbeeld laat het onderscheid tussen beide endpoints zien.
employments
Dit endpoint toont de waarde van de betreffende rubriek uit het actuele model van Beaufort.
Employments/timelines
Dit endpoint toont de waarde van de betreffende rubriek uit de historie tabel van Beaufort.
Om dit endpoint te kunnen gebruiken moet de historie voor het betreffende veld geactiveerd zijn. Dit kunt u doen in het scherm Rubrieken in Beaufort.
Daarnaast moeten de rubrieken ook als extentie in de API geconfigureerd zijn. Dit kan gedaan worden door een API consultant van Visma Raet.
Met ingang van 16 oktober 2023 biedt Bestandsuitwisseling de mogelijkheid om meerdere bestanden in 1 keer te ontvangen.
Ga hiervoor als volgt te werk:
Ga naar de Ontvang bestanden pagina
Klik in de rij of zet het vinkje aan in de Selectie kolom van de bestanden die je wilt ontvangen
Klik op de Ontvang Geselecteerde Bestanden knop rechtsboven op de pagina De bestanden worden nu in een zipbestand in je browser Download directory ontvangen De naam van het zipbestand heeft het formaat Bestandsuitwisseling_20231016103134.zip
Unzip de bestanden door rechts te klikken op het zip bestand en Uitpakken te selecteren. Indien je Windows versie de zipbestanden niet standaard herkent moet je eerst een ZIP tool installeren.
Extra informatie:
Door het vinkje in de 1e rij aan te zetten selecteer je alle getoonde bestanden op deze pagina in 1 keer.
Nogmaals op dat vinkje klikken de-selecteert alle geselecteerde bestanden.
Als maar 1 bestand is geselecteerd en je klikt de Ontvangen Geselecteerde Bestanden knop, dan wordt het bestand niet gezipt maar ontvangen alsof je het bestand individueel hebt ontvangen.
Je kunt nog steeds bestanden individueel ontvangen door zoals gewoonlijk op de Ontvang knop helemaal rechts in de rij te klikken.
Nieuwe functionaliteit en verbeteringen
Veld effectiveDate toegevoegd aan adresgegevens (Alle API's)
In het endpoint Person is bij de adresgegeven het veld effectiveDate toegevoegd. Dit veld komt overeen met het veld 'Adres m.i.v.' uit het Beaufort scherm Additionele adresgegevens Persoon (rubriek P011012 / P01011) . Het veld is beschikbaar in alle API met een endpoint Person.
Mededelingen
Youforce Developer Portal gaat offline
Begin juni wordt de Youforce Developer Portal (https://developers.youforce.com/) offline gehaald. Daarmee is het niet meer mogelijk om applicaties te aan te melden op de Youforce Developer portal. Nieuwe applicatie en credentials moeten vanaf nu via de Visma Developer Portal (https://developer.visma.com/) aangemaakt worden.
Voor klanten die nog credentials uit de oude Youforce Developer Protal in gebruik hebben, veranderd er op dit momenteel nog niets. De credentials blijven geldig en werken met de domein api's en file API. Wel wordt u verzocht om, in samenspraak met uw software leverancier, over te stappen op de Visma Developer Portal.
Meer informatie over de Visma Developer Portal vindt u op de community via onderstaande links:
De nieuwe Visma Developer Portal
Een API-applicatie overzetten naar de Visma Developer Portal
Nieuwe functionaliteit en verbeteringen
De afgelopen periode zijn de volgende verbeteringen in de API's doorgevoerd:
De velden kostenplaats, kostendrager, kostsoort en type toegevoegd aan het endpoint Assignment (WFM & IAM api)
Het endpoint Assignment in de WFM en IAM api is uitgebreid met de volgende velden:
costCenter - P01128 - Kostenplaats Inzet
costUnit - P01129 - Kostendrager Inzet
costType - P01127 - Kostensoort Inzet
type - P01123 - Soort Inzet
Extensions API uitgebreid met extra endpoints voor het Recruitment domain
Vanaf nu is het ook mogelijk om de Youforce Extension API te gebruiken in combinatie met de Recruitment API. Zie hiervoor het algemeen gebruik van de extension API Eigen rubrieken met de Extensions API
De nieuwe endpoint hiervoor zijn:
api.youforce.com/extensions/v1.0/recruitment/persons
api.youforce.com/extensions/v1.0/recruitment/employments
Tips
Gebruik api.youforce.com
Op dit moment kunt u voor de domein API's zowel de url api.youforce.com als ook de url api.raet.com gebruiken. We adviseren u echter om zoveel mogelijk de url api.youforce.com te gaan gebruiken. De komende tijd blijven beide url's zeker nog actief maar de toekomst kan daar mogelijk verandering in komen. Om deze verandering voor te zijn, adviseren wij u de url api.youforce.com te gebruiken.
De afgelopen periode zijn de volgende verbeteringen in de API's doorgevoerd:
Alle API's Extra scope voor het onboarding van klanten Bij alle API's een extra scope toegevoegd. Deze extra scope is onderdeel van het goedkeuringsproces binnen Visma Raet. Deze extra scope heeft als voordeel dat wij sneller de invite code voor een bepaalde klant kunnen accepteren en invite codes dus minder snel zullen verlopen.
Als software leverancier vragen wij u om deze scope standaard toe te voegen aan nieuwe applicaties die u aanmaakt. Ook als u een applicatie heeft waarop nog nieuwe klanten aan toegevoegd zullen worden, dan vragen wij u deze scope te activeren. De scope heeft geen effect op de werking van de API zelf maar is uitsluitend bedoeld om het proces sneller en transparanter te laten verlopen.
Youforce MLM master data API Concept versie beschikbaar De afgelopen periode is de eerste versie van de Youforce MLM master data API op de Visma developer Portal gepubliceerd. Deze API bevat de basis HR gegevens voor een Medical Leave Management systeem en kan in combinatie met het SIVI bericht gebruikt worden. De API zelf bevat geen verzuimgegevens. Voor de verzuimgegevens is het SIVI bericht Verzuimmeldingen beschikbaar.
Onderstaand domein model geeft een overzicht van entiteiten en endpoint die beschikbaar zijn binnen deze API.
Voor een volledige beschrijving van de API wordt verwezen naar de documentatie over de Youforce MLM master data API.
De afgelopen periode zijn de volgende verbeteringen in de API's doorgevoerd:
Alle API's Privé contactgegevens niet standaard zichtbaar in API
In alle API's is een aparte scope opgenomen voor de privé contactgegevens, zoals adres, telefoonnummer en emailadres. Dit betreft de scope GetPrivateContactDetails. Standaard is deze scope niet geactiveerd en worden de privé contactgegevens niet in de API weergegeven, alleen het zakelijke emailadres (P01035) en het telefoonnummer werk (P01037) wordt dan in de API getoond.
Wilt u privé contact gegevens wel willen gebruiken in uw applicatie dan zult u dat bij uw uw software leverancier moeten aangeven zodat zij de scope voor de applicatie kunnen activeren. Ook zal een de API consultants de autorisatie op uw data moeten wijzigen. Zie ook eerdere bericht Nieuwe scope voor privé contactgegevens zoals adres, telefoonnummer en emailadres
IAM API Het Veld UserUID is toegevoegd aan het endpoint persons
Voorheen was het alleen mogelijk om het UserUID op te halen via het GET User endpoint in de IAM API, wat betekende dat het UserUID per persoon opgevraagd moest worden. Vanaf nu is het mogelijk om het veld standaard op te halen via het Person endpoint, waardoor alle UserUID's van alle medewerkers eenvoudig opgehaald kunnen worden.
Extra controles in PATCH User endpoint
Er zijn enkele controles toegevoegd aan het patch user endpoint. Er wordt nu strenger gecontroleerd op het formaat van de aangeboden json in de body, waarbij het veld "id" vereist is en niet mag worden ondergebracht in een sub-entiteit zoals "User" of "Users". Raadpleeg het artikel IAM user endpoint voor de juiste aanroep. Daarnaast wordt er bij de update van de identiteit gecontroleerd of het gebruikersaccount bestaat. Als het gebruikersaccount niet in de Youforce-omgeving wordt gevonden, wordt er een 404-not found melding teruggegeven. Dit kan bijvoorbeeld het geval zijn als het veld "Youforce gebruiker" (P15013) in Beaufort op "Nee" staat. Endpoints voor het schrijven van zakelijk email adres en telefoonnummer toegevoegd
Er zijn nieuwe endpoints toegevoegd aan de IAM API voor het terugzetten van het zakelijke e-mailadres (P01035) en telefoonnummer (P01037).
De endpoints zijn:
Endpoint
Toelichting
POST /iam/v1.0/contactDetails/[PersonCode] Met in de body:
{
"emailAddress": "demo@visma.com",
"phoneNumber": "010-12345678"
}
Voor het schrijven van het zakelijk email adres en/of telefoonnummer van een individuele medewerker.
POST /iam/v1.0/contactDetails/bulk met in de body:
[
{
"personCode": "10000",
"emailAddress": "bulk.01@visma.com",
"phoneNumber": "030-12344567"
},
{
"personCode": "100001",
"emailAddress": "bulk_02@visma.com",
"phoneNumber": "0341-23457"
}
]
Voor het schrijven van het zakelijk email adres en/of telefoonnummer van meerdere medewerkers gelijktijdig. Maximaal 100 medewerker per API call.
GET /iam/v1.0/ContactDetails/[ticketId]/status waarbij het [ticketId] uit de response van oorspronkelijke POST endpoint gebruikt moet worden.
Endpoint voor ophalen van de status van het terugschrijven.
De afgelopen periode zijn de volgende verbeteringen in de API's doorgevoerd:
WFM API
Nieuwe endpoints voor Employments en Salary Details beschikbaar De WFM API is uitgebreid met 2 nieuwe endpoints voor Employments en Salary Details. Beide endpoint zijn gebaseerd op de historie tabel van Beaufort waardoor de endpoints de ingangsdatum bevat. De nieuwe endpoints zijn:
employmentTimelines
salaryDetailTimelines
Het endpoint employmentTimelines bevat dezelfde velden als het oorspronkelijk endpoint employments maar dus nu ook inclusief ingangsdatum waardoor er een soort tijdlijn ontstaat. Hetzelfde geldt voor de endpoints salaryDetailTimelines en salaryDetails. Voor zowel het endpoint employmentTimelines als ook het endpoint SalaryDetailTimelines geldt dat data met ingangsdatum uit de historie tabel komen. In de standaard inrichting van Beaufort staat voor deze rubrieken de historie aan (zie Beaufort scherm standaard rubrieken). Onderstaand een voorbeeld van het nieuwe endpoint employmentTimelines
Op dit moment wordt de API data voor deze nieuwe endpoints één keer per dag om 18:00 UTC met Beaufort gesynchroniseerd.
Alle domein API's
Het endpoint organisation units is uitgebreid met de velden indicatie geblokkeerd, kostenplaats en adresgegevens.
Het endpoint organisation units van zowel de Learning, IAM als ook de WFM api is uitgebreid met de volgende API velden:
isBlocked (True/false)
Address
PhoneNumber
CostCenterCode
Deze velden komen overeen met de volgende gegevens uit Beaufort.
Note: het veld isBlocked (Inactief) wordt in Beaufort vaak gebruikt om organisatie eenheden inactief te maken tijdens een reorganisatie. Deze indicatie wordt dan gebruikt om aan te geven dat er geen nieuwe medewerkers meer op de organisatie eenheid mogen worden geplaatst. Echter bij een reorganisatie komt het regelmatig voor dat bestaande medewerkers nog herplaatst moeten worden. De indicatie IsBlocked wil dus niet zeggen dat er geen medewerkers meer aan gekoppeld zijn.
Visma Developer Portal
Vanaf nu zijn alle domein API inclusief alle endpoints te gebruiken via de Visma Developer portal. De Visma Developer Portal (https://oauth.developers.visma.com/) vervangt hiermee de oudere developer portal als de Youforce developer portal (https://developers.youforce.com/) of Raet developer portal (https://developers.raet.com/)
note: De meest recente aanpassing betreft het endpoint Get users. Vanaf nu werkt ook dit GET users endpoint in de learning en IAM api met een Visma account uit de Visma developer portal. Heeft u nog credentials op één van de oude developer Portal dan kunt u die nog blijven gebruiken. Echter nieuwe credentials kunnen alleen nog aangemaakt worden via de Visma Developer Portal. Zie hiervoor: Aanmaken credentials Visma Developer Portal
Ook adviseren wij u om met uw applicatie over te gaan naar de nieuwe Visma Developer portal. De Visma developer portal heeft als voordeel dat u en u collega samen de apps en credentials kunt beheren. Wel zijn daarbij enkele aandachtspunten waarmee uw development omgeving rekening moet houden, zie onderstaande tabel.
Oude Raet developer portal
Oude Youforce Developer Portal
Nieuwe Visma developer Portal
Authencation token
url: https://api.raet.com/authentication /token
Met in de Body de volgende authenticatie gegevens uit de Raet developer portal:
client_id
client_secret
url: https://api.youforce.com/authentication /token
Met in de Body de volgende authenticatie gegevens uit de Youforce developer portal:
client_id
client_secret
url: https://connect.visma.com /connect/token
Met in de Body de volgende authenticatie gegevens uit de Visma developer portal:
client_id
client_secret
tenant_id
Let op: De tenant_id is dus toegevoegd aan de authencation en wordt tussen de endpoint meegegeven in de bearer token.
GET User endpoint
niet beschikbaar
In learning API is het endpoint beschikbaar via verschillende url versie zoals v0.1 en v.1.0 GET https://api.youforce.com//learning/v0.1/ users (employeeId=xxxx) GET https://api.youforce.com//learning/v1.0/ users (employeeId=xxxx)
In de Learning en IAM is het endpoint enkel beschikbaar via de url versie v1.0 GET https://api.youforce.com//learning/v1.0/ users(employeeId=10010)
All endpoints
base url: api.raet.com met de volgende gegevens in de header
bearer authorisation token uit het raet.com authorisation token
Tenant_id. Dit is een 7-cijferig nummer dat de klant binnen Raet identificeert
base url: api.youforce.com met de volgende gegevens in de header
bearer authorisation token uit het youforce.com authorisation token
Tenant_id. Dit is een 7-cijferig nummer dat de klant binnen Raet identificeert
base url: api.youforce.com met de volgende gegevens in de header
bearer authorisation token uit het visma.com authorisation token. In dit visma token zit de tenant_id al verwerkt
Note: Het tenant_id hoeft dus niet meer bij elke API call meegegeven worden. Wordt de tenant_id per ongeluk wel meegegeven in de API call dan wordt deze genegeerd Daarnaast blijven de endpoints via de base url api.youforce.com
De afgelopen periode zijn er weer een aantal verbeteringen in de API's doorgevoerd.
API's nu ook beschikbaar via Visma developer portal
De Visma developer portal is binnen de Visma groep de centrale plaats voor delen en publiceren van API's uit de Visma groep voor derden. Om hierbij aan te sluiten hebben we de afgelopen periode de IAM en Learning API op de Visma developer portal gepubliceerd. De IAM en Learning API is ook nog beschikbaar via de oude Raet developer portal waardoor bestaande integraties niet zullen wijzigen.
Voor nieuwe integraties zal er door de API consultant veelal voor gekozen worden om deze via de nieuwe Visma developer Portal te ontsluiten. Ook nieuwe API zullen in de toekomst enkel nog via deze nieuwe Portal gepubliceerd worden. Onze API consultants zullen developers en klanten tijdens de implementatie hierbij begeleiden.
Een uitgebreide beschrijving voor het aanmaken van een account staat beschreven op de deze pagina. Wij adviseren uit echter om vooraf eerst contact op te nemen met onze API consultant (api.consulting.raet@visma.com). Zij kunnen aanvullende uitleg geven over het gebruik van de Visma Developer portal.
Extension API toegevoegd aan Visma developer portal
In de nieuwe Visma Developer portal is de Extensie API als uitbreiding op een domein API, zoals zoals de IAM of Learning API, beschikbaar gekomen. Met deze extensie API is het mogelijk om extra velden aan de domein API toe te voegen. Bijvoorbeeld het toevoegen van een klant eigen rubriek behorende bij de persoon of het dienstverband.
De extensie API dient altijd in combinatie met één van de domein API gebruikt te worden. Tevens kunnen enkel niet-ingedeelde rubrieken op het niveau Persoon of Dienstverband aan de API toegevoegd worden. Het toevoegen van extra velden kan op dit moment geregeld worden door een API consultant. Uiteraard geldt wel dat het ontvangende systeem ook met extra velden en endpoints overweg moet kunnen gaan. Een uitgebreide beschrijving is te vinden op deze pagina
De extensies kunnen per per klant en domain API verschillend. Voor respectievelijk de IAM en learning API hebben wij de volgende endpoints beschikbaar. api.youforce.com/extensions/v1.0/IAM/persons api.youforce.com/extensions/v1.0/IAM/employments api.youforce.com/extensions/v1.0/learning/persons api.youforce.com/extensions/v1.0/learning/employments
Afhankelijk van de gekozen endpoint worden de extensies op persoons- of dienstverband niveau weergegeven. Indien de rubriek in Beaufort bestaat uit veld met een referentie tabel dan wordt ook de bijbehorende omschrijving uit de referentietabel in het endpoint weergegeven. Zie onderstaand voorbeeld bij rubriek API002.
In this update you can find the improvements and solved issues in the domain api's.
Improvements
IAM API: New fields are added to the employment endpoint
The following fields are added to the employment endpoint.
PayrollClientCode ( P01103 Opdrachtgever)
PayrollInsittutionCode ( P01104 Instelling)
Classification ( P01110 - Code doelgroep)
Learning API: User endpoint added to version 1.0
The user endpoint is added to version 1.0 of the learning API. This endpoint will return the unique ID of the user which can be used for the SSO process of a customer.
For example:
GET https://api.youforce.com/learning/v1.0/users(employeeId=10010)
By adding this endpoint version 1.0 of the learning API is backwards compatible with version 0.1.
Action API Consumer:
We ask you to change the url of you api call to this new version. Version 0.1 is deprecated from now.
Solved issues
Learning API : Texts with special chars were not displayed correctly [VRINA-1613]
Special characters for the fields 'FirstNames' or 'KnownAs' were not correctly processed in the API database. As result to API shows the name incorrectly.
For example:
-> "KnownAs": "Desirée"
was showed as:
-> "KnownAs": "Desir?e"
The issue is solved.
Het endpoint Job profiel is uitgebreid met de volgende velden:
De velden zijn beschikbaar in alle API met het endpoint Job Profile.
De data van de velden is afkomstig van het scherm Functie uit Beaufort.
De afgelopen periode zijn de volgende verbeteringen in de API's doorgevoerd:
Eerste versie Basic API beschikbaar
Er is een eerste versie van de Basic API beschikbaar. Deze API is bedoeld voor systemen die niet onder een van onze standaard domein API's vallen, maar toch basis HR gegevens nodig hebben. De Basic API bevat een set basisfunctionaliteiten met endpoints die doorgaans voldoende zijn voor integratie met het HR Core-systeem.
De Basic API bevat de volgende endpoints:
GET Persons
GET Employments
GET Organisation Units
GET Role Assignments
GET Job Profiles
Performance- & stabiliteitsverbeteringen
De afgelopen maand zijn er een aantal performance- en stabiliteitverbeteringen doorgevoerd . We hebben de integratie met Beaufort geoptimaliseerd, waardoor mutaties in HR Core Beaufort sneller zichtbaar zijn in de API. Deze prestatieverbetering geldt voor alle endpoint, met uitgezonderd van het employee endpoint.
Het 'employee' endpoint is gebaseerd op een verouderde infrastructuur waardoor verdere prestatieverbetering niet mogelijk is. Als u problemen ondervindt met het 'employee' endpoint dan raden wij u aan over te stappen op het 'Person' en 'employment' endpoint voor het ophalen van de gegevens.
Tevens is de afgelopen periode de filters from/to voor het ophalen van de gewijzigde records verbeterd. In eerdere release werd nog vaak een record als gewijzigd gemarkeerd, terwijl de gegevens ongewijzigd bleek te zijn. We hebben updateproces verbeterd om te voorkomen dat onnodig veel records als gewijzigd worden gemarkeerd. Wij verwachten dat dit de belasting op uw systeem zal verminderen, met name voor systemen die werken op basis van gewijzigde records. Deze wijziging geldt voor alle endpoint, uitgezonderd van het employee endpoint
Het employee endpoint
Zoals wij al eerder hebben aangegeven wordt het 'employee' endpoint niet verder ontwikkeld, en we raden u aan over te stappen op het 'person' en 'employment' endpoint. Het 'employee' endpoint blijft wel beschikbaar in de huidige vorm, maar verdere prestatieverbeteringen zijn niet mogelijk.
Als u momenteel het 'employee' endpoint gebruikt voor uw integratie, kan het langer duren voordat mutaties uit Beaufort zichtbaar zijn in de API.
Mocht dit in uw geval tot problemen leiden, dan adviseren wij u om de integratie om te zetten naar de 'Person' en 'Employment' endpoints. Deze endpoint bevatten dezelfde informatie als het 'employee' endpoint maar kennen dus een betere performance. Uw software leverancier kan u informeren of hun applicatie al gebruikmaakt van deze verbeterde endpoints.
Zie ook het eerdere bericht : Vervanging Employee endpoint door Persons en Employee endpoint