Nexcenter API

Overview

本APIは、Nexcenter サービスにおいて、データセンタへ入館する情報をWeb Entry Support System API(WESS API)にて連携できるようにするAPIです。 WESS APIが網羅する範囲は、入館されるデータセンタ、日付、時間、作業ラックおよびビジター入館者を対象としています。
本APIは、お客様がWESSシステムのアカウントをお持ちで、また、お客様側で入館システム相当のシステムからのご利用を前提としております。詳細につきましては、弊社営業担当を通じてご連絡いただけますようお願いいたします。

Resource URL

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

グローバル共通ドメインを利用する場合、お客様のご利用箇所の状況に応じて、
一番近いAPIゲートウェイに接続します。1

1.Base Path(Global Load Balance)

https://api.ntt.com/v1/nexcenter

2.Base Path(Region)

https://{region}.api.ntt.com/v1/nexcenter
  • 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 お客さま接続単位で適切な流量制限を実施

WESS API

契約データセンタ情報参照

お客様が契約されているデータセンタ名をすべて習得できます。

GET /v1/nexcenter/data_centers

Request Parameters

ありません

Example Request

 GET /v1/nexcenter/data_centers

Response Parameters

習得情報の最初には、"responseObj" が付加されます

No Name Description type Size mandatory
1 dataCenterList Contract Data Center Array
1-1 buildName Building Name String 50 Yes
1-2 enterBuildId Building ID String 10 Yes

Example Result

GET /v1/nexcenter/data_centers

{"responseObj": 
[ 
{ "buildName": "東京1", 
"enterBuildId": "xxxxxxxxxx" }, 
{ "buildName": "東京2",
"enterBuildId": "xxxxxxxxxx" },
{ "buildName": "東京4",
"enterBuildId": "xxxxxxxxxx" }
]
}

契約ラック情報参照

お客様が契約されているラック名をすべて習得できます。

GET /v1/nexcenter/data_center/:data_center_id/racks

Request Parameters

No Name Description type Size mandatory
1 data_center_id Contract Data Center.
2.1 で習得したデータセンタID
String 10 Yes

Example Request

 GET /v1/nexcenter/data_center/xxxxxxxxxx/racks

Response Parameters

習得情報の最初には、"responseObj" が付加されます

No Name Description type Size mandatory Remark
1 契約ラック情報 Array
1-1 regId 契約ID String 10 Yes
1-2 contractEndDate 契約期間終了日 String 8 Yes Format:YYYYMMDD
1-3 contractStartDate 契約期間開始日 String 8 Yes Format:YYYYMMDD
1-4 floorCode 階数 Integer 3 Yes
1-5 floorName フロア名 String 2 Yes
1-6 roomNumber ルーム名 String 3 Yes
1-7 rackNumber ラック名 String 7 Yes

Example Result

GET /v1/nexcenter/data_center/GTlA2XtjP4/racks

{
"responseObj": [
    {
        "contractEndDate": "20991231",
        "contractStartDate": "20150708",
        "floorCode": 6,
        "floorName": "6",
        "rackNumber": "xxxxxx",
        "regId": "xxxxxxxxxx",
        "roomNumber": "xxx"
    }
]
} 

入館申請情報参照

お客様が申請した入館申請の情報を受付番号から習得できます。

GET /v1/nexcenter/entry_apply/:entry_number

Request Parameters

Name Description Type mandatory
Entry_number 入館申請番号 String Yes

Example Request

 GET /v1/nexcenter/entry_apply/:entry_number

Response Parameters

習得情報の最初には、"responseObj" が付加されます

