FMI is committed to providing a seamless integration experience for our customers, backed by robust service guarantees
This article is for developers and system integrators
APIs are expected to be made publicly available in early 2025
Availability
- FMI Works APIs are core to the web application. As such, they are covered under the same Service Level Agreement (SLA) as FMI Works.
- The infrastructure supporting our APIs is inherently scalable and capable of dynamically adjusting resources to meet fluctuating demands. This ensures consistent performance and availability regardless of usage spikes or growth.
- Additionally, these APIs are designed for high availability, with minimal downtime and interruptions. For more information, see the Performance, Scalability, and Capacity Planning Guide, and High Availability and Disaster Recovery Guide.
Performance
- FMI Works APIs are optimised for fast and efficient data retrieval, with low latency and high throughput.
- We continuously monitor and optimise API performance to ensure responsiveness and scalability, even during peak usage periods.
- API performance is maintained within Service Level Agreements (SLAs), guaranteeing reliability and consistency in service delivery.
- Throttling mechanisms are implemented to protect against DDoS attacks and ensure fair resource allocation among customers.
Security
- Data security is a top priority. We employ industry-standard encryption protocols and authentication mechanisms to protect your data during transit and storage. For more information, see Data Security At-Rest and In-Transit.
- Access controls and permissions are enforced to restrict unauthorized access to sensitive data and APIs. For more information, see Authentication and Authorization.
Semantic Versioning
- FMI follows semantic versioning principles for API updates, ensuring clarity and predictability in version increments.
- Updates are designed to be backward compatible whenever possible, minimizing disruptions to existing integrations.
- Multiple versions of APIs may be maintained concurrently to accommodate varying customer needs and migration timelines.
- Customers are provided with a notice period before APIs are obsoleted, allowing sufficient time to assess the impact and plan for migration.
Documentation
- Our APIs come with comprehensive documentation to assist with your inquiries, issues, or integration challenges, via the OpenAPI specification (https://{client}.fmiworks.com/{client}/swagger).