Frequently asked questions
Can I try Api2File before I purchase a license?
Yes, Api2File offers a free, no credit-card required trial license that is valid for 7 days. Visit the License page to generate a custom trial license.
Is the trial license limited in any way?
No, the full functionality of Api2File will be available for 7 days from the date of trial license generation.
How long before I receive my trial license?
Licenses are generated and emailed immediately. If you have not received yours within a few minutes, please check Email 'spam' folders for an email containing your license file.
Can I combine Trial and Paid licenses?
No, once a paid license is added to Api2File any trial licenses will be deactivated.
Can I request more than one trial license?
Yes, You can request up to 5 trial licenses per email domain. If you require more time to evaluate Api2File please generate a trial license using a different email address.
Does Api2File 'phone home' for any reason?
No, Api2File only transfers data associated with configured APIs. Licensing checks are all performed locally and no telemetry is sent from the application.
What happens if I have less valid licenses than APIs configured?
When Api2File detects a license mismatch it will shut down, allowing you the opportunity to decide which API endpoints should be served using the remaining valid licenses.
Does a license allow multiple ways of utilising a single API?
Yes, Api2File licenses are centered around a single 'Base url'. You can configure as many routes under the Base url as you require and they are all covered by a single license.
How long are full licenses valid for?
Full licenses are valid for 1 year from date of purchase. Licenses can be purchased in advance with a future valid-from date to ensure consumers do not experience a break in service. For longer validity or perpetual licenses please contact Api2File support.
Can I move a Full license to another machine?
Full licenses are tied to a machine and cannot be transferred. It is important to generate licenses for a server that is suitable for the entire duration of a license validity.
Can I change a server specification and keep its license?
Yes, changing CPU cores, memory and disk won't affect license validity.
Can I change the API associated with a license?
Yes. 'X' Licenses allow 'X' APIs to be served by the Api2File application. As long as there are enough valid licenses for the number of APIs configured, the APIs can be changed as required.
Do I require licenses for non-production environments?
Yes, any server using Api2File requires valid licenses.
What are the runtime limitations of a license?
Usage of Api2File is 'un-metered' and as such there are no limitations on usage of Api2File with a valid license. Api2File may be limited in capacity by the performance of the server it is running on, or the APIs it is retrieving data from.
Can I purchase enterprise support with my licenses?
Extensive documentation on the configuration options is freely available to all users. This should be sufficient to solve most queries or issues. Please contact support to discuss your enterprise support requirements.
What are the server requirements of Api2File?
Api2File will run on Windows (10, 11 & server). Most Linux distributions, and within a linux Docker container. There are no minimum requirements to run Api2File, but a server with more resources will be more responsive when under load. Data transformations will have the greatest impact on performance, so as new APIs are added, server resources may need to be adjusted.
Are there any differences between the OS versions of Api2File?
No, the Windows, Linux and Docker versions of Api2File all have the same functionality. There are some minor differences in the configuration required for each deployment platform.
What API authentication methods are supported?
Api2File supports the following API authentication methods:
- None (i.e. an unsecured API)
- Basic
- JWT Bearer
- Request header or Cookie
- OAuth2 APIKey
- OAuth2 Client-Credentials grant
- OAuth2 Implicit grant
What Samba/UNC Share protocols are supported?
Api2File can expose files using the SMB1, SMB2 and SMB3 protocols. SMB1 is considered to be insecure and is disabled by default, but can be enabled via configuration.
What file types are supported?
Api2File can transform the API response into any text-based file format. The built-in powerful translation language allows complex mapping to ensure the output is compatible with consuming applications.
Can files have their content filtered?
Yes, Api2File allows filtering to be applied during the request to the API, or during the transform stage after receiving unfiltered results from the API. Directory and Filename patterns can be configured to deliver differing results from a single API endpoint.
What API response content-types are supported?
Api2File supports all text-based response types. Modern APIs tend to utilise 'application/json' or 'application/xml' content which is supported out-of-the-box.
Can users be associated with specific authentication methods?
Yes, Users can have specific authentication methods, usernames or keys associated with them on a per-API basis.
Can a default authentication method be applied to non-configured users?
Yes, Any user not explicitly configured can be denied access or have a default authentication method applied.
Does Api2File support Load-balancing or High availability?
The network topography can be configured so multiple Api2File instances are serviced via a single SMB endpoint.
It should be noted that separate Api2File instances do not have a shared cache. This can result in source APIs receiving significantly more traffic from multiple instances than from a single instance of Api2File.
I have a suggestion for a new feature, who do I contact to get it included?
We always carefully consider all feature suggestions and often can implement new functionality quickly. Email your ideas/requirements to support@api2file.net.