Setup

To start importing Data via API, first a new importer of the type API / File upload must be created. This can be done in the Importer Configuration. After an importer is created, it will be shown in the list. Make sure that the enabled configuration of the importer is activated. Next to the name of the importer, the importerId is shown in brackets. This ID will be needed later to specify which importer should be used on the API calls.

Make sure to create and use one importer per datasource. One datasource represents one external system instance. If you have e.g. 2 Moodle instances, create also 2 importers. When starting an import, all the entries of the currently imported entity which were imported with this importer in previous imports will be deleted. E.g. Courses were imported once from system A and once from system B. Now when importing courses again from system A (with the importer for system A), all imported courses from system A will get replaced with the newly imported courses. Courses from system B won't get changed, since those courses correspond to the importer for system B.

To call the API importer programmatically, an apiRootAccessSecret must be defined in the System Configuration. This secret is needed to get a session token for API access. For more information about accessing the Flow API, check out the API root access example.