App lifecycle
Understand what different statuses mean for your app
π§ Concept
This is the initial state of every app, set by default when you create your first app. An app in concept status indicates that the app is still in discovery and design phase, and active development is not yet started on the app. From this state, you can either mark the app "in development" or request for it to be "Private", only to be used by select organisations (by contacting us at [email protected]).
π¨π»βπ» In development
An app in development indicates that the integration is actively being worked on and tested. Once the development of the app is complete, you can request for the app to be validated right from the app developer page.
Note: Your app will automatically be updated to in development when you make your first API request.
π Restricted access (Private)
Apps with restricted access are not available publicly on the BEX app store. You can request the app to be made available to specific organisations by contacting us.
π Being validated
After the development of your app is complete, you can request us to validate your app.
Note: A private app cannot be validated. Contact us if you wish to validate a private app.
If during validation, we determine that your app is not ready to be published, it will be marked back in development.
When requesting for validation, the following fields will be checked before the request:
- Logo should not be empty
- Introduction and descriptions must be present for all the languages in which the app operates, and for a global app, at least the Dutch, English, French and German translations must be present.
- Support documentation url must be present and must point to a valid URL explaining how to setup and use the app.
π‘οΈ Admin managed
After validation is complete, if we determine that the app requires intervention from admins or the developers to setup and operate, the app is set to Admin managed status. This means that the app will still be listed on our App Store, however, the customer would have to contact BEX to install and setup the app.
βοΈ Published
After validation is complete and everything looks good, your app will be published on our app store and made available to all users of BEX to install π
π« Blocked (Halted)
Some apps can be halted by us from the app store if the app violates any terms and conditions, or has not been used for a long time. A blocked app is no longer available on the app store for installation or for development. Our API will no longer be accessible for a blocked app. If your app is blocked and you wish to unblock the app, please contact us.
Your app will receive the following error from the API if you make API calls:
{
"errors": [
{
"title": "Forbidden",
"status": 403,
"code": "APPLICATION_HALTED",
"detail": "Your application is currently not active, therefore you do not have access to this API"
}
]
}Application lifecycle state machine