No Name Description type Size mandatory Remark
1 entryNumber 入館申請番号 number 7 YES
2 entryStatus 入館申請ステータス number 2 YES 10:申請済
21:承認済
90:完了
91:取下
92:否認
99:期限切れ
3 enterPlanStartDate 入館予定開始日 number 8 YES YYYYMMDD形式
4 enterPlanEndDate 入館予定終了日 number 8 YES YYYYMMDD形式
5 enterPlanMon 入館予定曜日_月 number 1 YES 0:未選択、1:選択
6 enterPlanTue 入館予定曜日_火 number 1 YES 0:未選択、1:選択
7 enterPlanWed 入館予定曜日_水 number 1 YES 0:未選択、1:選択
8 enterPlanThu 入館予定曜日_木 number 1 YES 0:未選択、1:選択
9 enterPlanFri 入館予定曜日_金 number 1 YES 0:未選択、1:選択
10 enterPlanSat 入館予定曜日_土 number 1 YES 0:未選択、1:選択
11 enterPlanSun 入館予定曜日_日 number 1 YES 0:未選択、1:選択
12 workContentsGeneral 作業内容_一般作業 number 1 YES 0:未選択、1:選択
13 workContentsOther 作業内容_その他 String MAX255
14 applicantFirstName 申請者氏名_姓 String MAX14 YES
15 applicantLastName 申請者氏名_名 String MAX14 YES
16 applicantFirstNameKana 申請者氏名カナ_姓 String MAX19
17 applicantLastNameKana 申請者氏名カナ_名 String MAX19
18 applicantCompanyName 申請者会社名 String MAX255 YES
19 enterPlanUser 入館予定者情報 Array YES
19-1 visitorNumber 入館者番号 number MAX3 YES
19-2 visitorFirstName 入館者氏名_姓 String MAX14 YES
19-3 visitorLastName 入館者氏名_名 String MAX14 YES
19-4 visitorFirstNameKana 入館者氏名カナ_姓 String MAX19
19-5 visitorLastNameKana 入館者氏名カナ_名 String MAX19
19-6 visitorCompanyName 入館者会社名 String MAX255 YES
19-7 visitorDepartmentName 入館者部署名 String MAX120
19-8 visitorTelephoneNumber 入館者連絡先 Alphanumeric MAX50 YES
20 buildName ビル名 String MAX50 YES
21 enterPlanRack 入館予定ラック情報 Array YES
21-1 rackNumber ラック番号 Alphanumeric MAX7 YES

Example Result

GET /v1/nexcenter/entry_apply/3001234

{  
"responseObj": {
"applicantCompanyName": "NTTコミュニケーションズ株式会社",
"applicantFirstName": "電電”,
"applicantFirstNameKana": "デンデン",
"applicantLastName": "太郎",
"applicantLastNameKana": "タロウ",
"buildName": "東京1",
"enterPlanEndDate": "20150731",
"enterPlanFri": "0",
"enterPlanMon": "0",
"enterPlanRack": [
  {        "rackNumber": "xxxxxxD"      },
  {        "rackNumber": "xxxxxxA"      },
  {        "rackNumber": "xxxxxx"      },
  {        "rackNumber": "xxxxxxB"      },
  {        "rackNumber": "xxxxxxC"      },
  …
],
"enterPlanSat": "0",
"enterPlanStartDate": "20091029",
"enterPlanSun": "0",
"enterPlanThu": "0",
"enterPlanTue": "0",
"enterPlanUser": [
  {  "visitorCompanyName": "アカウント管理試験",
    "visitorDepartmentName": "CL",
    "visitorFirstName": "電電",
    "visitorFirstNameKana": "デンデン",
    "visitorLastName": "九",
    "visitorLastNameKana": "キュウ",
    "visitorNumber": 1,
    "visitorTelephoneNumber": "03-0000-0000"
  },
  {  "visitorCompanyName": "アカウント管理試験",
    "visitorDepartmentName": "CL",
    "visitorFirstName": "電電",
    "visitorFirstNameKana": "デンデン",
    "visitorLastName": "五",
    "visitorLastNameKana": "ゴ",
    "visitorNumber": 2,
    "visitorTelephoneNumber": "03-0000-0005"
  },
  …
],
"enterPlanWed": "0",
"entryNumber": "xxxxxxx",
"entryStatus": "21",
"workContentsGeneral": "1",
"workContentsOther": "word_cont_other"
}
}

入館申請情報検索参照

お客様が申請した入館申請情報をデータセンタと入館予定日から検索し習得できます。

GET /v1/nexcenter/entry_applies/search?buildId=xxxxxxx applyDate=yyyymmdd

Request Parameters

No Name Description type Size mandatory Remark
1 enterBuildId ビルID Alphanumeric 10 YES
2 applyDate 申請日 Number 6 YES Format:YYYYMMDD

Example Request

 GET /v1/nexcenter/entry_applies/search?enterBuildId=xxxxxxxxxx&applyDate=20150720

Response Parameters

習得情報の最初には、"responseObj" が付加されます

