If you're building a API client, this covers how to tell the client what settings should be set or not set in the client. This will make things a lot cleaner as we can avoid server side error messages, and provide client side validation.
URL: The GET request needs to be sent to /account, i.e. https://filetransfer.example.com/account.
Request
| Parameter | Description |
|---|---|
| api_key | The users API key |
Example Request
<?xml version="1.0" encoding="UTF-8"?> <user> <api_key>9i5ZbfUFCyqULHLnvxfYVL</api_key> </user>
Response
| Response | Type | Description |
|---|---|---|
| api_version | string | The API version (2) so it's possible to detect changes from the client if this gets changed again in future releases. |
| filetransfer_version | string | The version number of the Filetransfer appliance, mostly for troubleshooting |
| api_client_size_override | integer | The value (in Megabytes) for API clients (such as the Outlook plugin) when to override the normal client behaviour and send files through the Filetransfer appliance instead |
| max_file_size | integer | The maximum file size this user is allowed to send (in Mb) |
| change_expiration | boolean | True if the user is allowed to change file expiration time |
| default_file_expiration | integer | The default file expiration time (the “2” in 2 weeks) |
| default_file_expiration_format | string | The default file expiration time format (the “weeks” in 2 weeks), possible responses are days, weeks and months |
| accepted_filetypes | string | A comma separated list of accepted file extensions. Accepted filetypes and blocked extensions are mutually exclusive (i.e. at least one of them will have a blank response). |
| blocked_extensions | string | A comma separated list of blocked (not allowed) file extensions. Accepted filetypes and blocked extensions are mutually exclusive (i.e. at least one of them will have a blank response). |
| require_authentication | boolean | True if the setting to require authentication of downloaded files should be enabled as default. |
| allow_users_to_change_require_authentication | boolean | True if users should be allowed to change the setting to require authentication. |
| default_bcc_myself | boolean | True if the Filetransfer appliance will default to bcc the user on delivery. |
In case the user is presented with an interface (email client plugin, …) these responses dictates what should be visible to the end user. If the user is allowed to change the file expiration, show the control with the listed default parameters. If the user isn't allowed to change file expiration, either grey out or remove those controls.
Example Response
<?xml version="1.0" encoding="UTF-8"?> <user> <api_version>2</api_version> <filetransfer_version>v1.6</filetransfer_version> <max_file_size type="integer">2000</max_file_size> <change_expiration type="boolean">true</change_expiration> <default_file_expiration type="integer">2</default_file_expiration> <default_file_expiration_format>weeks</default_file_expiration_format> <accepted_filetypes></accepted_filetypes> <blocked_extensions>exe, vbs, pif, scr, bat, cmd, com, cpl</blocked_extensions> <require_authentication type="boolean">true</require_authentication> <allow_users_to_change_require_authentication type="boolean">true</allow_users_to_change_require_authentication> <default_bcc_myself type="boolean">true</default_bcc_myself> </user>