API lifecycle

An API lifecycle is a structured approach to creating and managing APIs, from initial design through development, deployment, and ongoing maintenance. It ensures that the API remains functional, secure, and relevant throughout its existence.

API-first approach

The API-first approach at Banqup means that all functionality is provided via APIs and all features offered by Banqup client applications use these APIs in the background.

API stages

In the API lifecycle, APIs go through various stages that define their maturity and availability for users. These stages ensure the API is well-managed and secure.

1. Design
The API's purpose, audience, and functionality are defined. The API specifications are created and security measures, versioning, and documentation are planned.

2. Development
The API is being developed, based on the API specifications. The APIs are tested to validate functionality and are deployed.

3. Preview
The API is available for developers to test and evaluate its functionality.
The interface and behavior may still evolve based on feedback. Developers can use this phase to explore the API’s capabilities, provide feedback, and prepare for future integration.

4. Early access
The interface and behaviour of the API are established, but the documentation and examples are not yet finalized. Developers can continue to test the API.

5. General availability
Both the functionality and the documentation are finalized, and users can integrate the API.

6. Deprecated
The API is still available and functional, but it is planned to be removed in the future.

7. Deleted
The API is not available anymore.

In the Banqup Documentation Portal, APIs can have different tags, representing the stage in which they currently are.
API endpoints with no tags are generally available for users.

Stage	UAT	CVE	Prod
Preview	✓	✓	X
Early access	✓	✓	✓
Deprecated	✓	✓	✓