Contents

Popular

Versions Compared

Old Version 1

changes.mady.by.user Prathewraj M

Saved on

compared with

New Version 2

changes.mady.by.user Prathewraj M

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Expand
titleContents

Table of Contents

Attach different path parameters (URIs) to the Base URL to accomplish various actions in the Application. 

Tip

Base URL: <hostname:portnumber>/apimanagement/manage/v1

Note

All the requests and responses are in JSON format.

Register New Developer

This request adds new developer based on the JSON provided in the body.

URI/developers
HTTPPOST

Sample

Code Block
titleJSON Sample
{
    "developerId":"<developerId>",
    "firstName":"<firstName>",
    "email":"<email>",
    "creationDate":"<creationDate>",
    "lastName":"<lastName>",
    "websiteURL":"<websiteURL>",
    "password":"<password>"
} 

Example Input and Response

Code Block
titleInput
 {      
    "developerId":"t1",
    "firstName":"test",
    "email":"test@test.com"
   }
Code Block
titleOutput/Response
{
    "response": {
        "message": "SignUpSuccessful.",
        "success": true
    }
} 

List Developer

This request lists details for the developer based on the Developer ID provided in the URI.

URI/developers/{developerId}
HTTPGET

Response

Code Block
titleResponse
{
    "developers": [
        {
            "creationDate": 1444210717979,
            "developerId": "t",
            "email": "test@test.com",
            "firstName": "test",
            "password": "-rcAoA"
        }
    ]
}

Edit Developer

This request edits details for the developer based on the Developer ID provided in the URI.

Warning

Do not edit Developer ID.

URI/developers/{developerId}
HTTPPUT

Sample

Code Block
titleSample JSON
 {
    "developerId":"<developerId>",
    "firstName":"<firstName>",
    "email":"<email>",
    "creationDate":"<creationDate>",
    "lastName":"<lastName>",
    "websiteURL":"<websiteURL>",
    "password":"<password>"
      }

Example Input and Response

Code Block
titleSample Input
 {
    "developerId": "t1",
    "firstName": "test1",
    "email": "test@test.com"
   }
Code Block
titleOutput/Response
{
    "response": {
        "message": "Edit Successful",
        "success": true
    }
}

Registering New Application and Editing Existing Application

This request registers new application if not registered previously and also edits an application that is already present.

URI/applications
HTTPPOST
Query ParameterclientId

Sample

Code Block
titleSample JSON
 {
    "id": "<applicationId>",
    "name": "<name>",
    "created":”<Date/timestamp>”
    "description": "<description of application>",
    "productSubscriptions": {
      "<Product Name>" : { “<Subscription object value>”
	  }
    }
  }

Example Input and Response

Code Block
titleInput
  {
            "created": "10/7/15 5:04 PM",
            "description": "test registration-modified",
            "id": "app2",
            "name": "app2",
            "productSubscriptions": {
                "p1": {
                    "consumerKey": "",
                    "consumerSecret": ""
                }
            }
        }
Code Block
titleOutput/Response for new registration
{
    "response": {
        "message": "Registration Successful",
        "success": true
    }
}
Code Block
titleOutput/Response if "id" is already present
{
    "response": {
        "message": "Edit Successful",
        "success": true
    }
}

List Application based on Query parameter

Lists names of application for client Id provided in the Query Parameter.

URI/applications
HTTPGET
Query ParameterclientId

Response

Code Block
titleResponse
{
    "applications": [
        {
            "name": "cs1",
            "productSubscriptions": {}
        }
    ]
}

List Application based on Path parameter

Lists details of the application for theApplication Id provided in the URI.

URI/applications/{applicationId}
HTTPGET

Response

Code Block
titleResponse
{
    "applications": [
        {
            "created": "10/7/15 5:04 PM",
            "description": "test registration-modified",
            "id": "app2",
            "name": "app2",
            "productSubscriptions": {
                "p1": {
                    "consumerKey": "PRgqmfPBwjcFuSEDbnxTWQFy",
                    "consumerSecret": "KgKwshDZTAatnxkUTvvqUuSOeIcNcSQn"
                }
            }
        }
    ]
}

Unregister Application

 This request removes an existing application based on Application Id provided in URI.

URI/applications/{applicationId}
HTTPDELETE

Response

Code Block
titleResponse
{
    "response": {
        "message": "Unregister Successful",
        "success": true
    }
}

Register Product

Register Product in Application with Application Id provided in the URI. 

Info

The product added will be based on the Product Id provided in POST body.

URI/applications/{applicationId}/products
HTTPPOST

Example

Code Block
titleExample
{
    "productId": "p2"
 }

Response

Code Block
titleResponse
{
    "subscriptions": [
        {
            "consumerKey": "peIr-iMKqpDgWegyKEOpqPkC",
            "consumerSecret": "hdEiQiRsQIKlhBcpZBRztvsKSoOylYru"
        }
    ]
}

List Products

List Products based on access level provided in Query Parameter.

URI/products
HTTPGET
Query Parameteraccesslevel

Example

Response

Code Block
titleResponse
{
    "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 APIs based on API ID Provided in the URI.

 

URI/apis/{apiId}
HTTPGET

 

Response

Code Block
titleResponse
{
    "api": {
        "projectDocument": {
            "basePath": "test/1.0",
            "resourceDocs": {
                "DefaultResource": {
                    "customParams": {},
                    "method": "GET",
                    "parameters": {},
                    "path": ""
                }
            },
            "status": "ACTIVE",
            "version": "1.0"
        }
    }
}

Return JSON for APIs

Return JSON for APIs based on the API ID provided in the URI.

 

URI/apis/{apiId}.json
HTTPGET

Response

Code Block
titleResponse
{"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 Project based on the Project ID, Version and Server Group in the URI.

Info

Server Group is the Gateway server name where products will be deployed.

 

URI/apis/{projectId}/{version}/deploy/{ServerGroup}
HTTPPUT

Response

Code Block
titleResponse
{
    "deployStatus": {
        "APIGATEWAY": {
            "status": "success",
            "exception": ""
        }
    }
}

UnDeploy Project

UnDeploy project based on the Project ID, Version and Server Groups in the URI.

URI/apis/{projectId}/{version}/undeploy/{ServerGroup}
HTTPPUT

Response

Code Block
titleResponse
{
    "deployStatus": {
        "APIGATEWAY": {
            "status": "success",
            "exception": ""
        }
    }

List Server Group URL

Lists the URL of the Server Group provided in the URI.

URI/ServerGroups/{ServerGroup}/urls
HTTPGET

Response

Code Block
titleResponse
{
 "urls": [
 "http://192.168.2.46:2160"
 ]
}
Adaptavist ThemeBuilder EngineAtlassian Confluence