flex.bi setup
...
REST API is only available to users who:
1) have purchased the flex.bi "Standard" or "Business" plan.
...
Things you should know about REST API data upload :
Info |
---|
REST API requires :
Please note :
|
Prepare your acount for REST API connection
To be able to use REST API as a way to import your files you must first make sure you have the necessary plan parameters enabled:
- If you have your flexFlex.bi on our provided cloud Cloud server, you will have to contact flex.bi support who will then set up open REST API for you. Contact : support@flex.bi
If you have a
private flexPrivate Flex.bi server then you will have to manually add the following Plan parameters
toin your account settings:
Then you will be able to perform imports with REST API.
...
[hansaworld]
data_source = "rest_api"
batch_days = 10
HansaWorld setup for Rest api exports
You need to know the web port of your HansaWorld server (which is not the same as you normal port used for HansaWorld client). Normally it should be specified in Technics>>Program Mode.
Note As web port can be overridden by server startup scripts, firewall or other configurations we recommend to contact your HansaWorld partner and/or hosting partner to find out the actual port number used
- You need to know the URL or IP address of your HansaWorld server that can be used for web requests from the Internet.
- Add new row in Webshop>>Settings>>Allow functions on web>>WebDataAPI (you can restrict the usage of this by specifying allowed ip addresses)
- Test in your browser or other software designed for REST API request testing that this functionality is working with URL
http://ip:port/WebDataAPI.hal?register=BaseCurBlock
As a result you should get a short JSON formatted result with your base currencies from first company which means connection is working and flex.bi will care of the rest
Warning |
---|
We suggest that you discuss security measures with your HansaWorld or hosting partner to ensure that data access is secured only for flex.bi |
...
Setting up Rest api connection in Flex.bi
To do an import click on the "Add new source application" button in your Source Data -> Source Applications tab. Select "HANSAWORLD" as your source application.
Note |
---|
REST API currently only supports the full import of registers (or from the specified import date, specific user defined intervals are available currently). If you choose to use REST API as the main method of importing data into flex.bi you will not be able to use any other file import methods from HansaWorld |
Press the button create.
A page similar to this should appear
...
In the source data URL enter the URL to your HansaWorld server. The URL should look similar to this: http://sample.url.com:1234/WebDataAPI.hal
The URL consists of the following elements
Public Hostname | Port (HTTP) | .hal file name | Optional fields |
---|---|---|---|
http://sample.url.com | :1234 | /WebDataAPI.hal | ?company= *number* |
-where *number* is the number (code) of the company that's displayed in System (Module) -> Registers -> Companies. Adding this optional field will export data only from that specific company. If this part of the URL is not specified then REST API will import data from the first company in the list
...
Once you are done with selecting everything you wish to import press the "Import" button and the import will begin. Importing with REST API does not upload any source files into the "Source files" section of flex.bi.