Visma Developer portal, een account aanmaken, applicatie registreren en toegang tot de klantgegevens

[#1]

• Account aanmaken
• Een applicatie aanmaken
• Invitatiecode aanmaken

Account aanmaken 

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.

Bij het registreren gebruik het Kvk-nummer als Organization number

Startscherm na inloggen

Je kan desgewenst 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.

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.   

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
oftewel VRA_fileapi_ met daarachter je Visma|Raet-klantnummer.

Bij de IAM, Learning, Extensions en WFM API, oftewel bij de overige API's mag je de Client Id zelf kiezen.

Via deze applicatie met bijbehorende Client Id en Secret krijg je toegang de data en of bestanden uit de Youforce/HRCoreOnline-omgeving(en). 1 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).

Wordt de bestaande secret vergeten dan dien je een nieuwe aan te maken, deze wordt dan toegevoegd aan de reeds bestaanden. 

Via deze applicatie met bijbehorende Client Id en Secret krijg je toegang de data en of bestanden uit de Youforce/HRCoreOnline-omgeving(en). 1 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.

Via het tabblad Integrations kies het Visma|Raet API-product, oftewel je ‘basis’ API, je gebruikt hiervoor New integration.

De keuze bestaat uit:

Youforce IAM 

Youforce Learning  

Youforce Workforce Management (WFM)

Youforce File (voor de bestanden)

Als ‘tweede’ API, door nogmaals New integration te selecteren, kan je kiezen voor:

Youforce Extension API (maakt het mogelijk om per klant rubrieken (niet ingedeelde) toe te voegen aan de bijbehorende endpoints).

Youforce File API (wanneer het gaat om een combinatie tussen bijvoorbeeld een Youforce IAM API met een bestandsuitwisseling).

Visma|Raet dient de opgegeven API’s goed te keuren, dit gaat via een workflow in de portal, je hoeft daar niks voor te doen.

Per API dien je de Scope te 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 alle Scopes selecteren, een API kan ook bestaan uit 1 Scope.

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 stap ‘Visma App store’ naar de laatste stap.

Tabblad Visma App Store, op dit moment stellen wij de Visma App Store niet ter beschikking aan onze klanten. 

Voor toegang tot de klantdata stuur je een Invitation Code naar api.consulting.raet@visma.com, dit staat hieronder verder uitgelegd. Visma|Raet zal de toegang tot de klant-data dus goedkeuren en dan direct de koppeling van klantdata aan je applicatie gereed maken.

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, je ontvangt hier een e-mail van, kan je de volgende stap uitvoeren door de applicatie te koppelen aan klant-data, dit staat uitgelegd via Invitatiecode aanmaken.

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.

Kopieer de Invitation Code en stuur deze naar api.consulting.raet@visma.com

Visma|Raet zal de toegang tot de klant-data dus goedkeuren en dan direct de koppeling van klantdata aan je applicatie gereed maken. Je ontvangt een e-mail wanneer de toegang gereed is.

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