No Name Description type Size mandatory Remark
1 entryNumber 入館申請番号 number 7 YES
2 entryStatus 入館申請ステータス number 2 YES 10:申請済
21:承認済
90:完了
91:取下
92:否認
99:期限切れ
3 enterPlanStartDate 入館予定開始日 number 8 YES YYYYMMDD形式
4 enterPlanEndDate 入館予定終了日 number 8 YES YYYYMMDD形式
5 enterPlanMon 入館予定曜日_月 number 1 YES 0:未選択、1:選択
6 enterPlanTue 入館予定曜日_火 number 1 YES 0:未選択、1:選択
7 enterPlanWed 入館予定曜日_水 number 1 YES 0:未選択、1:選択
8 enterPlanThu 入館予定曜日_木 number 1 YES 0:未選択、1:選択
9 enterPlanFri 入館予定曜日_金 number 1 YES 0:未選択、1:選択
10 enterPlanSat 入館予定曜日_土 number 1 YES 0:未選択、1:選択
11 enterPlanSun 入館予定曜日_日 number 1 YES 0:未選択、1:選択
12 workContentsGeneral 作業内容_一般作業 number 1 YES 0:未選択、1:選択
13 workContentsOther 作業内容_その他 String MAX255
14 applicantFirstName 申請者氏名_姓 String MAX14 YES
15 applicantLastName 申請者氏名_名 String MAX14 YES
16 applicantFirstNameKana 申請者氏名カナ_姓 String MAX19
17 applicantLastNameKana 申請者氏名カナ_名 String MAX19
18 applicantCompanyName 申請者会社名 String MAX255 YES
19 enterPlanUser 入館予定者情報 Array YES
19-1 visitorNumber 入館者番号 number MAX3 YES
19-2 visitorFirstName 入館者氏名_姓 String MAX14 YES
19-3 visitorLastName 入館者氏名_名 String MAX14 YES
19-4 visitorFirstNameKana 入館者氏名カナ_姓 String MAX19
19-5 visitorLastNameKana 入館者氏名カナ_名 String MAX19
19-6 visitorCompanyName 入館者会社名 String MAX255 YES
19-7 visitorDepartmentName 入館者部署名 String MAX120
19-8 visitorTelephoneNumber 入館者連絡先 Alphanumeric MAX50 YES
20 buildName ビル名 String MAX50 YES
21 enterPlanRack 入館予定ラック情報 Array YES
21-1 rackNumber ラック番号 Alphanumeric MAX7 YES

Example Result

 GET /v1/nexcenter/entry_applies/search?enterBuildId=xxxxxxxxxx&applyDate=20150720

{  
"responseObj": {
"applicantCompanyName": "NTTコミュニケーションズ株式会社",
"applicantFirstName": "電電”,
"applicantFirstNameKana": "デンデン",
"applicantLastName": "太郎",
"applicantLastNameKana": "タロウ",
"buildName": "埼玉第1",
"enterPlanEndDate": "20150731",
"enterPlanFri": "0",
"enterPlanMon": "0",
"enterPlanRack": [
  {        "rackNumber": "xxxxxxD"      },
  {        "rackNumber": "xxxxxxA"      },
  {        "rackNumber": "xxxxxx"      },
  {        "rackNumber": "xxxxxxB"      },
  {        "rackNumber": "xxxxxxC"      },
  …
],
"enterPlanSat": "0",
"enterPlanStartDate": "20150720",
"enterPlanSun": "0",
"enterPlanThu": "0",
"enterPlanTue": "0",
"enterPlanUser": [
  {  "visitorCompanyName": "アカウント管理試験",
    "visitorDepartmentName": "CL",
    "visitorFirstName": "電電",
    "visitorFirstNameKana": "デンデン",
    "visitorLastName": "九",
    "visitorLastNameKana": "キュウ",
    "visitorNumber": 1,
    "visitorTelephoneNumber": "03-0000-0000"
  },
  {  "visitorCompanyName": "アカウント管理試験",
    "visitorDepartmentName": "CL",
    "visitorFirstName": "電電",
    "visitorFirstNameKana": "デンデン",
    "visitorLastName": "五",
    "visitorLastNameKana": "ゴ",
    "visitorNumber": 2,
    "visitorTelephoneNumber": "03-0000-0005"
  },
  …
],
"enterPlanWed": "0",
"entryNumber": "xxxxxxx",
"entryStatus": "21",
"workContentsGeneral": "1",
"workContentsOther": "word_cont_other"
}
}

入館申請登録

お客様が入館するデータセンタへの入館申請を申請することができます。

POST /v1/nexcenter/entry_apply

Request Parameters

