Kiwi API Response Format
Information Technology — Application Programming Interfaces — Kiwi API Response Format
Open in KiwiDrive (requires login)See Final DraftPHP ImplementationJS ClientThe Kiwi API Response Format (KAPIR) has been developed by the Kiwi Committee for Standardization with the goal of ensuring consistency, reliability, and clarity in API responses.
This project has entered the evaluation stage. Review the final draft and give us your feedback: standardization@mia.kiwi!
In modern software ecosystems, interoperability is essential for the smooth exchange of data between diverse systems, applications, and platforms. A key challenge in ensuring this very interoperability is the standardization of API responses, which must be consistent, predictable, and easy to process. The Kiwi API Response Format addresses this challenge by providing a well-defined structure for API responses, ensuring that all parties understand how to interpret and process information. By adhering to the format, developers can reduce the risk of miscommunication and errors that arise from inconsistencies in response structure, making it easier to integrate systems and maintain software.
API Response Structure
Response:
- `status`: 'success' || 'error'
- `version`: string
- `data`: object || string || array || number || boolean || null
- `message`: string || null
- `error`: Error || null
- `meta`: object || null
Error:
- `code`: string
- `message`: string || null
- `errors`: NestedError[] || null
NestedError:
- `code`: string
- `message`: string || null