Connexys REST API's

Print

Met de Connexys REST API's is het mogelijk om informatie op te halen, in te voeren en bij te werken. De REST techniek maakt het mogelijk om externe systemen op relatief eenvoudige wijze te koppelen.

Er worden meerdere endpoints aangeboden. De exacte werking wordt in technisch detail omschreven in de online API documentation. Deze documentation is beschikbaar zodra er ingelogd wordt bij de API playground.

Account

Om in te loggen op een API playground is een account benodigd. Dit account kan worden aangemaakt door de Customer Support. Aanvragen kan via een ticket, telefonisch, 010-4980 988 of via de chat.

Let op! De API's zijn standaard onbereikbaar gemaakt. Vraag dit ook na bij Customer Support.

Inloggen

Om in te loggen op de API playground moeten de volgende stappen worden gezet. 

1: Achterhaal de bedrijfsnaam van de applicatie van de afdeling HR / Recruitment 

2: Voeg deze bedrijfsnaam toe aan de volgende URL: 

https://<bedrijfsnaam>.api.connexys.nl/login

3: Voer de verkregen accountgegevens op

4: Indien de inlog succesvol is, zal de API playground de link naar de Documentation tonen. 

Playground

Documentation

Binnen de Playground is alle documentatie beschikbaar over de beschikbare API's en endpoints. Door te klikken op een entiteit verschijnt er een gedetailleerd overzicht van de beschikbare endpoints met daarin additionele mogelijkheden. 

Playground test mogelijkheden

Onder het tabblad 'API' is er per entiteit ook een Playground beschikbaar. Met deze playground kan er live worden getest zonder dat dit resulteert in vervuiling van de database. Het is dus mogelijk om een request uit te voeren en resultaat te krijgen, zonder iets te posten of te committen.

In het geval van een GET wordt er alleen een 'Submit' knop getoond. Bij de overige opties wordt er een 'Request body' invoerveld getoond met daarin een default request.

Hebt u meer vragen? Een aanvraag indienen

Opmerkingen