Versions Compared

Old Version 32

changes.mady.by.user Gvido

Saved on

compared with

New Version Current

changes.mady.by.user Miks Valers

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Things you should know about REST API data upload :

Info

REST API is only available to users who:

  •  have purchased the flex.bi "Standard" or "Business" plan.
    •  have HansaWorld

      requires :

    •  HansaWorld version STDERP_8.1-2015-06-02 or later
    •  have  HansaWorld Webshop licence enabled for setup period

    Please note : 

    • Currently Hansaworld Rest api API connection pushes all data that is requested starting form period you want to start import from
    • Rest appi API currently can be as only data import option - it can not be mixed with Source files data upload. If rest appi connection suits only some of your imports (too much data in selected period, for example), you should choose manual File upload with HansaWorld Exports or should  setup HAL package for automated data File export / import in your Flex.bi account or choose manual File upload with HansaWorld Exports.

    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:

    1. 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

    2. If you have a private flexPrivate Flex.bi server then you will have to manually add the following Plan parameters in your account settings:

      [hansaworld]
      data_source = "rest_api"
      batch_days = 10

    ...

    HansaWorld setup for Rest api exports
    1. 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
       
    2. You need to know the URL or IP address of your HansaWorld server that can be used for web requests from the Internet.
    3. Add new row in Webshop>>Settings>>Allow functions on web>>WebDataAPI (you can restrict the usage of this by specifying allowed ip addresses)
       
    4. 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
    ...
    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.