KSH API configuration
Access to the open data source of the Hungarian Central Statistical Office: base URL, API key, datasets to fetch and the scope of the setting.
On the API configuration screen you set where the system downloads data from the open data source of the Hungarian Central Statistical Office (KSH), and which datasets it fetches. The statistics import and the raw dataset download both use this setting.
Adding a configuration
- Open KSH → API configuration.
- Click the blue + button at the top right (Add). For an existing configuration use the blue pencil-in-square icon (Edit) in its row.
- Keep "ksh" in API code and the suggested address in Base URL.
- Fill in API name and, if the service asks for one, API key.
- If the setting applies to one company group or company only, choose Client Company GROUP and Partner ID; leave them empty for a setting that applies to everyone.
- In Datasets to fetch, tick the datasets the system should download.
- Click Test connection. A successful test shows a message like "Connection OK - 120 datasets returned."
- Click Save at the top right. The message is "Success: The API configuration has been saved."
Fields
| Field | What to enter | Required |
|---|---|---|
| API code | The code of the source; the statistics functions look for the configuration with code "ksh". | yes |
| API name | A name shown in the list. | no |
| Base URL | The address of the source, by default the office's open data portal. | no |
| Config (JSON) | Advanced setting, for example the list of statistical indicators. Only a valid structure can be saved. | no |
| Status | Active or Inactive; only an active configuration is used. | no |
Actions in the list
The green tick icon in a row activates the configuration, the yellow ban icon deactivates it and the red bin icon deletes it. If there are several configurations, the system uses the active one for the company first, then the one for the company group, and finally the one that applies to everyone.
Example
Sample Ltd. only wants to see the median age per county. It adds a configuration with code "ksh", the connection test is fine, and then it downloads the data with the KSH statistics import.