Publisher APIs

WSO2 App Manager Publisher provides the following REST APIs for App Management.

Common REST APIs

The following REST APIs are common to all asset types. 

• App Publisher login
• App Publisher logout
• Change asset lifecycle state
• Get the uuid of an asset
• Get the details of an asset with a given uuid

App Publisher login 

App Publisher logout

Change asset lifecycle state

Get the uuid of an asset

Get the details of an asset with a given uuid

APIs specific to web applications

The following REST APIs are specific to web applications. 

• Add web application

• Get a given web application

• Delete a given web application

• Update/edit a web application 

• Update a service provider

Add web application

The following steps illustrate how to add a new application through an external REST client.

1. Add a default policy group

   Description	Initially, a default policy group must be added in order to create a web application.
   URI	http://localhost:9763/publisher/api/entitlement/policy/partial/policyGroup/save
   URI Parameters	policyGroupName=<policy-grooup-name>&throttlingTier=<Throttling tier>&userRoles=<user role list for visibility restriction>&anonymousAccessToUrlPattern=<is annonymout access true/false>&objPartialMappings=<entitlement policy partial id list array>&policyGroupDesc=<default policy group description>
   HTTP Methods	POST
   Example	curl -X POST -b cookies -H 'Content-Type: application/x-www-form-urlencoded' http://localhost:9763/publisher/api/entitlement/policy/partial/policyGroup/save  -d 'policyGroupName=Default&throttlingTier=Unlimited&userRoles=&anonymousAccessToUrlPattern=false&objPartialMappings=[]&policyGroupDesc=default policy group for hello world web application'
   Sample Response	{"success" : true, "response" : {"id" : 8}}

2. Create an application
   

   Description	Creates a web application. You need to get the above created policy group ID and provide it in the webapp creation request URL parameters.
   URI	http://localhost:9763/publisher/publisher/asset/webapp
   URI Parameters	overview_provider=<application-provider-name>&overview_name=<application-name>&overview_displayName=<application-display-name> &overview_context=/<application-context>&overview_version=<application-version>&optradio=on&overview_transports=<transport http/https> &overview_webAppUrl=<application-URL>&overview_description=<application-description>&images_thumbnail=<image-file-location> &images_thumbnail=<file-location>&images_banner=<file -location>&images_banner=<file-location>&context=<context>&version=<version> &overview_tier=<application-tier (Unlimited)>&overview_trackingCode=<tracking-code>&tags=<tag list>&overview_allowAnonymous=<allow anonymous access true/false> &overview_acsUrl=<assertion-consumer-URL>&overview_skipGateway=<skip gateway true/false>&roles=<roles for visibility-restriction> &overview_logoutUrl=<logout-url>&uritemplate_policyGroupIds=[<uri-template-policy-group-ids>]&uritemplate_policyPartialIdstemp=[]&uritemplate_javaPolicyIds=[5] &uritemplate_urlPattern5=/<pattern>&uritemplate_httpVerb5=<http verb GET/POST/PUT/DELETE/OPTIONS>&uritemplate_policyGroupId5=<policy-group-id> &uritemplate_urlPattern4=/<pattern>&uritemplate_httpVerb4=<http verb GET/POST/PUT/DELETE/OPTIONS>&uritemplate_policyGroupId4=<policy-group-id> &uritemplate_urlPattern3=/<pattern>&uritemplate_httpVerb3=<http verb GET/POST/PUT/DELETE/OPTIONS>&uritemplate_policyGroupId3=<policy-group-id> &uritemplate_urlPattern2=/<pattern>&uritemplate_httpVerb2=<http verb GET/POST/PUT/DELETE/OPTIONS>&uritemplate_policyGroupId2=<policy-group-id> &uritemplate_urlPattern1=/<pattern>&uritemplate_httpVerb1=<http verb GET/POST/PUT/DELETE/OPTIONS>&uritemplate_policyGroupId1=<policy-group-id> &uritemplate_urlPattern0=/<pattern>&uritemplate_httpVerb0=<http verb GET/POST/PUT/DELETE/OPTIONS>&uritemplate_policyGroupId0=<policy-group-id> &entitlementPolicies=<entitlement-policy-ids>&autoConfig=<sso-provider-auto-config on/off>&providers=<identity-provider>&sso_ssoProvider=<sso-provider(wso2is-5.0.0)> &claims=<cliams>&claimPropertyCounter=<cliam-propery-count>&claimPropertyName0=<cliam propery name 0 (http://wso2.org/claims/role)> &claimPropertyName1=<claim property name 1 (http://wso2.org/claims/otherphone)&sso_singleSignOn=<SSO Single sign on Enabled/Disabled> &sso_idpProviderUrl=<sso idp provider url (https://localhost:9444/samlsso/)&sso_saml2SsoIssuer=<sso-issuer-name> &oauthapis_apiName1=<OAuth API 1 Name>&oauthapis_apiConsumerKey1=<OAuth API 1 consumer key>&oauthapis_apiConsumerSecret1=<OAuth API 1 consumer secret> &oauthapis_apiTokenEndpoint1=<OAuth API 1 token endpoint url> &oauthapis_apiName2=<OAuth API 2 Name>&oauthapis_apiConsumerKey2=<OAuth API 2 consumer key>&oauthapis_apiConsumerSecret2=<OAuth API 2 consumer secret> &oauthapis_apiTokenEndpoint2=<OAuth API 2 token endpoint url> &oauthapis_apiName3=<OAuth API 3 Name>&oauthapis_apiConsumerKey3=<OAuth API 3 consumer key>&oauthapis_apiConsumerSecret3=<OAuth API 3 consumer secret> &oauthapis_apiTokenEndpoint3=<OAuth API 3 token endpoint url>&webapp=webapp
   HTTP Methods	POST
   Example	curl -X POST -b cookies -H 'Content-Type: application/x-www-form-urlencoded' http://localhost:9763/publisher/asset/webapp  -d <URL_Parameters_specified_above>

3. Add an SSO Provider
   

   Description	Adds an SSO Provider to the application created above.
   URI	http://localhost:9763/publisher/api/sso/addConfig
   JSON Object Parameters	{"provider":"<","logout_url":"https://exampleapp","claims":["http://wso2.org/claims/role","http://wso2.org/claims/otherphone"],"app_name":"helloWorld","app_verison":"1","app_transport":"http","app_context":"helloWorld","app_provider":"admin","app_allowAnonymous":"false","app_acsURL":"https://exampleApp/acs"}'
   HTTP Methods	POST
   Example	curl -v -X POST -b cookies -H 'Content-Type: application/json' http://localhost:9763/publisher/api/sso/addConfig  -d '{"provider":"wso2is-5.0.0","logout_url":"https://exampleapp","claims":["http://wso2.org/claims/role","http://wso2.org/claims/otherphone"],"app_name":"helloWorld","app_verison":"1","app_transport":"http","app_context":"helloWorld","app_provider":"admin","app_allowAnonymous":"false","app_acsURL":"https://exampleApp/acs"}'

Get a given web application

Delete a given web application

Update/edit a web application

Update a service provider

APIs specific to mobile applications

The following REST APIs are specific to mobile applications. 

• Add new mobile application

Add new mobile application

There are three types of mobile applications that can be created via the App Publisher; android, iOS and webapp based mobile apps. In order to create android or iOS mobile apps, use the REST APIs listed below to upload .apk or .IPA binary files. The steps listed below can be omitted for webapp based mobile applications.     

1. Upload a .apk/.IPA binary file

   Description	Uploads a .apk/.IPA file into App Publisher.
   URI	http://localhost:9763/publisher/api/mobileapp/upload
   HTTP Methods	POST
   Content-Type	multipart/form-data
   Payload	-F ‘file=@<APK-File-Path>/<apk-file-name>.apk’
   Example	curl -v -X POST  -b cookies -H "Content-Type: multipart/form-data"nt/appm/APK  -F ‘file=@/home/user/CleanCalc.apk’ http://localhost:9763/publisher/api/mobileapp/upload
   Sample Response	{"path" : "/publisher/api/mobileapp/getfile/X0LURc4DnXEfRBm.apk", "package" : "home.jmstudios.calc", "version" : "1.0"}

2. Create a mobile application

   Description	Creates an android mobile application using the uploaded .apk file.
   URI	http://localhost:9763/publisher/api/asset/mobileapp
   HTTP Methods	POST
   Content-Type	multipart/form-data
   Payload Parameters	Given below are the parameters that you can pass with an mobile application add call. Mandatory parameters are marked with an asterisk(*). Parameter Description Sample Syntax * appmeta The response received at the above API call is used as the ‘appmeta’ value for android and iOS apps. For webapps, the webapp URL is used as the appmeta parameter value. Android: appmeta={"path" : "/publisher/api/mobileapp/getfile/XURc4DnX0LEfRBm.apk", "package" : "home.jmstudios.calc", "version" : "1.0"}   Webapp: appmeta={"weburl":"http://wso2.com"} *provider Mobile app provider name provider=WSO2Mobile *markettype Market type: Android and iOS: enterprise/public Webapp: webapp markettype=enterprise *platform Platform: android/iOS/webapp platform=android *name Name of the mobile app name=Calculator *displayName Display name shown in the App Store displayName=Calculator *description Mobile app description description=The perfect calculator for Android recentChanges Recent changes done recentChanges=Upgraded *version Version of the app version=1.0.0 *category Mobile app category: Business/Communication /Finance/Productivity category=Business' visibility App Store visibility restricting roles visibility=subscriber *bannerFile Banner image file bannerFile=@/home/user/banner.png *screenshot1File Screenshot 1 image file screenshot1File=@/home/user/screenshot1.png screenshot2File Screenshot 2 image file screenshot2File=@/home/user/screenshot2.png screenshot3File Screenshot 3 image file screenshot3File=@/home/user/screenshot3.png *iconFile App icon image file iconFile=@/home/user/icon.png *addNewAssetButton Action to create mobile app addNewAssetButton=Create *mobileapp Mobile app mobileapp=mobileapp
   Example	Android /iOS: curl -v -X POST  -b cookies http://localhost:9763/publisher/api/asset/mobileapp -F 'appmeta={"path" : "/publisher/api/mobileapp/getfile/XURc4DnX0LEfRBm.apk", "package" : "home.jmstudios.calc", "version" : "1.0"}' -F "provider=WSO2Mobile" -F 'markettype=enterprise' -F 'platform=android' -F 'name=Calculator' -F 'displayName=CalculatorApp' -F 'description=Test' -F 'recentChanges=' -F 'version=1.0' -F 'category=Business' -F 'visibility=test' -F 'bannerFile=@home/user/banner.png’ -F 'screenshot1File=@/home/user/screenshot1.png' -F 'screenshot2File=@/home/user/screenshot1.png ' -F 'screenshot3File=@/home/user/screenshot3.png ' -F 'iconFile=@/home/user/icon.png' -F 'addNewAssetButton=Create' -F 'mobileapp=mobileapp'
   Sample Response	{"ok" : "true", "message" : "Asset created.", "id" : "aff9fb92-7e17-4ce8-8024-a747ff5aea41"}

3. Edit a mobile application

   Description	Edits the mobile application.
   URI	http://localhost:9763/publisher/api/asset/{application-id}
   HTTP Methods	POST
   Content-Type	multipart/form-data
   Payload Parameters	Given below are the parameters that you can pass with an mobile application edit call. Parameter Description Sample Syntax appmeta The response received at the above API call is used as the ‘appmeta’ value for android and iOS apps. For webapps, the webapp URL is used as the appmeta parameter value. Android: appmeta={"path" : "/publisher/api/mobileapp/getfile/XURc4DnX0LEfRBm.apk", "package" : "home.jmstudios.calc", "version" : "1.0"}   Webapp: appmeta={"weburl":"http://wso2.com"} provider Mobile app provider name provider=WSO2Mobile markettype Market type: Android and iOS: enterprise/public Webapp: webapp markettype=enterprise platform Platform: android/iOS/webapp platform=android name Name of the mobile app name=Calculator displayName Display name shown in the App Store displayName=Calculator description Mobile app description description=The perfect calculator for Android recentChanges Recent changes done recentChanges=Upgraded version Version of the app version=1.0.0 category Mobile app category: Business/Communication /Finance/Productivity category=Business' visibility App Store visibility restricting roles visibility=subscriber bannerFile Banner image file bannerFile=@/home/user/banner.png screenshot1File Screenshot 1 image file screenshot1File=@/home/user/screenshot1.png screenshot2File Screenshot 2 image file screenshot2File=@/home/user/screenshot2.png screenshot3File Screenshot 3 image file screenshot3File=@/home/user/screenshot3.png iconFile App icon image file iconFile=@/home/user/icon.png addNewAssetButton Action to update mobile app addNewAssetButton=Update mobileapp Mobile app mobileapp=mobileapp
   Example	curl -v -X POST  -b cookies http://localhost:9763/publisher/api/asset/mobileapp/a7c66fcc-faef-400f-b6aa-f592478a02f4 -F 'appmeta={"path" : "/publisher/api/mobileapp/getfile/XwmfexOK5qOx1zZ.apk", "package" : "home.jmstudios.calc", "version" : "1.0"}' -F 'provider=WSO2Mobile' -F 'markettype=enterprise' -F 'platform=android' -F 'name=CalculatorPlus' -F 'displayName=Calculator Plus' -F 'description=More Featured Calculator App' -F 'recentChanges=Added New Features' -F 'version=2.0' -F 'category=Business' -F 'visibility=test' -F 'bannerFile=@/home/user/newBanner.jpg' -F 'screenshot1File=@/home/user/newScreenshot1.jpg' -F 'screenshot2File=@/home/user/newScreenshot2.jpg' -F 'screenshot3File=@/home/user/newScreenshot3.jpg'-F 'iconFile=@/home/user/newIcon.jpg' -F 'addNewAssetButton=Update' -F 'mobileapp=mobileapp'
   Sample Response	{"ok" : true, "message" : "asset updated", "asset" : {"id" : "a7c66fcc-faef-400f-b6aa-f592478a02f4", "name" : "test", "attributes" : {"overview_provider" : "admin", "overview_name" : "test", "overview_version" : "1.0", "overview_description" : "More Featured Calculator App", "overview_recentchanges" : "Added New Features", "overview_status" : "null", "overview_packagename" : "home.jmstudios.calc", "overview_category" : "Business", "overview_appid" : "null", "overview_bundleversion" : "1.0", "overview_url" : "/publisher/api/mobileapp/getfile/XwmfexOK5qOx1zZ.apk", "overview_type" : "enterprise", "overview_visibility" : "test", "overview_displayName" : "Calculator Plus", "overview_createdtime" : "00000001458298000047", "overview_platform" : "android", "images_thumbnail" : "/publisher/api/mobileapp/getfile/SWgoXM1NjMmpBt4.jpg", "images_banner" : "/publisher/api/mobileapp/getfile/ZGdHhP2N22p9gD0.jpg", "images_screenshots" : "/publisher/api/mobileapp/getfile/19aV8BnUr1CRZSy.jpg,,"}}}

4. Delete a mobile application

   Description	Deletes a mobile application.
   URI	http://localhost:9763/publisher/api/mobile/delete/{application-id}
   HTTP Methods	DELETE
   Content-Type	application/x-www-form-urlencoded
   Example	curl -v -X DELETE -b cookies -H 'Content-Type: application/x-www-form-urlencoded' http://localhost:9763/publisher/api/mobile/delete/63deaee8-9cd9-4efb-ab0c-e755c03a3ef1
   Sample Response	200 OK