Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: typo
Warning
The following Store APIs are deprecated and will be unsupported in a future release. They are provided below for reference by existing users. For a complete list of the currently supported Store APIs, go to https://docs.wso2.com/display/AM2xxAM250/apidocs/store/.

Table of Contents
maxLevel4
minLevel4

...

DescriptionAdd a new API Consumer.
URIhttp://localhost:9763/store/site/blocks/user/sign-up/ajax/user-add.jag
URI Parameters

action=addUser&username=<username>&password=<password>&allFieldsValues=<first_name>|<last_name>|<organization>|

<address>|

<country>|<email>|<land>|<mobile>|<IM>|<url>

Note

The parameters listed above (e.g., <first_name>, <country>) are based on the claims that are enabled by default for the http://wso2.org/claims claim dialect and also based on the display orders of the claim. If you enable or add anymore claims, you need to add them as URI parameters based on the display order of the claim.

HTTP MethodsPOST
Example

curl 'http://localhost:9763/store/site/blocks/user/sign-up/ajax/user-add.jag' -H 'Accept: application/json' --data 'action=addUser&username=kimhill

=username

&password=kimhill1234&allFieldsValues=Kim|Hill|ABC Network

|30 Palm Road ,Pasadena,California

|USA|kim@abcnetwork.com|0016269934122|0016269934134|kimhill|www.abcNsounds.org/'

Search APIs

DescriptionSearch for APIs using a given query.
URI

http://localhost:9763/store/site/blocks/search/api-search/ajax/search.jag

URI Parameters

action=searchAPIs&query=<query>&start=<number>&end=<number>

The start and end parameters determine the range of APIs you want to retrieve. For example, if start=1 and end=3, the first 3 APIs that appear in the search results will be returned. Note that both 0 and 1 represent the first API in the search results, so start=0 and start=1 both means the same.

HTTP MethodsPOST
Example

curl -X POST -b cookies "http://localhost:9763/store/site/blocks/search/api-search/ajax/search.jag" -d "action=searchAPIs&query=test&start=0&end=3"

...

DescriptionProvisions an OAuth client that was created out-of-band.
URIhttp://localhost:9763/store/site/blocks/subscription/subscription-add/ajax/subscription-add.jag
URI Parameters

action=mapExistingOauthClient&application=<APPLICATION NAME>&keytype=PRODUCTION/SANDBOX&callbackUrl=<URL>&authorizedDomains=<authorized_domains>& validityTime=<time duration in seconds>&client_id=<client-ID>
<authorized_domains> =  The domains from which requests are allowed to the APIs.

HTTP MethodsPOST
Example

curl -X POST -b cookies http://localhost:9763/store/site/blocks/subscription/subscription-add/ajax/subscription-add.jag -d 'action=mapExistingOauthClient&application=NewApp1&keytype=PRODUCTION&callbackUrl=google.com&authorizedDomains=ALL&validityTime=3600&client_id=mPbgvinvpEk1QcSrw962TLICriUa& jsonParams={"username":"admin","key_type":"PRODUCTION","client_secret":"ynEI1ugq1_RCTJ9bM8jtD9RCsdoa","validityPeriod":"3600","client_id":"mPbgvinvpEk1QcSrw962TLICriUa"}'

...