Understanding API File Import

In the API File Import Service setting, you can enable and disable the File Import Service API, see API credentials, and manage callback credentials for your imports. You can also find information regarding how to use the File Import Service API.

In this article, you'll find information about:

• What File Import Service is in Agillic
• Enable File Import Service API
• File Import Service API Credentials
• Manage Callback Credentials
• User File Import Service API

What is API File Import in Agillic

The File Import Service is a feature in Agillic for importing files. You can use the service to automatically transfer files with Person Data, One-to-Many Data, and data for a Global Data Table. With this http request to Agillic, you can apply a callback service, which will let your monitoring system register if the import file imported correctly.

The API File Import settings are found under the System Settings section in the Settings module. These same credentials can be used for the SFTP import option.

It's important to note that the maximum file size for files uploaded by using the API for File Imports is 64 Megabytes. You can also read more about the API File Import Service in our Developer Documentation.

Enable API File Import

When enabled, you can use the File Import API to import data. When disabled, all credentials for the File Import API are permanently deleted. Therefore, if you're re-enabling the File Import API, these credentials will change.

File Import API Credentials

Here, you can see the BasicAuth credentials you'll need to use the File Import API. These credentials are different for Agillic Staging and Production environments. You can reveal the secret key by clicking on it.

Manage Callback Credentials

If you want to use callbacks for file imports, you can manage credentials on a domain level for the services receiving those callbacks. You have the possibility to add a new domain with credentials and edit or delete credentials for a domain name already on the list. If a domain and valid credentials are not registered here, it can't be used for callbacks.

Use File Import Service API

Here, you can see the endpoint information for the File import API. If you enter a callback URL, you can see the endpoint URL which contains information regarding the callback URL. When you call the API with a request containing a callback URL parameter, the callback will be executed when the import process is finished. However, this only happens if the callback domain URL is registered in the 'Manage callback credentials' section.

For example, if the callback URL is www.thisisit.com/endpoint/no1 or www.thisisit.com/endpoint/no2, the service will search for callback credentials registered for www.thisisit.com. If found, the callback URL will be called using the registered credentials.

The API File Import Service setting section

Suggested Next Steps

• Best Practice on Importing Data to Agillic
• Understanding Data Import/Export