API technical and data standards (v2 – 2019)
Publish your APIs over the internet by default. Email firstname.lastname@example.org if you think your APIs ought not to be published over public infrastructure.
Follow the Technology Code of Practice
Make fully sure your APIs fulfill the requirements associated with Technology Code of Practice (TCoP) by making sure they:
proceed with the Open Standards Principles of open access, consensus-based open process and licensing that is royalty-free
scale for them to maintain service level objectives and agreements when demand increases
Are stable so they can maintain service level objectives and agreements when dealing or changed with unexpected events
Are reusable where possible so the national government will not duplicate work
Stick to the industry standard and where appropriate build APIs that are RESTful, designed to use HTTP verb requests to control data.
When handling requests, you should utilize HTTP verbs with their specified purpose.
One of several benefits of REST is so it provides you with a framework for communicating error states. Continuar leyendo