De Visma Developer portal is te bereiken via
https://oauth.developers.visma.com/service-registry/home
en maak viaCreate accounteen account aan
De portal zal viado.not.reply@mail.connect.visma.com je een e-mail sturen met eenActivatie accountlink.
Gebruik bij het registreren hetKvk-nummeralsOrganization number
Startscherm na inloggen
Desgewenst kun je een collega toevoegen viaMy teamenNew member. Jullie hebben dan beiden inzicht in de gegevens van de applicatie.
De volgende stap is het aanmaken van een applicatie.
Door een applicatie aan te maken ontstaat er een API Key en een Secret Key die je gebruikt om de authenticatietoken op te halen.
Kies via het tabbladMy ApplicationsvoorAdd Application
Als application type selecteerService, 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 tabbladDetails.Weet dat de opgegevenClient Idwordt gebruikt als API key bij de API-aanroepen.
Je moet zelf deClient Idopgeven.
Testomgeving-Het is tevens mogelijk om gebruik te maken van onze sandbox. Met deze sandbox kun je testen. De applicatie voor de productieomgeving kan ook gekoppeld worden aan de sandbox. Maak hiervoor een 2eInvitation codeaan (deze stap wordt later toegelicht).
Via deze applicatie met bijbehorendeClient Iden Secret krijg je toegang de data en of bestanden uit de Youforce/HRCoreOnline-omgeving(en).Eén API key-set kan toegang geven tot meerdere klantomgevingen.
- Via deTenant Iddie je alsHeadermeestuurt bij het aanvragen van een authenticatie token bepaal je de benodigde klantomgeving.
- Access Token Lifetimemag op de default waarde blijven staan. Een aanpassing van deze waarde heeft geen effect op werking van de API, alsmede de optiesInclude JSON Web Token IDenTestApplication.
- Gebruik eerstSave as a draftom vervolgens de applicatie aan te maken viaCreate,viaNextga je naar het volgende tabblad.
Het tabbladCredentialsstelt je in staat om de API Secret aan te maken. Let op, deSecretwaarde wordt alleen getoond via de pop up bij het aanmaken, dus neem dit direct over. De pop up toont ook je eerder gekozenID(API key).
Let op:Wordt de bestaande secret vergeten dan dien je een nieuwe aan te maken, deze wordt dan toegevoegd.
Via het tabbladIntegrationsselecteer de gewenste Youforce API, oftewel je ‘basis’ API, je gebruikt hiervoorNew 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 en zolang de goedkeuring niet is verleend kan je de stap van deVisma App Storeniet uitvoeren.
Per API dien je deScopete selecteren welke gebruikt gaat worden in de applicatie. Op deze manier kun je bepaalde functionaliteiten (endpoints) binnen de Youforce API uitsluiten van je applicatie. Je kunt vanzelfsprekend ook alleScopesselecteren, een API kan ook bestaan uit 1Scope.
Het tabbladIntegrationskan je niet direct bevestigen viaSave, 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.De goedkeuring door Visma Raet kan enkele dagen duren en zolang de goedkeuring niet is verleend kan je de stap van deVisma App Storeniet uitvoeren.
Je kan door te klikken op stap ‘Visma App store’ naar de laatste stap (mits Visma Raet de API('s) heeft goedgekeurd).
TabbladVisma App Store,op dit moment stellen wij deVisma App Storeniet ter beschikking aan onze klanten.
Voor toegang tot de klantdata genereer je eenInvitation 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.
NaStart setup for Visma App Storeziet u onderstaand scherm en dan kies je bijAccess level - AudiencevoorInvite only
Vul ook de url in waar uw product is uitgelegd.
Je bent nu klaar met het aanmaken van de applicatie, de optieSavewordt zichtbaar op het moment dat Visma Raet de applicatie heeft goedgekeurd, je kunt het aanmaken sluiten door bijvoorbeeld opBack to my Applicationste 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 ‘Invitatiecode aanmaken’.
Met een invitatiecode maak je het mogelijk de klantgegevens op te halen via je applicatie.
Ga naar de Developer Portalhttps://oauth.developers.visma.com/service-registry/home
Kies voorMy Applications. En klik op het potloodje achter de applicatie (Edit).
Kies voor het tabbladVisma App Store. En vervolgensNew Invitation Code.
BijInvitation descriptionvul je de naam van de betreffende klant in. En klik vervolgens opGenerate.
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 schermIntegrationsis via de tabbladTenants(default wordt het tabbladScopesgetoond) terug te zien welke klanten (tenants) gekoppeld zijn aan je applicatie. Dit scherm laat ook de bijbehorendeTenantIDzien. DeTenantIDis benodigd bij het opvragen van de authenticatie token.
Voorbeeld van eenTenant ID
Testomgeving-Het is tevens mogelijk om gebruik te maken van onze sandbox. Met deze sandbox kun je testen. De applicatie voor de productieomgeving kan ook gekoppeld worden aan de sandbox. Maak hiervoor eenInvitation codeaan en deel die met Visma Raet.
