GET https://apis.wso2.com/api/am/store/v0.13/apis/{apiId}
Using this operation, you can retrieve complete details of a single API. You need to provide the Id of the API to retrive it. `X-WSO2-Tenant` header can be used to retrive an API of a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used. **NOTE:** * This operation does not require an Authorization header by default. But if it is provided, it will be validated and checked for permissions of the user, hence you may be able to see APIs which are restricted for special permissions/roles. \n
Not required
GET https://localhost:9443/api/am/store/v0.13/apis/c43a325c-260b-4302-81cb-768eafaa3aed
HTTP/1.1 200 OK
Content-Type: application/json
{
"thumbnailUrl": null,
"tiers": ["Unlimited"],
"businessInformation": {
"technicalOwner": "John Doe",
"technicalOwnerEmail": "architecture@pizzashack.com",
"businessOwner": "Jane Roe",
"businessOwnerEmail": "marketing@pizzashack.com"
},
"apiDefinition": "{\"paths\":{\"/order\":{\"post\":{\"x-auth-type\":\"Application & Application User\",\"x-throttling-tier\":\"Unlimited\",\"description\":\"Create a new Order\",\"parameters\":[{\"schema\":{\"$ref\":\"#/definitions/Order\"},\"description\":\"Order object that needs to be added\",\"name\":\"body\",\"required\":true,\"in\":\"body\"}],\"responses\":{\"201\":{\"headers\":{\"Location\":{\"description\":\"The URL of the newly created resource.\",\"type\":\"string\"},\"Content-Type\":{\"description\":\"The content type of the body.\",\"type\":\"string\"}},\"schema\":{\"$ref\":\"#/definitions/Order\"},\"description\":\"Created. Successful response with the newly created object as entity in the body. Location header contains URL of newly created entity.\"}}}},\"/order/{orderId}\":{\"get\":{\"x-auth-type\":\"Application & Application User\",\"x-throttling-tier\":\"Unlimited\",\"description\":\"Get details of an Order\",\"parameters\":[{\"description\":\"Order Id\",\"name\":\"orderId\",\"format\":\"string\",\"type\":\"string\",\"required\":true,\"in\":\"path\"}],\"responses\":{\"200\":{\"schema\":{\"$ref\":\"#/definitions/Order\"},\"headers\":{},\"description\":\"OK Requested Order will be returned\"}}}}},\"schemes\":[\"https\"],\"produces\":[\"application/json\"],\"swagger\":\"2.0\",\"definitions\":{\"Order\":{\"title\":\"Pizza Order\",\"properties\":{\"customerName\":{\"type\":\"string\"},\"delivered\":{\"type\":\"boolean\"},\"address\":{\"type\":\"string\"},\"pizzaType\":{\"type\":\"string\"},\"creditCardNumber\":{\"type\":\"string\"},\"quantity\":{\"type\":\"number\"},\"orderId\":{\"type\":\"string\"}},\"required\":[\"orderId\"]}},\"consumes\":[\"application/json\"],\"info\":{\"title\":\"PizzaShackAPI\",\"description\":\"This document describe a RESTFul API for Pizza Shack online pizza delivery store.\\n\",\"license\":{\"name\":\"Apache 2.0\",\"url\":\"http://www.apache.org/licenses/LICENSE-2.0.html\"},\"contact\":{\"email\":\"architecture@pizzashack.com\",\"name\":\"John Doe\",\"url\":\"http://www.pizzashack.com\"},\"version\":\"1.0.0\"}}",
"wsdlUri": null,
"isDefaultVersion": false,
"endpointURLs": [ {
"environmentName": "Production and Sandbox",
"environmentType": "hybrid",
"environmentURLs": {
"http": "http://localhost:8280//pizzashack/1.0.0",
"https": "https://localhost:8243//pizzashack/1.0.0"
}
}],
"transport": [
"http",
"https"
],
"tags": ["pizza"],
"version": "1.0.0",
"description": "This document describe a RESTFul API for Pizza Shack online pizza delivery store.\r\n",
"provider": "admin",
"name": "PizzaShackAPI",
"context": "/pizzashack/1.0.0",
"id": "8848faaa-7fd1-478a-baa2-48a4ebb92c98",
"status": "PUBLISHED"
}
curl https://localhost:9443/api/am/store/v0.13/apis/c43a325c-260b-4302-81cb-768eafaa3aed
curl -k -H "X-WSO2-Tenant:test.com" https://localhost:9443/api/am/store/v0.13/apis/c43a325c-260b-4302-81cb-768eafaa3aed
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
apiId required |
**API ID** consisting of the **UUID** of the API. Using the **UUID** in the API call is recommended. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. |
String | |
Header |
Accept optional |
Media types acceptable for the response. Default is application/json. |
String |
application/json |
Header |
If-None-Match optional |
Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. |
String | |
Header |
If-Modified-Since optional |
Validator for conditional requests; based on Last Modified header of the formerly retrieved variant of the resource (Will be supported in future). |
String | |
Header |
X-WSO2-Tenant optional |
For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. |
String |
HTTP Code | Description | Schema |
---|---|---|
200 |
OK. Requested API is returned |
API |
304 |
Not Modified. Empty body because the client has already the latest version of the requested resource. |
|
404 |
Not Found. Requested API does not exist. |
Error |
406 |
Not Acceptable. The requested media type is not supported |
Error |
GET https://apis.wso2.com/api/am/store/v0.13/apis/{apiId}/swagger
You can use this operation to retrieve the swagger definition of an API. `X-WSO2-Tenant` header can be used to retrive the swagger definition an API of a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used. **NOTE:** * This operation does not require an Authorization header by default. But in order to see a restricted API's swagger definition, you need to provide Authorization header.
Not required
GET https://localhost:9443/api/am/store/v0.13/apis/c43a325c-260b-4302-81cb-768eafaa3aed/swagger
HTTP/1.1 200 OK
Content-Type: application/json
{
"paths": {"/*": {"get": {
"x-auth-type": "Application",
"x-throttling-tier": "Unlimited",
"responses": {"200": {"description": "OK"}}
}}},
"x-wso2-security": {"apim": {"x-wso2-scopes": []}},
"swagger": "2.0",
"info": {
"title": "PhoneVerification",
"description": "Verify a phone number",
"contact": {
"email": "xx@ee.com",
"name": "xx"
},
"version": "2.0.0"
}
}
curl https://localhost:9443/api/am/store/v0.13/apis/c43a325c-260b-4302-81cb-768eafaa3aed/swagger
curl -k -H "X-WSO2-Tenant:test.com" https://localhost:9443/api/am/store/v0.13/apis/c43a325c-260b-4302-81cb-768eafaa3aed/swagger
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
apiId required |
**API ID** consisting of the **UUID** of the API. Using the **UUID** in the API call is recommended. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. |
String | |
Header |
Accept optional |
Media types acceptable for the response. Default is application/json. |
String |
application/json |
Header |
If-None-Match optional |
Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. |
String | |
Header |
If-Modified-Since optional |
Validator for conditional requests; based on Last Modified header of the formerly retrieved variant of the resource (Will be supported in future). |
String | |
Header |
X-WSO2-Tenant optional |
For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. |
String |
HTTP Code | Description | Schema |
---|---|---|
200 |
OK. Requested swagger document of the API is returned |
|
304 |
Not Modified. Empty body because the client has already the latest version of the requested resource. |
|
404 |
Not Found. Requested API does not exist. |
Error |
406 |
Not Acceptable. The requested media type is not supported |
Error |
GET https://apis.wso2.com/api/am/store/v0.13/apis/{apiId}/thumbnail
This operation can be used to download a thumbnail image of an API. `X-WSO2-Tenant` header can be used to retrive a thumbnail of an API that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used. **NOTE:** * This operation does not require an Authorization header by default. But in order to see a restricted API's thumbnail, you need to provide Authorization header.
Not required
GET https://localhost:9443/api/am/store/v0.13/apis/e93fb282-b456-48fc-8981-003fb89086ae/thumbnail
HTTP/1.1 200 OK
Content-Type: image/jpeg
[image content]
curl https://localhost:9443/api/am/store/v0.13/apis/e93fb282-b456-48fc-8981-003fb89086ae/thumbnail > image.jpg
curl -k -H "X-WSO2-Tenant:test.com" https://localhost:9443/api/am/store/v0.13/apis/e93fb282-b456-48fc-8981-003fb89086ae/thumbnail > image.jpg
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
apiId required |
**API ID** consisting of the **UUID** of the API. Using the **UUID** in the API call is recommended. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. |
String | |
Header |
X-WSO2-Tenant optional |
For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. |
String | |
Header |
Accept optional |
Media types acceptable for the response. Default is application/json. |
String |
application/json |
Header |
If-None-Match optional |
Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. |
String | |
Header |
If-Modified-Since optional |
Validator for conditional requests; based on Last Modified header of the formerly retrieved variant of the resource (Will be supported in future). |
String |
HTTP Code | Description | Schema |
---|---|---|
200 |
OK. Thumbnail image returned |
|
304 |
Not Modified. Empty body because the client has already the latest version of the requested resource. |
|
404 |
Not Found. Requested Document does not exist. |
Error |
406 |
Not Acceptable. The requested media type is not supported |
Error |
POST https://apis.wso2.com/api/am/store/v0.13/apis/generate-sdk/
This operation can be used to generate SDK for an API by providing the id of the API along with the preferred language.
apim:subscribe
i
POST https://localhost:9443/api/am/store/v0.13/apis/generate-sdk?apiId=e93fb282-b456-48fc-8981-003fb89086ae&language=java
Authorization: Bearer 2e29904b-f3b0-366e-ba13-b469abedd88e
HTTP/1.1 200 OK
Content-Disposition: attachment; filename="PizzaShackAPI_1.0.0_java.zip"
Content-Type: application/zip
[zip content]
curl -k -H "Authorization: Bearer 2e29904b-f3b0-366e-ba13-b469abedd88e" -X POST 'https://localhost:9443/api/am/store/v0.13/apis/generate-sdk?apiId=5721d128-76d0-4cb9-b300-2bd9578beddb&language=java' > PizzaAPI_Java_SDK.zip
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
apiId required |
**API ID** consisting of the **UUID** of the API. Using the **UUID** in the API call is recommended. The combination of the provider of the API, name of the API and the version is also accepted as a valid API I. Should be formatted as **provider-name-version**. |
String | |
Query |
language required |
Programming language to generate SDK. |
String | |
Header |
X-WSO2-Tenant optional |
For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. |
String |
HTTP Code | Description | Schema |
---|---|---|
200 |
OK. SDK generated successfully. |
|
400 |
Bad request. SDK language is not supported. |
Error |
404 |
Not Found. Requested API does not exist. |
Error |
406 |
Not Acceptable. The requested media type is not supported |
Error |