Introduction
Welcome to the Fenergo SaaS Platform's Developer Hub. Here you will find documentation that covers all the technical aspects of our platform. If you want to learn about our APIs and the services we offer to support integrations you have landed in the right place.
Getting Started
Within this section called The Fenergo SaaS Platform we have included documents that cover some of the most commonly requested material by clients and partners. If you are evaluating our platform and want to learn what and how we have implemented a market leading SaaS platform the the following key topics are likely to be of interest.
-
Architecture and Disaster Recovery - Cloud based SaaS solutions come in many shapes and sizes. Our Architectural choices which have included adopting fully cloud native technologies provide a truly scalable and performant platform that delivers an amazing experience to our clients. Click here to learn more about our Architecture and DR Implementation
-
Standard Integration Patterns - As with any Enterprise platform which performs a critical business function, integrating to get data in an out is a vital requirement. As an API First platform, Fenergo offers multiple ways for clients to interact with our SaaS offering. Click here to learn more about our Standard Integration Patterns
-
Tenant Role and Data Isolation - For any SaaS client who delegates responsibility for operations and data to a vendor, how that data is protected and secured from other tenants on a multi-tenant platform is an area of key interest. Click here to learn more about our Tenant Isolation Strategy
-
Transaction Monitoring Regions and Disaster Recovery - You may choose to integrate Fenergo Lifecycle Management with Fenergo Transaction Monitoring. If so, there are some differences in available regions and disaster recovery capabilities to note. Click here to learn more about Transaction Monitoring Regions and Disaster Recovery
How to use this Documentation
Within the menu on the left hand side you will see more sub-menus to other technical topics. We have arranged the documentation to be as simple to follow as possible and grouped key subject areas together. Typically each section will contain an Overview of that topic and then deeper dives into the technical specifics.
Use Cases
We have have included AS / When / Then style use cases to help convey why certain functionality might be used. Standard Use Cases help to convey how and where certain functionality applies and gives us a real-world scenario to think through when looking at examples.
JSON Request and Response Samples
When illustrating how to interact with our APIs we have included JSON sample requests and responses. These are decorated inside code blocks that contain a copy link in the upper right hand corner to make it easy to follow along with the sample. When you move your mouse over the code block the little grey icon will reveal and copy the content into your clipboard.
{
"data": {
"journeyInstance": {
"id": "8075825d-3674-454a-ab8a-5a99ede55088",
"entityId": "7969620a-5196-4ed2-a19c-a047b2739e06",
"entityDraftId": "3ec83090-33b2-43b9-bebe-85a325d9cb7e",
"name": "Individual Ingress and Screening Test",
"type": "Client Onboarding",
"identifier": "IndividualIngressScreeningTestJourney",
"status": "In Progress",
"entity": {
"id": "7969620a-5196-4ed2-a19c-a047b2739e06",
"name": "George Jones",
"type": "Individual"
}
}
}
}
Tips / Notes / Info / Warnings
Throughout the documentation your attention will be called to key items / areas of interest which we highlight in the following way:
Tips will be highlighted in Green as suggestions of what you should do when working with something on the platform
Notes will be highlighted in Grey calling attention to something of note.
Info will be highlighted in Blue calling attention to information that may be important to highlight
Warnings will be highlighted in Yellow as items to be aware of and cater for when working with a particular feature.