The following application that is web-based interface (API) standards guidance will help your organisation provide the most effective services to users.
API technical and data standards (v2 – 2019)
Publish your APIs on the internet by default. Email email@example.com if you believe your APIs ought not to be published over public infrastructure.
Proceed with the Technology Code of Practice
Make fully sure your APIs fulfill the requirements for the Technology Code of Practice (TCoP) by simply making sure they:
follow the Open Standards Principles of open access, consensus-based open process and royalty-free licensing
scale so that they can maintain service level objectives and agreements when demand increases
are stable for them to maintain service level objectives and agreements when changed or dealing with unexpected events
Are reusable where possible so the national government does 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 need to use HTTP verbs for his or her specified purpose.
One of the benefits of REST is you a framework for communicating error states that it gives.
In a few cases, it may not be applicable to construct a REST API, for instance, if you’re building an API to stream data.
You need to use HTTPS when creating APIs.
Adding HTTPS will secure connections to your API, preserve user privacy, ensure data integrity, and authenticate the server providing the API.