Things you should know about REST API data upload :

REST API is only available to users who:

  • Have HansaWorld version STDERP_8.4 - 2017-11-22 or above

During the setup you will need to:

  • Get a working URL to Standard ERP over HTTPS
  • Enable REST API with correct access rights in HansaWorld

Setup HansaWorld for Rest API

  1. You need to know the HTTPS port of your HansaWorld server (Note: It is not the same as you normal port used for HansaWorld client!). SSL can be issued by Certification authorities and it can also be a self-signed certificate if the level of security is acceptable by customer. To set up self-signed certificate you can follow the documentation page on How to set up Standard ERP HTTPS with self-signed certificate for HansaWorld imports.

  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. Go to System >> Settings >> Optional Features and check the Allow Basic HTTP Authentication  checkbox.




    For security reasons we advise to remove this checkbox when the Rest API configuration is done.

  4. In the same screen ("System >> Settings >> Optional Features") check the "Web Rest API" checkbox.



  5. If you are using Standard ERP 8.5 2020-08-13 or newer version, go to Webshop >> Settings >> Access to functions from Web and do the following configurations:



    If you are using Standard ERP 8.5 2021-07-30 or newer version the setting is also available in Technics >> Settings >> Access to functions from Web
  6. To verify if you are using the correct REST API address and if the SSL certificate has been set up correctly please try to receive data manually. To do it, open web browser, enter URL https://example.com:port/api/1/OTVc, where "example.com" is your URL or IP address, "port" is your port, "1" is your company number and "OTVc" is a register that you can access in HansaWorld, and log in with your standard ID. If you can receive data successfully then you can proceed.

  7. Go to  https://mystandard.hansaworld.com page and choose More >> Developer Credentials. If you do not have access to this section, please contact you system administrator or flex.bi support.

    To find out more about the OAuth authenticate mechanism please read How does HansaWorld OAuth authentication work?

  8. Press "Add New" button.

  9. Enter a name of your choice in the "Application Name" box and redirect URL in the "Allowed Redirects" box and click on "Submit".



    If you are a flex.bi Cloud user, enter the following value in the "Allowed Redirects" box:

    https://flex.bi/bi/source_applications/auth/rest_api/callback
    CODE

    If you are a flex.bi Enterprise user, you need to replace https://flex.bi/bi with your server's URL. Or you can use the "Redirect URL" shown on the flex.bi import configuration page (see step 13 below).

    This URL has to be reachable from the internet, so make sure that it contians an external IP address or host name and that your firewall settings allow this URL to be opened outside of your local network.

  10. Find the newly created "Application Name" in the list and copy the corresponding "Client ID/Client Secret" values. You will need those later in the step 13 of this setup.

  11. Go to your flex.bi account.

  12. Setup HansaWorld source application, by going to the "Source Data > Source Applications" section and selecting "Add new source application" button.



  13. Select "HansaWorld". 


  14. Select the "Rest API and Source Files" radio button and enter your HansaWorld's URL followed by the port number and /api. For example:  https://sample.url.com:1234/api/ 

  15. Enter the Client ID and Client Secret that you got in step 8 above. Here you can also find the correct "Redirect URL" that can be used in step 8 above.



  16. Agree to Terms and Conditions, by marking the appropriate check-box, and then press "Continue".

  17. Log in with a Standard ID that has full access rights to the "Rest API" action and the necessary modules and registers on your HansaWorld server. 
    To check if you have the necessary access rights:

    1. In your HansaWorld application, go to "System >> Settings >> Access Group".

    2. Double-click on the code for the access group of the HansaWorld user that you will use for Rest API import.
    3. In the list of permissions, make sure that you have "Full" level access to "Rest API" action.



    4. Also make sure that you have at least "Read" level access to all of the registers that you want to import.
      (In the following example "Read" level access for "Purchase Orders" register is granted.)

       

      The HansaWorld server has denied access to the register for your user

      In case you are getting the "The HansaWorld server has denied access to the register for your user." error message:

      - make sure that your MyStandard user is authorized to get the particular register's data from your HansaWorld server

      - or disable this register in your HansaWorld source application import setup page.

  18. Select your data

    In the "Company" drop-down menu you can select which company data you wish to import. If you are using flex.bi BUSINESS plan, you can enable Finance Consolidation to import finance data for several companies.

    In the "Start import from" you have to enter the date in the following format (yyyy-mm-dd). The date describes the point in time from which the data will be imported, that is to say if you enter 2016-01-01 then all data that has been created from January 1, 2016 and up to today will be imported, data created before January 1, 2016 will not be imported. If you do not enter a date, data from 365 days ago will be imported by default.

    The "Future days" field allows you to specify how many days into the future you want REST API to take data from.

    The "Refresh period" field allows you to specify from how many days into the past you want your already imported data to be refreshed (required when an old data entry has changed).

    The "Regular import frequency" allows you to specify how often you want your data to be refreshed.


    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.

    If you want to also analyse your data by Objects or classification follow the steps in this documentation page about Extra dimensions.

    If you want to import Extra dimensions (Object typesCustomer classes, Item classes, Location classes, Item Varieties), click on section Extra Dimensions and select, which Extra Dimensions you need. 
      


    If your file is not recognized as a HansaWorld file then:

    • make sure the file contains any data at all,

    • try to re-export the data from HansaWorld again and allow some time for the new file to be populated with data, because exporting big files (several megabytes) can cause the files to appear as empty while they are being populated with data.

  19. Go back to Source Application tab and press Import.


Application Errors - Rest api 2


If you receive application errors after Standard ID Entry you first should check steps above again - if you haven't forgotten to to install some certificate or give correct rights to user.  Some application Errors are provided by flex.bi, but some by you Hansaworld server.

Common Error Messages

Error MessageMeaningPossible Reasons
"Source application did not authorize your request"There is no validation for your request
  • Wrong Developer Credentials - They must be unique for each customer. Make sure you have entered them correctly.
  • Wrong Standard ID login  or Password - Please check if you have entered correct user and Password.
  • The Standard ID login does not have access to the first company on the server list. Use parameter to change default company.
Access type must be 'offline' and response type must be 'code'Cannot login to mystandard.hansaworld.com when redirected from flex.bi
  • Incorrect username or password when logging in with standardID.
the resource is not allowedThe user's access group is not allowed to use the Rest API
  • The user's access group doesn't have full access for Type:Action Item:Rest API in your HansaWorld server.

initialize: name or service not known

Wrong Source Data URL

  • Check the URL, by copying it into tour browsers search bar.

connection reset by peer

"http" instead of "https" in Source Data URL

  • Check if the URL starts with "https".
flex.bi: File not found
Standard ERP (hansa.log): path not allowed: api/1/IVVc
Can't access the register on the Standard ERP server
  • Configure Access to functions from Web setting according to the step 5 above.