No Name Description type Size mandatory Remark
1 入館予定開始日 enterPlanStartDate number 8 Yes YYYYMMDD形式
2 入館予定終了日 enterPlanEndDate number 8 Yes YYYYMMDD形式
3 入館予定曜日_月 enterPlanMon number 1 Yes 0:未選択、1:選択
4 入館予定曜日_火 enterPlanTue number 1 Yes 0:未選択、1:選択
5 入館予定曜日_水 enterPlanWed number 1 Yes 0:未選択、1:選択
6 入館予定曜日_木 enterPlanThu number 1 Yes 0:未選択、1:選択
7 入館予定曜日_金 enterPlanFri number 1 Yes 0:未選択、1:選択
8 入館予定曜日_土 enterPlanSat number 1 Yes 0:未選択、1:選択
9 入館予定曜日_日 enterPlanSun number 1 Yes 0:未選択、1:選択
10 作業内容_一般作業 workContentsGeneral number 1 Yes 0:未選択、1:選択
11 作業内容_その他 workContentsOther String MAX255 ※作業内容_一般作業が0の場合必須
12 申請者氏名_姓 applicantFirstName String MAX14 Yes
13 申請者氏名_名 applicantLastName String MAX14 Yes
14 申請者氏名カナ_姓 applicantFirstNameKana String MAX19 全角カタカナ、全半角英numberのいずれかを設定
15 申請者氏名カナ_名 applicantLastNameKana String MAX19 全角カタカナ、全半角英numberのいずれかを設定
16 申請者会社名 applicantCompanyName String MAX255 Yes
17 入館予定者情報 enterPlanUser Array Yes
17-1 入館者氏名_姓 visitorFirstName String MAX14 Yes
17-2 入館者氏名_名 visitorLastName String MAX14 Yes
17-3 入館者氏名カナ_姓 visitorFirstNameKana String MAX19 全角カタカナ、全半角英numberのいずれかを設定
17-4 入館者氏名カナ_名 visitorLastNameKana String MAX19 全角カタカナ、全半角英numberのいずれかを設定
17-5 入館者会社名 visitorCompanyName String MAX255 Yes
17-6 入館者連絡先 visitorTelephoneNumber Alphanumeric MAX50 Yes
18 入館ビルID enterBuildId Alphanumeric 10 Yes
19 ラック情報 rackInfo Array Yes
19-1 フロアコード floorCode number MAX3 Yes
19-2 ルーム番号 roomNumber Alphanumeric 3 Yes
19-3 ラック番号 rackNumber Alphanumeric MAX7 Yes

Example Request

 POST /v1/nexcenter/entry_apply

{   "enterPlanStartDate":"20150716",
 "enterPlanEndDate": "20150716", 
 "enterPlanMon": "0",
 "enterPlanTue": "0",
 "enterPlanWed": "0",
 "enterPlanThu": "0",
 "enterPlanFri": "0", 
 "enterPlanSat": "0",
 "enterPlanSun": "0",
 "workContentsGeneral": "1",
 "workContentsOther": "1",
 "applicantFirstName": "電電",
 "applicantLastName": "守",
 "applicantFirstNameKana": "デンデン",
 "applicantLastNameKana": "マモル",
 "applicantCompanyName": "NTTコミュニケーションズ",
 "enterPlanUser": [ 
 {   "visitorFirstName": "電電", 
    "visitorLastName": "一", 
    "visitorFirstNameKana": "電電", 
    "visitorLastNameKana": "ハジメ",
    "visitorCompanyName": "入館株式会社", 
    "visitorTelephoneNumber": "03-0000-0001" }
 ],
 "enterBuildId": "xxxxxxxxxx", 
 "rackInfo": [
    {"floorCode": "x", "roomNumber":"xxx", "rackNumber":"xxxxxx"}
]
}

Response Parameters

入館申請番号の前に、"responseObj"が付加されます。

No Name Description type Size mandatory
1 入館申請番号 entryNumber number 7 Yes

Example Result

{"responseObj": "xxxxxxx" }

入館申請変更

お客様が入館するデータセンタへの入館申請の変更ができます。

PUT /v1/nexcenter/entry_apply/:entry_number

Request Parameters

