API

Wat is het?

Een API (Application Programming Interface) is een interface die ervoor zorgt dat twee applicaties met elkaar kunnen communiceren. Dit gebeurt door middel van verzoeken (requests) die naar een ander systeem of dienst worden gestuurd, waarna een antwoord (response) wordt ontvangen met de benodigde gegevens of de bevestiging van een uitgevoerde actie. Een API stelt duidelijke regels op over hoe deze verzoeken moeten worden gedaan, welke gegevens nodig zijn en hoe de antwoorden moeten worden geretourneerd.

Voor de producten van Paragin zijn er API’s beschikbaar waarmee bepaalde processen geautomatiseerd kunnen worden, zoals het toevoegen van deelnemers en gebruikers, het ophalen van toetsresultaten, of het beheren van gebruikersgroepen. Het gebruik van deze API’s is kosteloos en er is documentatie beschikbaar, zodat je zelfstandig aan de slag kunt met de implementatie.

Hoe implementeer je een API?

Om een API te implementeren, is het belangrijk om eerst een ontwerp te maken waarin je bepaalt welke gegevens tussen welke systemen moeten worden uitgewisseld. Vervolgens moet een ontwikkelaar de API-endpoints inrichten, de benodigde logica implementeren en deze integreren in de eigen applicaties.

Bij het integreren van een REST API is basiskennis van HTTP-methoden (zoals GET en POST), statuscodes en JSON essentieel, omdat dit het gebruikte formaat is voor gegevensuitwisseling. Tools zoals Postman (voor het testen van API-verzoeken) en cURL (voor command-line verzoeken) zijn handig, net als kennis van API-authenticatie (bijvoorbeeld met API-sleutels). Het proces omvat het lezen van de API-documentatie, het testen van endpoints, het schrijven van code om verzoeken te versturen, het verwerken van antwoorden, en het oplossen van eventuele problemen. Het gebruik maken van een API en het automatiseren van de gegevensverwerking wordt doorgaans door een software-ontwikkelaar uitgevoerd.

Hoe richt ik de API voor een omgeving in?

Afhankelijk van de ingestelde rechten in een omgeving kun je zelf een API koppeling toevoegen aan de omgeving.

• In Remindo kun dit in de beheeromgeving via het menu Instellingen -> Beheer algemene instellingen, tabblad API of in de afname-omgeving via het menu Beheer -> Instellingen, tabblad API.
• In MijnPortfolio kan dit via de menuknop Instellingen -> API (oauth).
  Op deze locaties kan ook de API documentatie en voorbeeldcode gedownload worden.

Zie je deze menuopties niet, maar wil je wel een API instellen? Neem dan eerst contact op met een beheerder van deze specifieke omgeving. Lukt dat niet, neem dan contact op met support@paragin.nl en vermeld in welke omgeving je de API wilt instellen.

Ondersteuning bij het inrichten

Nadat een API koppeling is toegevoegd aan de omgeving kan de organisatie zelf aan de slag met de implementatie van onze API. Wij begeleiden deze implementatie niet, iemand met voldoende technische kennis zou met behulp van onze documentatie deze koppeling tot stand moeten kunnen brengen.

Mochten er vragen zijn over de documentatie en/of functionaliteiten dan kunnen deze uiteraard gesteld worden aan support@paragin.nl.