Register Your Solution

overview the registersolution api provides a streamlined method for developers and organizations to register new solutions within the platform it accommodates both app and api type solutions during the registration process, developers can specify a variety of required and optional attributes to compose a solution per business needs register solution endpoint post /developer/solutions query parameters true false 147false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type request parameters true false 291false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type required attributes required attributes ( ) indicates that the attribute is required example request the following example registers a solution for las mile delivery app type { "displayname" "last mile delivery", "solnlistingid" "last mile delivery", "type" "app", "version" "1 0 9", "shortdescription" "this is a solution for last mile delivery", "isconsolecompatible" true, "longdescription" "last mile delivery combines the benefits of route optimization and real time tracking to ensure that your customers get their deliveries on time it also helps you to reduce costs and improve customer satisfaction ", "visibility" { "isprivate" true, "permissiontype" "allow", "orgidentifiers" \[ "bf17e158 1951 47f9 84f1 e50aeb59fac2", "bf13f564 1951 47f9 84f1 e50aeb59fac2" ] }, "productfamily" "string", "supportedcountries" \[ "us", "ca", "in" ], "categories" \[ "vehicle", "tracking" ], "solnurls" \[ { "name" "landingpage", "url" "https //www example com/landing page" } ], "apps" \[ { "listingid" "vehicle trackers", "semver" "1 0 9", "displayorder" 1, "initsequence" 1 } ], }, "systemappsettings" \[ "payments" ] } api type { "displayname" "last mile delivery", "solnlistingid" "last mile delivery", "type" "app", "version" "1 0 9", "shortdescription" "this is a solution for last mile delivery", "isconsolecompatible" true, "longdescription" "last mile delivery combines the benefits of route optimization and real time tracking to ensure that your customers get their deliveries on time it also helps you to reduce costs and improve customer satisfaction ", "visibility" { "isprivate" true, "permissiontype" "allow", "orgidentifiers" \[ "bf17e158 1951 47f9 84f1 e50aeb59fac2", "bf13f564 1951 47f9 84f1 e50aeb59fac2" ] }, "productfamily" "string", "supportedcountries" \[ "us", "ca", "in" ], "categories" \[ "vehicle", "tracking" ], "solnurls" \[ { "name" "landingpage", "url" "https //www example com/landing page" } ], "api" { "apibaseurl" "https //api example com", "apidetails" \[ { "name" "geocoder v1", "relativepath" "geocoder/v1" } ], }, "systemappsettings" \[ "payments" ] } ] } } the response includes the solutionid and solutionversionid which you will be able to use in subsequent api calls configuring system settings configuring system app settings allows developers to easily enable system app settings for their solutions by providing a list of desired system apps in the systemappsettings parameter when registering or updating a solution note the "payments" app is the only available system app for now enabling system app settings to enable system app settings for your solution, follow these steps when registering a new solution or updating an existing solution, include the systemappsettings parameter in the request body of the registersolution or updatesolution api set the value of systemappsettings to an array of system app identifiers representing the system apps you want to enable for your solution the available system app identifiers are predefined and can be selected based on your solution's requirements for example, to enable the "payments" system app, you would include "payments" in the systemappsettings array example request body { "systemappsettings" \[ "payments" ] } updating system app settings if you need to modify the enabled system app settings for your solution, you can update the systemappsettings parameter using the updatesolution api by providing the updated array of system app identifiers in the request body example request body to update system app settings { "systemappsettings" \[ "payments", "new system app" ] }