> API authentication mode
In some cases, the APIs to which you connect require authentication from you.
Please consult the user documentation for the API you wish to use in order to know its authentication mode, and create an account or key if needed.
A certain number of APIs don't require authentication (this is the case with Open Data APIs, for example), or allow authentication directly in the call's URL. In this case, please tick the "Other" option in the "Authentication" area.
APIs with "http basic" authentication
Select the "Login/Password" option and enter your credentials.
APIs with OAuth authentication
Tick the "OAuth" option: a drop-down list will appear containing all the OAuth connections that you've already enabled. Select the one that should be used in the case of the API call you wish to make.
Please note, to use this option, you must have already enabled the appropriate OAuth connector via your user profile.
> Required fields
Connection to a third-party API requires the following elements:
(1) the URL of the API call you wish to make
(2) the output format for data sent by the API: JSON or XML
(3) the API connection mode: no authentication, basic authentication (login/password), OAuth
The following elements are optional:
> Optional fields: date settings
You may "dynamically" refresh your external data based on the analysis period selected in your dashboard. The API you use must allow for this, by authorising start and end date settings in the URL enabling call generation.
To enable this feature, simply copy the names of the URL's variables which correspond to the start and end dates over into the dedicated fields, then specify the format of the date transmitted via the URL (4).
In general, the format suggested by APIs is yyyy-MM-dd. We also offer other formats, or you may enter a custom format.
Fill out the "Start date" field with the "start-date" parameter, and the "End date" field with the "end-date" parameter. Maintain the yyyy-MM-dd format.
If you don't enter this information, your dashboard will display data from the dates entered directly in the URL of the API call.
Tip: if you don't know which elements to enter into this setup window, please consult the documentation for the API to which you'd like to connect.
Click on the "Next" button to carry out the call and display the data sent by the API.