Van IBU naar File API - HR Core OnPremise - Aan de Slag

[#1]

• Introductie
• 1 - Inventariseer om welke bestanden het gaat
• 2 - Account aanmaken op Visma Developer Portal
• 3 - Een applicatie aanmaken
• 4 - Invitatiecode aanmaken
• 5 - Dien een ticket in via Mijn Support
• 6 - Pas systemen aan om gebruik te maken van File API
• 7 - Implementeer de nieuwe File API oplossing in uw eigen omgeving.

Introductie

Voor de overgang van de IBU (Automatisch) naar File API kun je de volgende opties in overweging nemen:  

1. Je kunt dit volledig zelf doen
2. Consultancy afspraak van een uur waarin wij de file API en benodigde stappen uitleggen.
3. Consultancy afspraak van 4 uur (Intake 1 uur + 3 uur verdere inrichting)  waarin we onderstaande stappen gezamenlijk doorlopen.

Voor optie 2 en 3 (het inplannen van een consultancy afspraak) kan je in Mijn Support een nieuwe aanvraag indienen, kiezen voor soort consultancy (API), optie Aanvraag consultancy en vervolgens de benodigde informatie velden invullen. 

Indien je ervoor kiest om de inrichting zelf te doen, volg dan onderstaande stappen:

1. Inventariseer om welke bestanden het gaat.
2. Maak een Account aan op Visma Developer Portal
3. Maak een applicatie aan op Visma Developer Portal
4. Maak een Invitatiecode aan op Visma Developer Portal
5. Dien een ticket in via ‘Mijn support’
6. Pas systemen aan om gebruik te maken van File API
7. Implementeer de nieuwe File API oplossing in uw eigen omgeving. 

1 - Inventariseer om welke bestanden het gaat

Jullie Customer Success Manager heeft inzicht in het gebruik van IBU en kan daar op verzoek een lijst van aanleveren. Een overzicht van alle file types die in de File API beschikbaar zijn vind je hier. Kijk op deze pagina ook naar de beschikbare file types per Youforce module.

2 - Account aanmaken op Visma Developer Portal

De Visma Developer portal is te bereiken via 

https://oauth.developers.visma.com/service-registry/home

en maak via Create account een account aan

De portal zal via do.not.reply@mail.connect.visma.com  je een e-mail sturen met een Activatie account link.

Gebruik bij het registreren het Kvk-nummer als Organization number

Startscherm na inloggen

Desgewenst kun je een collega toevoegen via My team en New member. Jullie hebben dan beiden inzicht in de gegevens van de applicatie.

De volgende stap is het aanmaken van een applicatie (zie stap 3).

3 - Een applicatie aanmaken

Door een applicatie aan te maken ontstaat er een API Key en een Secret Key die je gebruikt om de authenticatietoken op te halen. Bij het gebruik van de File API raden we je aan om een aparte applicatie aan te maken per Youforce module.

Kies via het tabblad My Applications voor Add Application

Als application type selecteer Service, dit is het enige type wat door Visma|Raet wordt ondersteund.

Het aanmaken van de applicatie gaat via vier tabbladen, vul de gegevens in op het eerste tabblad Details. Weet dat de opgegeven Client Id wordt gebruikt als API key bij de API-aanroepen. 

Je moet zelf de Client Id opgeven, om je bij vragen sneller van dienst te kunnen zijn, vragen wij je om bij het gebruik van de File API de waarde alsvolgt te kiezen:
VRA_fileapi_6412345_Gemal
oftewel VRA_fileapi_ met daarachter je Visma|Raet-klantnummer en module. 

Let op: De Applicatienaam en Client Id heb je nodig in stap 5  om de autorisatie aan te vragen.

Let op: 

Testomgeving - Indien je de API wilt koppelen aan jullie eigen testomgeving vragen wij je om bij het gebruik van de File API de waarde als volgt te kiezen:

VRA_fileapi_6412345_Gemal

oftewel VRA_fileapi_ met daarachter je Visma|Raet-klantnummer van de testomgeving en module. 

Het is tevens mogelijk om gebruik te maken van onze sandbox. Met deze sandbox kun je 3 dummy testfiles testen. De applicatie voor de productieomgeving kan ook gekoppeld worden aan de sandbox. Maak hiervoor een 2e invitation code aan. 

Via deze applicatie met bijbehorende Client Id en Secret krijg je toegang tot de data en of bestanden uit de Youforce omgeving(en). Eén API key-set kan toegang geven tot meerdere klantomgevingen.

• Via de Tenant Id die je als Header meestuurt bij het aanvragen van een authenticatie token bepaal je de benodigde klantomgeving.

• Access Token Lifetime mag op de default waarde blijven staan. Een aanpassing van deze waarde heeft geen effect op werking van de API, alsmede de opties Include JSON Web Token ID en TestApplication.

• Gebruik eerst Save as a draft om vervolgens de applicatie aan te maken via Create, via Next ga je naar het volgende tabblad.

Het tabblad Credentials stelt je in staat om de API Secret aan te maken. Let op, de Secret waarde wordt alleen getoond via de pop up bij het aanmaken, dus neem dit direct over. De pop up toont ook je eerder gekozen ID (API key).

Let op: Wordt de bestaande secret vergeten dan dien je een nieuwe aan te maken, deze wordt dan toegevoegd.

Via het tabblad Integrations selecteer je Youforce File (voor de bestanden), oftewel je ‘basis’ API, je gebruikt hiervoor New integration.

Visma | Raet zal de opgegeven API’s goedkeuren. Dit gaat via een workflow in de portal, je hoeft daar niks voor te doen. De goedkeuring door Visma | Raet kan enkele dagen duren.

Per API dien je minimaal 1 Scope te selecteren welke gebruikt gaat worden in de applicatie. Door de juiste scopes te selecteren voorkom je dat de API per ongeluk voor de verkeerde actie (download of upload) wordt gebruikt. Maar je mag vanzelfsprekend ook alle Scopes selecteren. 

Scopes	Betekenis
businesstypes list	In de toekomst zal deze scope publishers en subscribers toestaan om informatie te krijgen over businesstypes. Op dit moment is het alleen mogelijk voor een publisher om op te vragen of er een subscriber is voor een specifieke tenant/businesstype combinatie.
files delete	Deze scope staat subscribers toe om bestanden te verwijderen zonder ze eerst te downloaden.
files download	Deze scope staat subscribers toe om bestanden te downloaden, alsook publishers om bestanden die zij zelf geüpload hebben te downloaden.
files upload	Deze scope staat publishers toe om bestanden te uploaden.
files list	Deze scope staat subscribers toe om bestanden weer te geven, alsook publishers voor de bestanden die zij zelf geüpload hebben.

Als een API bijv. alleen voor inzenden (publisher) voor een module wordt gebruikt dan is  de 'files download' scope niet nodig en niet selecteren voorkomt dat je hem toch per ongeluk voor downloaden gebruikt.

Het tabblad Integrations kan je niet direct bevestigen via Save, dat kan pas op het moment dat Visma|Raet de gekozen API’s bij de applicatie heeft goedgekeurd, dit gaat via een flow je hoeft hier niks voor te doen. 

Je kan door te klikken op tab ‘Visma App store’ naar de laatste stap.

Voor toegang tot de klantdata genereer je een Invitation Code. Hoe je dit doet staat hieronder verder uitgelegd. Visma | Raet zal de toegang tot de klant-data goedkeuren en dan direct de koppeling van klantdata aan je applicatie gereedmaken.

Na Start setup for Visma App Store ziet u onderstaand scherm en dan kies je bij Access level - Audience voor Invite only

Vul ook de url in waar uw product is uitgelegd.

Je bent nu klaar met het aanmaken van de applicatie, de optie Save wordt zichtbaar op het moment dat Visma | Raet de applicatie heeft goedgekeurd, je kunt het aanmaken sluiten door bijvoorbeeld op Back to my Applications te klikken. 

Wanneer Visma | Raet de goedkeuring heeft verleend, ontvang je hier een e-mail van en kun je de volgende stap uitvoeren door de applicatie te koppelen aan klant-data. Dit staat uitgelegd in het volgende hoofdstuk 4 ‘Invitatiecode aanmaken’.

4 - Invitatiecode aanmaken

Met een invitatiecode maak je het mogelijk de klantgegevens op te halen via je applicatie.

Ga naar de Developer Portal https://oauth.developers.visma.com/service-registry/home 

Kies voor My Applications. En klik op het potloodje achter de applicatie (Edit). 

Kies voor het tabblad Visma App Store. En vervolgens New Invitation Code.

Bij Invitation description vul je de naam van de betreffende klant in. En klik vervolgens op Generate.

Let op: De Invitation Code heb je nodig in stap 5 om toegang te vragen tot de klant-data.

Visma | Raet zal de toegang tot de klant-data goedkeuren en dan direct de koppeling van klantdata aan je applicatie gereedmaken.

Binnen het beheer van je applicatie en het scherm Integrations is via de tabblad Tenants (default wordt het tabblad Scopes getoond) terug te zien welke klanten (tenants) gekoppeld zijn aan je applicatie. Dit scherm laat ook de bijbehorende TenantID zien. De TenantID is benodigd bij het opvragen van de authenticatie token.

Voorbeeld van een Tenant ID

5 - Dien een ticket in via Mijn Support

Dien een ticket in via Mijn Support met de invitation code en het verzoek om autorisatie.

Vermeld in het ticket de volgende gegevens:

Klantnummer:	Je Visma|Raet relatienummer
Naam IT medewerker	Degene die de File API bij jullie installeert
Telefoonnummer IT medewerker
Email IT medewerker
Invitatiecode	Deze code heb je aangemaakt in stap 4
Client Id	De Client Id heb je aangemaakt in stap 3
Applicatienaam	De Applicatienaam heb je aangemaakt in stap 3
File type	De file types die je met deze applicatie gaat zenden of ontvangen. Bijv: 101015 - HR Core EDI INH 101029 - HR Core UWV DigiZSM

6 - Pas systemen aan om gebruik te maken van File API

Payroll Gemal Direct en Betaalmanager dienen te worden aangepast  om bestanden via de File API te kunnen ontvangen. Zie link voor meer informatie per systeem.

7 - Implementeer de nieuwe File API oplossing in uw eigen omgeving. 

Vraag een IT collega met verstand van schedulen en het opstellen van powershell scripts om het stappenplan te volgen.

Je vind de voorbeeld powershell scripts op deze pagina.