App Development Guidelines
An App is a business logic layer built on top of the OS1 Platform APIs to solve a single problem or provide a limited scope of functionality. For example, the User App includes functionalities such as onboarding or offboarding a user.
The app must be multi-tenant. In that sense, the app should be able to work on any tenant within a stack without having to deploy anything additional. Any app that is not multi-tenant will not be accepted for publishing on the OS1 platform.
The Console UI Overview provides a lightweight interface for end users to access all their apps from a single location. You can leverage the console by integrating your web app with the Console UI library. We require integrating with the console for added benefits, such as eliminating the need to implement custom login/logout and user navigation functionality. If you have a reason for not integrating your web app with the console, contact us during your development
We require that the permissions file you set up for your apps only use the necessary Core and Framework APIs. Apps with a permissions file without API or admin access to all APIs will not be accepted for publishing. Additionally, your app must use at least two permissions. In that case, you will need two permissions files versus an app with just the front end, which will need just one permissions file.
If your app includes any custom logic or a plugin, you must test it to ensure it works as expected. Otherwise, you must disable the custom logic or plugin if it’s not functional before publishing.
All apps require an automation script for initialization and publishing. Therefore, ensure that you provide enough information to initialize apps. For example, single-leg solution apps require following different sequences during initialization.
Your app must be fully functional and bug-free. Perform end-to-end testing on commonly used features and multiple scenarios. Furthermore, do not attempt to publish an app with known bugs or performance issues.
Your UI design should create an intuitive user experience when engaging with your app. Providing clear paths to relevant information, seamless navigation components, and indicators for links and buttons are essential. Refer to the UI Guidelines and Principles for examples to ensure your app is approved.
To ensure your app meets Delhivery’s security standards, you must provide us with the Vulnerability and Pen Test (VAPT) for security review.
Only use components and other assets you’ve created to avoid infringement on the copyrights or IPs of others. This includes ensuring that your app has the licenses to use paid or open-sourced external software.
Review the Prohibited App Types list to determine if it applies to your app.
Provide complete and easily accessible documentation for your app. For example, your user guides should be easy to follow and help users understand how to use your app. Additionally, you must provide support channels that are readily accessible and contact information for support inquiries.
Your app must be compliant with the PII guidelines.