HAPI FAQ – General
What is HAPI?
HAPI (Harmonized APIs) is the set of IEC APIs aligned with ISO and CEN/CENELEC data models. It was delivered in five steps:
|
Year |
Scope |
|---|---|
|
2019 |
Publications and Projects |
|
2020 |
Working Documents |
|
2022 |
Identity Management (users, roles, organizations, committees) |
|
2023 |
Ballots (IEC Voting System) |
|
2024 |
Meetings |
Where is the API documentation?
-
Data models (XSD) and OpenAPI specifications (YAML): shared Bitbucket repository with ISO and CEN/CENELEC – https://bitbucket.org/sdo-hapi/
-
OpenAPI documentation: IEC API Portal – https://api-portal.iec.ch/
How do I get access?
Create a developer account on the IEC API Portal (https://api-portal.iec.ch/ ) and sign in.
How often is the data refreshed?
Publications and Projects data are updated in a daily batch between 03:00 and 03:30 UTC. Expect up to 24 hours between a record's lastChangeTimestamp and its availability in the API.
Is there a limit on the number of results per call?
Yes. A single request returns max. 500 records. Defaults are page=0 and size=100. To retrieve everything, loop from page=0 to the last page.
The response header Link gives the next and last pages:
<https://api.iec.ch/harmonized/publications?page=1&size=100>; rel="next",
<https://api.iec.ch/harmonized/publications?page=286&size=100>; rel="last"
The last page number grows over time – do not hard-code it. The same applies to the Projects API.
How do I get the total number of results?
Read the last page in the Link header. With size=1, the total number of records = last page number + 1.