...
Register New Developer
This request adds a new developer based on the JSON provided in the body of the message.
| URI | /developers |
|---|---|
| HTTP | POST |
Sample
...
Registering New Application and Editing Existing Application
This request registers a new application if not registered previously and also as well as edits an application that is already present.
...
List Application based on Query parameter
Lists This request lists names of application applications listed for client Id provided in the Query Parameter.
...
List Application based on Path parameter
Lists This request lists details of the application applications for theApplication Id ID provided in the URI.
| URI | /applications/{applicationId} |
|---|---|
| HTTP | GET |
...
This request removes an existing application based on the Application Id ID provided in URI.
| URI | /applications/{applicationId} |
|---|---|
| HTTP | DELETE |
...
| Code Block | ||
|---|---|---|
| ||
{
"response": {
"message": "Unregister Successful",
"success": true
}
} |
Register Product
Register Product in This request registers a Product within the Application with Application Id ID provided in the URI.
| Info |
|---|
The product added will be based on the Product Id ID provided in the POST body. |
| URI | /applications/{applicationId}/products |
|---|---|
| HTTP | POST |
...
| Code Block | ||
|---|---|---|
| ||
{
"subscriptions": [
{
"consumerKey": "peIr-iMKqpDgWegyKEOpqPkC",
"consumerSecret": "hdEiQiRsQIKlhBcpZBRztvsKSoOylYru"
}
]
} |
List Products
List request lists Products based on the access level provided in the Query Parameter.
| URI | /products |
|---|---|
| HTTP | GET |
| Query Parameter | accesslevel |
...
| Code Block | ||
|---|---|---|
| ||
{
"products": [
{
"accessLevel": "PUBLIC",
"apis": [
"test__1.0"
],
"description": "p1",
"environments": [
"Development"
],
"name": "p1",
"productId": "p1",
"subscribed": false
},
{
"accessLevel": "PUBLIC",
"apis": [
"test__1.0"
],
"description": "p2",
"environments": [
"Development"
],
"name": "p2",
"productId": "p2",
"subscribed": false
}
]
} |
List APIs
List This request lists APIs based on the API ID Provided in the URI.
...
| Code Block | ||
|---|---|---|
| ||
{
"api": {
"projectDocument": {
"basePath": "test/1.0",
"resourceDocs": {
"DefaultResource": {
"customParams": {},
"method": "GET",
"parameters": {},
"path": ""
}
},
"status": "ACTIVE",
"version": "1.0"
}
}
} |
Return JSON for APIs
Return This request returns JSON for APIs based on the API ID provided in the URI.
...
| Code Block | ||
|---|---|---|
| ||
{"message":"{\"basePath\":\"\\/test\\/1.0\",\"host\":\"localhost\",\"paths\":{\"\\/\":{\"get\":{\"operationId\":\"DefaultResource\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}},\"swagger\":\"2.0\",\"info\":{\"version\":\"1.0\",\"title\":\"test\"}}"} |
Deploy Project
Deploy This request deploys a Project based on the Project ID, Version and Server Group provided in the URI.
| Info |
|---|
Server Group is the Gateway server name where products will be are deployed. |
| URI | /apis/{projectId}/{version}/deploy/{ServerGroup} |
|---|---|
| HTTP | PUT |
...
| Code Block | ||
|---|---|---|
| ||
{
"deployStatus": {
"APIGATEWAY": {
"status": "success",
"exception": ""
}
}
} |
UnDeploy Project
UnDeploy This request undeploys a project based on the Project ID, Version and Server Groups provided in the URI.
| URI | /apis/{projectId}/{version}/undeploy/{ServerGroup} |
|---|---|
| HTTP | PUT |
...
| Code Block | ||
|---|---|---|
| ||
{
"deployStatus": {
"APIGATEWAY": {
"status": "success",
"exception": ""
}
} |
List Server Group URL
Lists This request lists the URL of the Server Group provided in the URI.
| URI | /ServerGroupsenviornments/{ServerGroupEnvironment}/urls |
|---|---|
| HTTP | GET |
Response
| Code Block | ||
|---|---|---|
| ||
{
"urls": [
"http://192.168.2.46:2160"
]
} |