API koppeling beheren

Algemeen

Status: Productie
Update: 23 februari 2024
Door: Melissa

Beheer API koppeling

Deze dienst vereist Freedom licentie

Met de GET API-connector kunnen clients gebruikersgegevens ophalen, waaronder module-voltooiing, testscores, scores, voltooiing van cursussen en phishing-gegevens. De API-key en het API-secret worden gegenereerd in ‘organisatie bewerken’ en bieden een versleutelde verbinding.

Het implementeren van de Get API-connector biedt verschillende voordelen. Ten eerste kun je eenvoudig en efficiënt gebruikersgegevens extraheren, waardoor je tijd en moeite bespaart. Ten tweede stelt het ons systeem in staat om naadloos te integreren met andere platforms, wat de algehele ervaring verbetert.

De configuratie kan je ook vinden in het menu ‘organisatie bewerken’.

Voorbeeld configuratie

Course completed by date by user
Path: https://portal.2lrn4.com/api/courses

Header:
api_key
api_secret

Parameters:
date_from (optional, string, format: “Y-m-d”)
date_to (optional, string, format: “Y-m-d”)
users (optional, array)

Response (example):
  {
	"status": "success",
	"message": "Complete courses",
	"data": [
	  {
		"name": "John Doe",
		"email": "john@mail.test",
		"complete_courses": [
		  {
			"course": "Test Course",
			"start_at": "2023-01-01",
			"end_at": "2023-01-01",
			"complete_at": "2023-01-01"
		  }
		]
	  }
	]
  }