📄️ API Principles and Patterns
The API first pattern is where the APIs of a system are treated as a first class citizen of a software product. The API interfaces represent the logic of how a solution is implemented instead of just the code. This approach places more than the user of the product at the centre, but also facilitates system integration from the ground up, planning for and ensuring that up or downstream system users can avail of the same functionality. There are significant benefits for development teams and product consumers.
📄️ API Quick Reference
JSON Requests and Responses
📄️ API Catalogue
Below is a full list of all APIs available in the Fenergo SaaS platform along with a brief description and links to the published swagger for each. Refer to our guide on using Swagger and Postman for information on how to connect to and call the APIs.
📄️ Working with Swagger and Postman
Get Started Making API Calls
📄️ API Technical NFRs
Client projects have functional and technical requirements which are solved by looking at the desired outcomes and identifying which API calls and sequences of calls are needed to feed or retrieve data to and from external systems. Outside of these, there will be what are called Non Functional Requirements which integrators should be aware of and plan ahead for when delivering project's.
📄️ Introduction to Audit API
The purpose of this document is to provide guidance for working with FenX Audit API response.