No Name Description type Size mandatory Remark
1 入館申請番号 entry_number numeric 7 Yes URLに設定
2 入館予定開始日 enterPlanStartDate numeric 8 Yes YYYYMMDD形式
3 入館予定終了日 enterPlanEndDate numeric 8 Yes YYYYMMDD形式
4 入館予定曜日_月 enterPlanMon numeric 1 Yes 0:未選択、1:選択
5 入館予定曜日_火 enterPlanTue numeric 1 Yes 0:未選択、1:選択
6 入館予定曜日_水 enterPlanWed numeric 1 Yes 0:未選択、1:選択
7 入館予定曜日_木 enterPlanThu numeric 1 Yes 0:未選択、1:選択
8 入館予定曜日_金 enterPlanFri numeric 1 Yes 0:未選択、1:選択
9 入館予定曜日_土 enterPlanSat numeric 1 Yes 0:未選択、1:選択
10 入館予定曜日_日 enterPlanSun numeric 1 Yes 0:未選択、1:選択
11 作業内容_一般作業 workContentsGeneral numeric 1 Yes 0:未選択、1:選択
12 作業内容_その他 workContentsOther String MAX255 ※作業内容_一般作業が0の場合必須
13 申請者氏名_姓 applicantFirstName String MAX14 Yes
14 申請者氏名_名 applicantLastName String MAX14 Yes
15 申請者氏名カナ_姓 applicantFirstNameKana String MAX19 全角カタカナ、全半角Alphanumericのいずれかを設定
16 申請者氏名カナ_名 applicantLastNameKana String MAX19 全角カタカナ、全半角Alphanumericのいずれかを設定
17 申請者会社名 applicantCompanyName String MAX255 Yes
18 入館予定者情報 enterPlanUser 配列 Yes
18-1 入館者氏名_姓 visitorFirstName String MAX14 Yes
18-2 入館者氏名_名 visitorLastName String MAX14 Yes
18-3 入館者氏名カナ_姓 visitorFirstNameKana String MAX19 全角カタカナ、全半角Alphanumericのいずれかを設定
18-4 入館者氏名カナ_名 visitorLastNameKana String MAX19 全角カタカナ、全半角Alphanumericのいずれかを設定
18-5 入館者会社名 visitorCompanyName String MAX255 Yes
18-6 入館者連絡先 visitorTelephoneNumber Alphanumeric MAX50 Yes
19 入館ビルID enterBuildId Alphanumeric 10 Yes
20 ラック情報 rackInfo 配列
20-1 フロアコード floorCode numeric MAX3 Yes
20-2 ルーム番号 roomNumber Alphanumeric 3 Yes
20-3 ラック番号 rackNumber Alphanumeric MAX7 Yes

Example Request

 PUT /v1/nexcenter/entry_apply/xxxxxxx

{   "enterPlanStartDate":"20150716",
 "enterPlanEndDate": "20150716", 
 "enterPlanMon": "0",
 "enterPlanTue": "0",
 "enterPlanWed": "0",
 "enterPlanThu": "0",
 "enterPlanFri": "0", 
 "enterPlanSat": "0",
 "enterPlanSun": "0",
 "workContentsGeneral": "1",
 "workContentsOther": "1",
 "applicantFirstName": "電電",
 "applicantLastName": "守",
 "applicantFirstNameKana": "デンデン",
 "applicantLastNameKana": "マモル",
 "applicantCompanyName": "NTTコミュニケーションズ",
 "enterPlanUser": [ 
 {   "visitorFirstName": "電電", 
    "visitorLastName": "一", 
    "visitorFirstNameKana": "電電", 
    "visitorLastNameKana": "ハジメ",
    "visitorCompanyName": "入館株式会社", 
    "visitorTelephoneNumber": "03-0000-0001" }
 ],
 "enterBuildId": "xxxxxxxxxx", 
 "rackInfo": [
    {"floorCode": "x", "roomNumber":"xxx", "rackNumber":"xxxxxx"}
]
}

Response Parameters

入館申請番号の前に、"responseObj"が付加されます。

No Name Description type Size mandatory
1 入館申請番号 entryNumber 数字 7 Yes

Example Result

PUT /v1/nexcenter/entry_apply/xxxxxxx

{"responseObj": "xxxxxxx" }

入館申請取下

お客様が入館するデータセンタへの入館申請の取下ができます。

DELETE /v1/nexcenter/entry_apply/:entry_numb

Request Parameters

No Name Description type Size mandatory Remark
1 入館申請番号 entry_number number 7 Yes URLに設定

Example Request

 DELETE /v1/nexcenter/entry_apply/xxxxxxx

Response Parameters

入館申請番号の前に、"responseObj"が付加されます。

No Name Description type Size mandatory
1 入館申請番号 entryNumber 数字 7 Yes

Example Result

DELETE /v1/nexcenter/entry_apply/xxxxxxx

{"responseObj": "xxxxxxx" }


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