Contract API

Overview

This API allows you to control NTT Com Services Business Process.

Resource URL

Please use global common domain, or the individual region domain.

If you want to use the global common domain, depending on the circumstances of your available points, your request connect to the nearest API gateway.1

1.Base Path(Global Load Balance)

https://api.ntt.com/v1/business-process/contracts

2.Base Path(Region)

https://{region}.api.ntt.com/v1/business-process/contracts
  • region is jp|us|uk
  • e.g. https://us.api.ntt.com/v1/business-process/contracts

Resource Information

Key Value
Response Format JSON
Authentication (OAuth) Yes
Bandwidth control#1 Yes
  • #1 implement appropriate flow restriction in the customer connection unit

GET Service Contract Info

GET /v1/business-process/contracts

Request Parameters

Name Description type mandatory
serviceName Service Name#1 query argument Yes
  • #1 uno,cloudn,bhec,ucaas,sip-trunking,bizmail,mss,gmone,050plusbiz,ip-voice,smart-pbx,accs,bdp-e

Example Request

 GET /v1/business-process/contracts?serviceName=uno

Response Parameters

Name Description type mandatory
accountId Account ID String
cRef Enterprise Cloud Internal Ditinguish ID String
contractId Service Contract ID String
distinguishName Service Distinguish Name String
internalContractId Internal Contract ID String
optionType Option Type String
serviceName Service Name String
serviceStatus Service Status 1:Normal 2:Not Available 3:Note 9:Not Watching Int
site Site String
vpnGroupId VPN Group ID String
resultCount Response Count Int

Example Result

{
"items": [
    {
        "accountId": null, 
        "cRef": null, 
        "contractId": "N*********", 
        "distinguishName": "【1G】大手町Aビル", 
        "internalContractId": null, 
        "optionType": null, 
        "serviceName": "L2 ギャランティアクセス イーサタイプ(NTT Com光アクセス利用) 1000BASE-SX", 
        "serviceStatus": 1, 
        "site": null, 
        "vpnGroupId": "V********"
    }, 
    {
        "accountId": null, 
        "cRef": null, 
        "contractId": "W*********", 
        "distinguishName": null, 
        "internalContractId": null, 
        "optionType": null, 
        "serviceName": "Constant Rate (Ethernet)", 
        "serviceStatus": 1, 
        "site": null, 
        "vpnGroupId": "V********"
    }
], 
"resultCount": 2
}

CREATE Service Contract

CloudnChannel Partner Limited[2014/12]

If it is interesting for Channel Partner, please contact us from below .

CloudnContact

POST /v1/business-process/contracts

Request Parameters

Name Description type mandatory
serviceName Service Name#1 query argument Yes
channelId Partner Channel ID#2 JSON Yes
loginId CloudnPortal Login ID JSON Yes
password CloudnPortal Password JSON Yes
email Mail Address JSON Yes
referredId Partner reffered ID JSON
  • #1 cloudn
  • #2 NTT Com will provide channelId to channel partner
  • Note: You should set Content-Type: application/json header

Example Request

 POST /v1/business-process/contracts?serviceName=cloudn
 {
   "channelId": "[CHANNEL_ID]", 
   "email": "comtaro01@example.com", 
   "loginId": "[USERID]", 
   "password": "[PASSWORD]", 
   "referredId": "[REFERREDID]"
 }

Response Parameters

Name Description type mandatory
CloudnAccountId CloudnAccount ID String Yes
ContractId Service Contract ID String Yes
StartTime Service ContractDate String Yes

Example Result

{
    "CreateContractResponse": {
        "CloudnAccountId": "cln*********", 
        "ContractId": "an1*********", 
        "StartTime": "2014-12-11 01:32:33"
    }
}

CANCEL Service Contract

CloudnChannel Partner Limited[2014/12]

If it is interesting for Channel Partner, please contact us from below .

CloudnContact

DELETE /v1/business-process/contracts/{contractId}

Request Parameters

Name Description type mandatory
serviceName Service Name#1 query argument Yes
contractId Service Contract ID Path Yes
  • #1 cloudn

Example Request

 DELETE /v1/business-process/contracts/an*********?serviceName=cloudn

Response Parmeters

Name Description type mandatory
ContractId Service Contract iD String Yes
MailAddress Registerd Mail Address String Yes
Result Result String Yes

Example Result

{
      "DeleteContractResponse": {
      "ContractId": "an*********", 
      "MailAddress": "[YOUR_MAIL_ADDRESS]", 
      "Result": "SUCCEEDED"
      }
    }

Contract Pause / Resume

CloudnChannel Partner Limited[2014/12]

If it is interesting for Channel Partner, please contact us from below .

CloudnContact

PUT /v1/business-process/contracts/{contractId}

Request Parameters

Name Description type mandatory
serviceName Service Name#1 query argument Yes
contractId Service Contract ID Path Yes
status Contract Status(disable/enable) JSON Yes
  • #1 cloudn
  • Note: You should set Content-Type: application/json header

Example Request

 PUT /v1/business-process/contracts/an*********?serviceName=cloudn
 {"status":"enable|disable"}

Response Parmeters

Name Description type mandatory
ContractId Service Contract ID String Yes
Result Result String Yes

Example Result

{
       "ManageContractResponse": {
         "ContractId": "an*********", 
         "Result": "SUCCEEDED"
    }
    }

  1. Dec. 2014 currently, DNS round robin operation. Apr. 2015 or later, API request will automatically connect to geographically close API gateway