契約情報 API

Overview

本APIは、NTT Com各種サービスの契約情報を管理するAPIです。

Resource URL

グローバル共通ドメインの利用、または個別リージョンドメインをご利用ください。

グローバル共通ドメインを利用する場合、お客様のご利用箇所の状況に応じて、
一番近いAPIゲートウェイに接続します。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
  • 指定できるregionは、将来拡充予定

Resource Information

Key Value
レスポンス フォーマット JSON
認証(OAuth) Yes
帯域制御#1 Yes
  • #1 お客さま接続単位で適切な流量制限を実施

契約情報参照

GET /v1/business-process/contracts

Request Parameters

Name Description type mandatory
serviceName サービス名称を指定#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 アカウントID String
cRef Enterprise Cloud内部識別ID String
contractId サービスの契約ID String
distinguishName サービス識別名 String
internalContractId 内部契約ID String
optionType オプションタイプ String
serviceName サービス名 String
serviceStatus サービステータス1:正常 2:異常 3:警告 9:非監視 Int
site サイト String
vpnGroupId VPNグループID String
resultCount レスポンス件数 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
}

新規契約

Cloudnパートナー契約企業ユーザ限定[2014/12現在]

Cloudnパートナー契約APIご希望の方は、以下からお問い合わせください。

Cloudnお問い合わせ

POST /v1/business-process/contracts

Request Parameters

Name Description type mandatory
serviceName サービス名称を指定#1 query argument Yes
channelId パートナー識別#2 JSON Yes
loginId CloudnポータルログインID JSON Yes
password Cloudnポータルパスワード JSON Yes
email メールアドレス JSON Yes
referredId パートナー様契約識別ID JSON
  • #1 cloudn
  • #2 NTT Comよりお客さまに別途払い出し
  • 指定できるサービスは、随時増加対応予定
  • JSONリクエストの場合、Content-Typeにapplication/jsonを指定

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 CloudnアカウントID String Yes
ContractId サービスの契約ID String Yes
StartTime 契約開始日時 String Yes

Example Result

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

解約

Cloudnパートナー契約企業ユーザ限定[2014/12現在]

Cloudnパートナー契約APIご希望の方は、以下からお問い合わせください。

Cloudnお問い合わせ

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

Request Parameters

Name Description type mandatory
serviceName サービス名称を指定#1 query argument Yes
contractId サービスの契約ID Path Yes
  • #1 cloudn
  • 指定できるサービスは、随時増加対応予定

Example Request

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

Response Parmeters

Name Description type mandatory
ContractId サービスの契約ID String Yes
MailAddress 登録していたメールアドレス String Yes
Result 結果。成功時は、SUCCEEDED String Yes

Example Result

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

契約一時停止/再開

Cloudnパートナー契約企業ユーザ限定[2014/12現在]

Cloudnパートナー契約APIご希望の方は、以下からお問い合わせください。

Cloudnお問い合わせ

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

Request Parameters

Name Description type mandatory
serviceName サービス名称を指定#1 query argument Yes
contractId サービスの契約ID Path Yes
status ステータス(一時停止:disable/再開:enable) JSON Yes
  • #1 cloudn
  • 指定できるサービスは、随時増加対応予定
  • JSONリクエストの場合、Content-Typeにapplication/jsonを指定

Example Request

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

Response Parmeters

Name Description type mandatory
ContractId サービスの契約ID String Yes
Result 結果。成功時は、SUCCEEDED String Yes

Example Result

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

  1. 2014/12現在、DNSラウンドロビン運用。準備出来次第、お客さまの地理的に近いAPIゲートウェイに自動接続予定です。別途アナウンスします。