We've designed APIs that are easy-to-use with clear and detailed documentation
This article is for developers and system integrators
At FMI, we prioritize user experience and clarity when it comes to our APIs. We understand that easy-to-use APIs with clear and detailed documentation are essential. That's why we've designed our API features to cater to these specific needs:
HTTPS-based Communication
- Our APIs operate over HTTPS, ensuring secure communication channels between client applications and our servers. This encryption protocol safeguards sensitive data and protects against unauthorized access.
RFC7807 - Problem Details
- We adhere to the RFC7807 standard for Problem Details, providing clear and standardized error responses in case of API failures or invalid requests. This allows developers to quickly identify and troubleshoot issues, improving the overall reliability of their applications.
Consistent Documentation
- Detailed documentation is crucial for developers to understand and effectively utilize our APIs. We maintain consistency in our documentation across all endpoints, ensuring that developers can easily navigate and find relevant information.
- Each endpoint is thoroughly documented, including descriptions of parameters, request bodies, response formats, and error codes. This comprehensive documentation streamlines the integration process and reduces development time.
Open API (Swagger) Interface
- Our APIs are accompanied by a user-friendly Swagger interface, providing an interactive and intuitive platform for exploring API capabilities and testing endpoints.
- The Swagger interface offers additional details, such as parameter descriptions, example requests and responses, and supported authentication methods. This rich documentation enhances developers' understanding of API functionalities and usage scenarios.
Consistent Patterns for Filtering, Sorting, and Paging
- To simplify data retrieval and manipulation, our APIs follow consistent patterns for filtering, sorting, and paging. Developers can easily customize API responses by specifying filter criteria, sorting preferences, and pagination parameters.
- This uniform approach to data manipulation ensures predictability and ease of implementation, allowing developers to focus on building robust applications without the complexity of custom data handling logic.
More information
For information about what APIs are being developed and when they are being released see Introduction to APIs.
For additional technical information about the APIs see: