This documentation is for WSO2 App Manager 1.0.0. View documentation for the latest release.
Store APIs - App Manager 1.0.0 - WSO2 Documentation
                                                                                                                                                                                                                                                                                                 
||
Skip to end of metadata
Go to start of metadata

App Manager Store provides below rest APIs for App Management.

Note

When you access any API other than the login, logout and application detail retrieval APIs through an external REST client such as cURL, first invoke the login API to ensure that user is authenticated. When the login API is invoked, the system stores the generated session cookie in a file, which we use in the next API invocations.

Login

DescriptionLog in to App Store.
URIhttp://localhost:9763/store/apis/user/login
JSON Object Parameters'{"username":"xxxxxx","password":"xxxxxx"}
HTTP MethodsPOST
Examplecurl -c cookies -H "Content-Type: application/json" -X POST -d '{"username":"admin","password":"admin"}' http://localhost:9763/store/apis/user/login

Logout

DescriptionLog out from App Store.
URIhttp://localhost:9763/store/apis/user/logout
URI ParametersNone
HTTP MethodsGET
Examplecurl -b cookies  http://localhost:9763/store/apis/user/logout

User Signup

DescriptionAdd a new store user
URIhttp://localhost:9763/store/apis/user/register
JSON Object Parameters'{"username":"xxxxxx","password":"xxxxxx"}'
HTTP MethodsPOST
Examplecurl -b cookies -H "Content-Type: application/json" -X POST -d '{"username":"storeUser","password":"stroreUser123"}' http://localhost:9763/store/apis/user/register

Subscribing to a webapp

DescriptionSubscribing to a web application
URIhttp://localhost:9763/store/resources/webapp/v1/subscription/app
URL ParametersapiName=<webapp-name>&apiVersion=<webapp-version>&apiTier=<tier>&subscriptionType=<Subscription Type>&apiProvider=<webapp-provider>&appName=DefaultApplication
HTTP MethodsPOST
Examplecurl -b cookies -X POST -d 'apiName=HelloWorldApp&apiVersion=v1.0.0&apiTier=Unlimited&subscriptionType=INDIVIDUAL&apiProvider=admin&appName=DefaultApplication'  http://localhost:9763/store/resources/webapp/v1/subscription/app

Unsubscribing to a webapp

DescriptionUnsubscribing to a web application
URIhttp://localhost:9763/store/resources/webapp/v1/unsubscription/app
URL ParametersapiName=<webapp-name>&apiVersion=<webapp-version>&apiTier=<tier>&subscriptionType=<Subscription Type>&apiProvider=<webapp-provider>&appName=DefaultApplication
HTTP MethodsPOST
Example curl -b cookies -X POST -d 'apiName=dwqdqwdq&apiVersion=qwdqwd&apiTier=Unlimited&subscriptionType=INDIVIDUAL&apiProvider=admin&appName=DefaultApplication' http://localhost:9763/store/resources/webapp/v1/unsubscription/app

Get all Subscriptions of a webapp

DescriptionRetrieves details of all subscribers of a particular webapp
URI http://localhost:9763/store/resources/webapp/v1/subscriptions/{providerName}/{webappName}/
HTTP MethodsGET
Example curl -b cookies http://localhost:9763/store/resources/webapp/v1/subscriptions/admin/HelloWorld/v1.0.0

Get Subscription details of a webapp

DescriptionRetrieves subscription details of a given webapp
URI http://localhost:9763/store/resources/webapp/v1/subscription/{WebappName}
HTTP MethodsGET
Examplecurl -b cookies  http://localhost:9763/store/resources/webapp/v1/subscription/HelloWorld

Get all tags in App Store

DescriptionRetrieves all tags used in App Store under the given app type. The response contains an array of tag values along with the number of applications created under each tag
URI http://localhost:9763/store/apis/tag/{app-type}
HTTP MethodsGET
Examplecurl -b cookies  http://localhost:9763/store/apis/tag/webapp

Get details of a given web application with a given version

Note

In order to access this API, you need to provide user credentials of an admin user ( A user who has been assigned with 'admin' role) for basic authentication. Invoking login API is not required for this API.

DescriptionRetrieves the details of the web application specified with the name and the version.
URIhttp://localhost:9763/store/apis/v1/assets/{app-type}/{provider-name}/{app-name}/{app-version}
HTTP MethodsGET
Examplecurl -k -X GET "http://localhost:9763/store/apis/v1/assets/webapp/admin/helloWorld/v1" --user admin:admin

Get details of all the versions of a given web application 

Note

In order to access this API, you need to provide user credentials of an admin user ( A user who has been assigned with 'admin' role) for basic authentication. Invoking login API is not required for this API.

DescriptionRetrieves the details of all the versions of the web application under a given name.
URIhttp://localhost:9763/store/apis/v1/assets/{app-type}/{provider-name}/{app-name}
HTTP MethodsGET
Examplecurl -k -X GET "http://localhost:9763/store/apis/v1/assets/webapp/admin/helloWorld" --user admin:admin

Get details of all web applications

Note

In order to access this API, you need to provide user credentials of an admin user ( A user who has been assigned with 'admin' role) for basic authentication. Invoking login API is not required for this API.

DescriptionRetrieves the details of all the available web applications. In order to access this API, you need to provide user credentials of an admin user.
URIhttp://localhost:9763/store/apis/v1/assets/{app-type}/
HTTP MethodsGET
Example curl -k -X GET "http://localhost:9763/store/apis/v1/assets/webapp" --user admin:admin

Get details of all web applications under a given provider

Note

In order to access this API, you need to provide user credentials of an admin user ( A user who has been assigned with 'admin' role) for basic authentication. Invoking login API is not required for this API.

DescriptionRetrieves the details of all the application created by a given provider name.
URIhttp://localhost:9763/store/apis/v1/assets/{app-type}/{provider-name}
HTTP MethodsGET
Example curl -k -X GET "http://localhost:9763/store/apis/v1/assets/webapp/admin" --user admin:admin

Get details of paginated web application

Note

In order to access this API, you need to provide user credentials of an admin user ( A user who has been assigned with 'admin' role) for basic authentication. Invoking login API is not required for this API.

DescriptionRetrieves the details of web applications under given pagination range. (App details in between app count)
URIhttp://localhost:9763/store/apis/{version}/assets/{type}?start={start}&count={count}
HTTP MethodsGET
Examplecurl -k -X GET "http://localhost:9763/store/apis/v1/assets/webapp?start=0&count=5" --user admin:admin

 

Check for user existance

DescriptionCheck whether a given user is existing in the system or not
URI http://localhost:9763/store/apis/user/exists
JSON Object Parameters{"username":"<username>"}
HTTP MethodsPOST
Examplecurl -b cookies -H "Content-Type: application/json" -X POST -d '{"username":"storeUser"}' http://localhost:9763/store/apis/user/exists

 

 

 

 

 

 

 

  • No labels