Store APIs

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.

URI	http://localhost:9763/store/site/blocks/user/login/ajax/login.jag
Description	Log in to API Store.
URI Parameters	action=login&username=xxx&password=xxx
HTTP Methods	POST
Example	curl -X POST -c cookies http://localhost:9763/store/site/blocks/user/login/ajax/login.jag -d 'action=login&username=user1&password=xxx'

Logout

URI	http://localhost:9763/store/site/blocks/user/login/ajax/login.jag
Description	Log out from API Store.
URI Parameters	?action=logout
HTTP Methods	GET
Example	curl -b cookies http://localhost:9763/publisher/site/blocks/user/login/ajax/login.jag?action=logout

User Signup

URI Parameters	action=addUser&username=xxx&password=xxx
Description	Add a new API Consumer.
URI	http://localhost:9763/store/site/blocks/user/sign-up/ajax/user-add.jag
HTTP Methods	POST
Example	curl -X POST -b cookies http://localhost:9763/store/site/blocks/user/sign-up/ajax/user-add.jag -d “action=addUser&username=user2&password=xxx”'

Add an Application

URI Parameters	action=addApplication&application=xxx
Description	Add a new application.
URI	http://localhost:9763/store/site/blocks/application/application-add/ajax/application-add.jag
HTTP Methods	POST
Example	curl -X POST -b cookies http://localhost:9763/store/site/blocks/application/application-add/ajax/application-add.jag -d 'action=addApplication&application=app1&tier=unlimited&callbackUrl="

Update an Application

URI Parameters	action=updateApplication&applicationOld=xxx&applicationNew=xxx
Description	Update an existing application.
URI	http://localhost:9763/store/site/blocks/application/application-update/ajax/application-update.jag
HTTP Methods	POST
Example	curl -X POST -b cookies http://localhost:9763/store/site/blocks/application/application-update/ajax/application-update.jag -d 'action=updateApplication&applicationOld=app1&applicationNew=app2'

Get an Application

URI Parameters	?action=getApplications&username=xxx
Description	Get details of an application.
URI	http://localhost:9763/store/site/blocks/application/application-list/ajax/application-list.jag
HTTP Methods	GET
Example	curl -b cookies http://localhost:9763/store/site/blocks/application/application-list/ajax/applicationlist.jag?action=getApplications&username=user1

Remove an Application

URI Parameters	action=removeApplication&application=xxx
Description	Remove an existing application.
URI	http://localhost:9763/store/site/blocks/application/application-remove/ajax/application-remove.jag
HTTP Methods	POST
Example	curl -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

URI Parameters	action=addSubscription&name=xxx&version=xxx&provider=xxx&tier=xxx&applicationId=xxx
Description	Add a new API subscription.
URI	http://localhost:9763/store/site/blocks/subscription/subscription-add/ajax/subscription-add.jag
HTTP Methods	POST
Example	curl -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

URI Parameters	action=getAllSubscriptions&username=xxx
Description	List all API subscriptions.
URI	http://localhost:9763/store/site/blocks/subscription/subscription-list/ajax/subscription-list.jag
HTTP Methods	GET
Example	curl -b cookies http://localhost:9763/store/site/blocks/subscription/subscription-list/ajax/subscription-list.jag?action=getAllSubscriptions&username=user1

Remove a Subscription

URI Parameters	action=removeSubscription&name=xxx&version=xxx&provider=xxx&applicationId=xxx
Description	Remove an API subscription.
URI	http://localhost:9763/store/site/blocks/subscription/subscription-remove/ajax/subscription-remove.jag
HTTP Methods	POST
Example	curl -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

URI Parameters	action=addComment&name=xxx&version=xxx&provider=xxx&comment=xxx
Description	Add a comment for an API.
URI	http://localhost:9763/store/site/blocks/comment/comment-add/ajax/comment-add.jag
HTTP Methods	POST
Example	curl -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”