Mijn Communities
Help

Een API-applicatie overzetten naar de nieuwe Visma Developer portal

25-01-2023 11:31 (Bijgewerkt op 24-05-2023)
  • 0 Antwoorden
  • 0 kudos
  • 1062 Weergaven

Visma|Raet maakt nu gebruik van de Developer portal van Visma, een portal waar u API-applicaties kunt aanmaken en beheren. Met deze portal heeft u niet alleen toegang maar hebben uw collega's ook toegang tot de aangemaakte applicaties.

 

Wat moet u doen om gebruik te maken van de nieuwe portal?

 

Raadpleeg de oude portal

Log in op de oude portal (developers.youforce.com) en raadpleeg via het scherm 'Your apps' de API-applicaties die u nu beschikbaar heeft, ter info applicaties met het kenmerk 'Production' zijn daadwerkelijk gekoppeld aan de gegevens uit HRCoreOnline, applicaties met het kenmerk 'Sandbox' geven toegang tot test-data.

Onthoud de applicaties en de daarbij horende Youforce API.

 

Maak een account aan op de Visma Developer Portal

Een werkinstructie is via onderstaande link beschikbaar:

https://community.visma.com/t5/Kennisbank-Youforce-API/Visma-Developer-portal-een-account-aanmaken-a...

 

Maak de applicaties aan

De applicaties die u heeft via de oude portal kunt u opnieuw aanmaken, kies daarbij vanzelfsprekend de Youforce API die ook gekoppeld is aan de oude applicatie:

https://community.visma.com/t5/Kennisbank-Youforce-API/Visma-Developer-portal-een-account-aanmaken-a...

 

Autoriseer de applicatie

De aangemaakte applicatie geeft nog geen toegang tot de gegevens uit HRCoreOnline, maak hiervoor een 'invitatiecode' aan, hoe staat hier beschreven:

https://community.visma.com/t5/Kennisbank-Youforce-API/Visma-Developer-portal-een-account-aanmaken-a...

 

Voor de FileAPI dient Visma|Raet nog een extra autorisatie-stap uit te voeren. Vermeld daarom in de e-mail die u verstuurt met de invitatiecode ook de benodigde Youforce-bestanden (businessTypeID's).

 

De API-applicatie is nu gereed voor gebruik, u kunt de nieuwe en de oude applicatie beide gelijktijdig gebruiken.

 

Voer de wijzigingen door in uw aanroep van de API

 

In onderstaande tabel staat links de oude werkwijze en via 'Nieuwe Visma developer Portal' de wijzigingen door het gebruik van de nieuwe portal. De impact zit in de stap waarbij de authenticatie-token wordt opgehaald.

Bij gebruik van de FileAPI zit er ook een wijziging in de URL.

 

De tenant_id wijzigt door de nieuwe portal, in plaats van het van een 7-cijferig nummer is het nu een langere string, onder de tabel staat een plaatje hoe u de nieuwe tenant_id kunt achterhalen.

 

  Oude
Raet developer portal
Nieuwe
Visma developer Portal
Authencation token

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.

File API

File API basis path moet gewijzigd worden van https://api.raet.com/mft/v1.0” 

naar “https://fileapi.youforce.com/v1.0

 

Learning API GET User endpoint

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 API is het endpoint enkel beschikbaar via de url versie v1.0

GET https://api.youforce.com//learning/v1.0/ users(employeeId=10010)

Alle API's

All endpoints

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 

 

Nieuwe tenant_id

Via je applicatie, Integrations en het tabblad Customers kan je de tenant ID van inzien:

 

 
WeslyvanHorssen_1-1674642661138.png

 

 

 

 

 

Medewerkers