Overview

The API function described below is for account linkage between "Enterprise Cloud API Account" and "API Gateway Account" to utilize Enterprise Cloud API via API Gateway. Customer is able to do the same oparation over the GUI. (to be released in Sep. 2015)

Resource URL

"Globally Common Domain (Global Load Balance)" or "Individual Region Domain (Region)" should be utilized. When using the globally common domain, a connection will be made to the nearest API Gateway according to the Customer's usage details.

1.Base Path(Global Load Balance)

https://api.ntt.com/v1/ec-vcd-reg/accounts

2.Base Path(Region)

https://{region}.api.ntt.com/v1/ec-vcd-reg/accounts

• The API Gateway region can be selected from JP, US, or UK.
• Available regions for selection are planned to be expanded.

Resource Information

• #1: Implements appropriate flow limitations per customer's connectivity.

1. Obtaining Account Linkage Information

GET /v1/ec-vcd-reg/accounts

Request Parameters

Example Request

 GET /v1/ec-vcd-reg/accounts?clientId=****&clientSecret=****

Response Parameters

Example Result

{
    "entities": [
        {
            "clientId": "**********", 
            "clientSecret": "**********", 
            "created": 1436850272679, 
            "ecVcdId": "**********", 
            "ecVcdOrg": "**********", 
            "ecVcdPassword": "**********", 
            "metadata": {
                "path": "/accounts/**********"
            }, 
            "modified": 1436850272679, 
            "type": "account", 
            "uuid": "**********"
        }
    ]
}

2. Registering Account Linkage

Following API links Enterprise Cloud Account to API Gateway account.

POST /v1/ec-vcd-reg/accounts

Request Parameters

Example Request

Content-Type: application/json; charset=utf-8
Host: api.ntt.com

POST /v1/ec-vcd-reg/accounts
{
   "clientId":"*************",
   "clientSecret":"*************",
   "ecVcdId":"*************",
   "ecVcdOrg":"*************",
   "ecVcdPassword":"*************"
}

Response Parameters

Example Result

{
    "entities": [
        {
            "clientId": "**********", 
            "clientSecret": "**********", 
            "created": 1436850272679, 
            "ecVcdId": "**********", 
            "ecVcdOrg": "**********", 
            "ecVcdPassword": "**********", 
            "metadata": {
                "path": "/accounts/**********"
            }, 
            "modified": 1436850272679, 
            "type": "account", 
            "uuid": "**********"
        }
    ]
}

3. Deliting Account Linkage

Following API will delete the account linkage between Enterprise Cloud API and API Gateway.
DELETE /v1/ec-vcd-reg/accounts

Request Parameters

Example Request

Content-Type: application/json; charset=utf-8
Host: api.ntt.com

DELETE /v1/ec-vcd-reg/accounts
{
   "uuid":"*************",
   "clientId":"*************",
   "clientSecret":"*************"
}

Response Parameters

Example Result

{
    "entities": [
        {
            "clientId": "**********", 
            "clientSecret": "**********", 
            "created": 1436850272679, 
            "ecVcdId": "**********", 
            "ecVcdOrg": "**********", 
            "ecVcdPassword": "**********", 
            "metadata": {
                "path": "/accounts/**********"
            }, 
            "modified": 1436850272679, 
            "type": "account", 
            "uuid": "**********"
        }
    ]
}