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

Store APIs provide the following REST resources.

Note: When you access any API other than the login and logout 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.

Alternatively, if you access these APIs from the API Store application itself, you do not have to invoke the login API first.

Login

DescriptionLog in to API Store.
URIhttp://localhost:9763/store/site/blocks/user/login/ajax/login.jag
URI Parametersaction=login&username=xxx&password=xxx
HTTP MethodsPOST
Examplecurl -X POST -c cookies http://localhost:9763/store/site/blocks/user/login/ajax/login.jag -d 'action=login&username=user1&password=xxx'

Logout

DescriptionLog out from API Store.
URIhttp://localhost:9763/store/site/blocks/user/login/ajax/login.jag
URI Parameters?action=logout
HTTP MethodsGET
Examplecurl -b cookies http://localhost:9763/publisher/site/blocks/user/login/ajax/login.jag?action=logout

User Signup

DescriptionAdd a new API Consumer.
URIhttp://localhost:9763/store/site/blocks/user/sign-up/ajax/user-add.jag
URI Parametersaction=addUser&username=xxx&password=xxx&allFieldsValues=firstname|lastname|email
HTTP MethodsPOST
Examplecurl -X POST -b cookies http://localhost:9763/store/site/blocks/user/sign-up/ajax/user-add.jag -d “action=addUser&username=user2&password=xxx&allFieldsValues=firstname|lastname|email”

Get all Published APIs

DescriptionGet a list of all published APIs.
URIhttp://localhost:9763/store/site/blocks/api/listing/ajax/list.jag
URI Parameters?action=getAllPublishedAPIs
HTTP MethodsGET
Examplecurl -b cookies  http://localhost:9763/store/site/blocks/api/listing/ajax/list.jag?action=getAllPublishedAPIs

Get Published APIs by Application

DescriptionGet a list of published APIs filtered by the subscribed Application. Login API needs be called prior to calling this API.
URIhttp://localhost:9763/store/site/blocks/subscription/subscription-list/ajax/subscription-list.jag
URI Parametersaction=getSubscriptionByApplication&app=App1
HTTP MethodsGET
Examplecurl -b cookies 'http://localhost:9763/store/site/blocks/subscription/subscription-list/ajax/subscription-list.jag?action=getSubscriptionByApplication&app=App1'

Add an Application

DescriptionAdd a new application.
URIhttp://localhost:9763/store/site/blocks/application/application-add/ajax/application-add.jag
URI Parametersaction=addApplication&application=xxx&tier=xxx&description=xxx&callbackUrl
HTTP MethodsPOST
Examplecurl -X POST -b cookies    http://localhost:9763/store/site/blocks/application/application-add/ajax/application-add.jag -d 'action=addApplication&application=app1&tier=unlimited&description=&callbackUrl='

Update an Application

Description Update an existing application.
URI http://localhost:9763/store/site/blocks/application/application-update/ajax/application-update.jag
URI Parameters

action=updateApplication&applicationOld=xxx&applicationNew=xxx&callbackUrlNew=xxx&descriptionNew=xxx&tier=xxx

HTTP MethodsPOST
Examplecurl -X POST -b cookies    http://localhost:9763/store/site/blocks/application/application-update/ajax/application-update.jag -d 'action=updateApplication&applicationOld=app1&applicationNew=app2&tier=unlimited&descriptionNew=&callbackUrlNew'

Get Applications

DescriptionGet list of applications.
URIhttp://localhost:9763/store/site/blocks/application/application-list/ajax/application-list.jag
URI Parameters?action=getApplications
HTTP MethodsGET
Examplecurl -b cookies   http://localhost:9763/store/site/blocks/application/application-list/ajax/application-list.jag?action=getApplications

Remove an Application

DescriptionRemove an existing application.
URI   http://localhost:9763/store/site/blocks/application/application-remove/ajax/application-remove.jag
URI Parameters

action=removeApplication&application=xxx

HTTP MethodsPOST
Examplecurl -X POST -b cookies   http://localhost:9763/store/site/blocks/application/application-remove/ajax/application-remove.jag -d "action=removeApplication&application=app2"

Add a Subscription

DescriptionAdd a new API subscription.
URI http://localhost:9763/store/site/blocks/subscription/subscription-add/ajax/subscription-add.jag
URI Parameters

action=addSubscription&name=xxx&version=xxx&provider=xxx&tier=xxx&applicationId=xxx

HTTP MethodsPOST
Examplecurl -X POST -b cookies    http://localhost:9763/store/site/blocks/subscription/subscription-add/ajax/subscription-add.jag -d 'action=addSubscription&name=API1&version=1.0.0&provider=user1&tier=gold&applicationId=1'

List Subscriptions

DescriptionList all API subscriptions.
URIhttp://localhost:9763/store/site/blocks/subscription/subscription-list/ajax/subscription-list.jag
URI Parameters

action=getAllSubscriptions

HTTP MethodsGET
Examplecurl -b cookies    http://localhost:9763/store/site/blocks/subscription/subscription-list/ajax/subscription-list.jag?action=getAllSubscriptions

Remove a Subscription

DescriptionRemove an API subscription.
URIhttp://localhost:9763/store/site/blocks/subscription/subscription-remove/ajax/subscription-remove.jag
URI Parameters

action=removeSubscription&name=xxx&version=xxx&provider=xxx&applicationId=xxx

HTTP MethodsPOST
Examplecurl -X POST -b cookies   http://localhost:9763/store/site/blocks/subscription/subscription-remove/ajax/subscription-remove.jag -d 'action=removeSubscription&name=API1&version=1.0.0&provider=user1&applicationId=1'

Add an API Comment

DescriptionAdd a comment for an API.
URIhttp://localhost:9763/store/site/blocks/comment/comment-add/ajax/comment-add.jag
URI Parameters

action=addComment&name=xxx&version=xxx&provider=xxx&comment=xxx

HTTP MethodsPOST
Examplecurl -X POST -b cookies    http://localhost:9763/store/site/blocks/comment/comment-add/ajax/comment-add.jag -d 'action=addComment&name=API1&version=1.0.0&provider=user1&comment=Hello'
  • No labels