How to Create a Service App for the ORCA Marketplace
Steps to Create a New App
If you have an existing account, use your credentials to log in to the Developer Portal. If you haven’t already created a developer account, click “Sign Up” and complete the registration form to gain access to the ORCA API Platform. When you initially sign up or prior to having your first Service App approved, your account will be in “sandbox mode”, allowing you to explore, test, and modify your app within a controlled, yet functional staging environment.
Navigate to the “My Service Apps” tab and select “Create New Service App” from the dropdown menu. You’ll then be prompted to provide a name for your Service App. After submitting the name of your app, you’ll be taken back to the My Service Apps main menu.
Now it’s time to provide additional details about your service. To add information, select the service from the My Service Apps dropdown menu, then click “Settings” from the sidebar and populate the available fields. You’ll notice that the Service App name has already been populated. However, you'll be able to change the name of the app before submitting it for approval at any point from the Settings section.
Preview and test your Service App in sandbox mode and feel free to make additional edits to the description prior to submitting for review.
When ready, submit your Service App for consideration, along with a business verification agreement certifying the service is HIPAA compliant.
The ORCA team will review your request and supplemental documents. You will receive a notification when the Service App is approved or if additional information needs to be submitted.
Once your Service App is approved you may request permissions. Each permission has its own set of requirements. Should multiple permissions be requested, the ORCA team will review each one individually. Limit permission requests to those absolutely necessary for the service.
When permissions are granted, your Service App will be added to the ORCA Marketplace for users to install and your account will be moved from sandbox mode to production mode, enabling faster submissions in the future.
Required Components for ORCA Service Apps
The following is a complete list of components you’ll be asked to provide for each Service App in order to have it showcased on the ORCA Platform.
Service Name
Service Provider Name
Service Provider Logo
App Version
Short Description
Long Description
How it Works
Pricing Description
Marketplace Thumbnail
Marketplace Banner
Video (optional but recommended)
How Service Apps Are Found and Displayed
Service Apps appear in multiple sections throughout the ORCA Platform. The view in each section may vary, and so, will require specific components of the service to be provided.
Below are some examples of the sections where Service Apps can be found on the ORCA Platform, the components needed for each view, and how the service will be displayed to users.
Installed Services
The Installed Services section contains a list of services the user installed. Services are displayed as tiles. Each tile must include the following:
Thumbnail: An image banner that includes the service name
Short Description: Two lines of text describing the service
Service Provider: Name of the business or company offering the service
Version: The current version of the Service App
Marketplace
The Marketplace is where ORCA users can browse available services and obrain additional information regarding each. A similar tile as seen on the Services section will be displayed on the landing page. The difference being that only installed services will display the version number.
Service Detail Page
When a user clicks on the tile, they will be taken to the Service Detail page, where additional information about the service will be displayed, including the below:
Service Name: Name of the service or solution
Marketplace Banner: Banner image with company logo or icon related to the type of service being offered
Long Description: A more comprehensive explanation of the service. May be in paragraph format, bullet points, or a combination of both.
Video (optional but recommended)
How it Works: A brief explanation of the service's purpose, functionality, and benefits
Install Button: A call to action section including service provider name and logo, service category, user ratings, link to user reviews, number of installs, pricing information, and add service button.
Last updated
