🚀 FL3XX API Basics
Fundamental concepts for working with FL3XX APIs, including REST architecture, permissions, data formats, and HTTP status codes
API Architecture
Access and Permissions
HTTP Status Codes
API Architecture
REST principles and stateless design
All FL3XX API services are based on the REST architectural style and they are all stateless. This design ensures scalability, reliability, and ease of integration.
Compatibility
FL3XX may introduce additive, backward-compatible changes to the API at any time without a version bump. Your integration should be built to tolerate these changes.
🔄 Additive Changes
The following changes are considered backward-compatible and may be released at any time:
- New properties in existing response objects
- New values in existing enums
- New endpoints and new optional request parameters
Build Tolerant Clients
Ignore unknown response properties rather than failing, and handle unrecognized enum values gracefully (for example, with a default or fallback branch). Removing or renaming fields, or changing existing behavior, is treated as a breaking change and communicated separately.
Access and Permissions
Token management and operator access
HTTP Status Codes
Understanding response codes