We are creating a public API for IATI’s Validator tool and are seeking feedback from IATI’s Community on the draft API Contract by 15 March. An API contract is a technical document that sets out how the API will behave and acts as a contract between us (the API provider) and the developers that will use it.
Should I provide feedback?
Do you have an understanding of how APIs work? Are you a developer supporting an organisation in creating their IATI XML files? Have you built an in-house tool for your organisation that creates the IATI XML file? Are you an IATI publishing tool provider? If so, then we’d like to hear from you! We want to understand if the draft Validator API meets your user requirements!
Background information
The IATI Validator is a public tool for anyone to use. It checks if data complies with the rules and guidance of the IATI Standard, and it aims to improve the quality of IATI data. This is to ensure the data is accessible and useful to anyone working with data on development and humanitarian resources and results. Since the launch of the IATI Validator, the IATI Technical Team has proactively engaged with IATI members to support them to fix data errors (as identified by the Validator) and improve their data quality.
Currently users can only interact with the IATI Validator via the web interface as the IATI Validator doesn’t provide a public API. In line with the IATI technical stocktake recommendations, over the last few months the IATI Technical Team directly engaged with Validator users to understand their requirements for developing a public validator API. Based on that initial engagement and user requirement gathering we have drafted a Public Validator API contract and we’d like your feedback.
Post your feedback by 15 March
Please review the draft Validator API Contract and share any feedback by responding to this thread by Monday 15 March.
If you require clarification or have questions about the draft Validator API contract, the IATI Technical Team is happy to arrange a call with you. You can email the Technical Team: support@iatistandard.org directly or tag us in the thread below.
After the deadline the IATI technical team will review your feedback and will begin work on creating a public Validator API.
This comment was added following the close of the Validator public API consultation and it is not directly related to the API contract, we have responded to your comment directly on Github: https://github.com/IATI/IATI-Dashboard/issues/585
Petya Kangalova - I raised it here because I think it relates to the sync/async API issue that I raised in my consultation response. I suspect these dashboard links will sometimes end up pointing to a page that says “the validation report is not yet available” (since the url parameter is only available on the asynchronous route, that will sometimes give a 204 response).
Personally I’d prefer either synchronous validation (with comprehensive caching) or an asynchronous route that responds with a URL to poll. Of course, it’s a technical detail, but then agreeing an API contract is a technical discussion.