1 はじめに
2 API仕様
2.1 API一覧
2.2 共通仕様
2.2.1 プロトコル
2.2.2 暗号化
2.2.3 APIリクエスト
2.2.4 APIレスポンス
2.3 認証API
2.3.1 URI
2.3.2 HTTPメソッド
2.3.3 リクエストパラメータ
2.3.4 リクエストサンプル
2.3.5 レスポンスパラメータ
2.3.6 レスポンスサンプル
2.3.7 アクセストークンについて
2.4 契約者別商品リスト取得API
2.4.1 URI
2.4.2 HTTPメソッド
2.4.3 クエリパラメータ
2.4.4 レスポンスパラメータ
2.4.5 レスポンスサンプル
2.5 オーダ登録API
2.5.1 URI
2.5.2 HTTPメソッド
2.5.3 ヘッダ
2.5.4 リクエストパラメータ
2.5.5 リクエストサンプル
2.5.6 レスポンスパラメータ
2.5.7 レスポンスサンプル
2.6 オーダ一覧取得API
2.6.1 URI
2.6.2 HTTPメソッド
2.6.3 クエリパラメータ
2.6.4 レスポンスパラメータ
2.6.5 レスポンスサンプル
2.7 オーダ詳細取得API
2.7.1 URI
2.7.2 HTTPメソッド
2.7.3 レスポンスパラメータ
2.7.4 レスポンスサンプル
2.8 拠点一覧取得API
2.8.1 URI
2.8.2 HTTPメソッド
2.8.3 クエリパラメータ
2.8.4 レスポンスパラメータ
2.8.5 レスポンスサンプル
2.9 拠点詳細取得API
2.9.1 URI
2.9.2 HTTPメソッド
2.9.3 レスポンスパラメータ
2.9.4 レスポンスサンプル
3 API利用のユースケース
3.1 認証から各種APIを利用するまでの流れ
3.2 APIによるIPoEインターネットサービス申込の流れ
3.3 APIによる拠点情報取得からCPE設定までの流れ
1.はじめに
本資料は、株式会社エヌ・ティ・ティ ピー・シーコミュニケーションズ(以下、NTTPC)が提供するIPoEインターネットサービスのカスタマコントロールのAPI仕様書です。
今後、本資料は予告なく変更される可能性があります。
2.API仕様
2.1API一覧
IPoEインターネットサービスでは、以下のAPIを提供いたします。
#
|
API種別
|
利用用途
|
---|---|---|
1 | 認証API |
APIを利用するための認証を行う。 |
2 |
契約者別商品リスト取得API |
お客様が購入することができる商品リストを取得する。 |
3 | オーダ登録API |
IPoEインターネットサービスを利用するための新規オーダ登録、および利用終了するための廃止オーダ登録を実施する。 廃止オーダが進捗しIPoEインターネットサービスが利用終了になった時点で拠点が廃止される。 |
4 | オーダ一覧取得API | お客様が登録したオーダの一覧を取得する。 |
5 | オーダ詳細取得API | お客様が登録したオーダの詳細を取得する。 |
6 | 拠点一覧取得API | お客様が利用している拠点の一覧を取得する。 |
7 | 拠点詳細取得API | お客様が利用している拠点の詳細情報を取得する。 |
2.2.共通仕様
2.2.1.プロトコル
HTTP/1.1
2.2.2.暗号化
セキュリティの観点から、SSLによる暗号化を必須とする。
2.2.3.APIリクエスト
リクエストボディのデータ形式はJSONとする。
2.2.4.APIレスポンス
IPoEインターネットサービスで提供するAPIでは、すべてにリクエストに対して以下のHTTPステータスコードを返します。
コード
|
テキスト
|
説明
|
---|---|---|
200 |
OK | リクエストが成功した場合のデフォルトレスポンス |
201 | Created | リクエストが成功しリソースが作成された場合 |
400 | Bad Request | クライアント側に何らかのエラーがある場合のデフォルトレスポンス |
401 | Unauthorized | クライアント側での認証エラーがあった場合 |
404 | Not Found | 指定したURI にリソースが存在しない場合 |
500 | Internal Server Error | メンテナンス等サーバ側エラーがある場合のデフォルトレスポンス |
また、上記のAPIにてHTTPステータスが400番台の場合、以下の形式でエラーメッセージを返します。
項目 | 型 | 説明 | |
---|---|---|---|
errors | オブジェクト配列 | ||
errorCode | string | エラー詳細コード。 | |
errorMessage | string | 利用者向けのエラーメッセージ。 | |
developerMessage | string | 開発者向けのエラーメッセージ。現在はerrorMessageと同じ文字が返る。 | |
moreInfo | string | さらなる情報が記載されたドキュメントページのURI。現在はnullが返る。 | |
requesstId | string | 当該レスポンスに対応するリクエストのID。主に問い合わせで利用する。現在はnullが返る。 |
エラーメッセージの例を以下に示します。
例えば、バリデーションエラーが複数発生した場合、エラーメッセージが複数返ることがあります。
HTTP/1.1 400 Bad Request
{
"errors": [
{
"errorCode": "4000101",
"errorMessage": "パラメータチェックエラーです。[1行目]お客様種別は必須入力です。姓は必須入力です。",
"developerMessage": "パラメータチェックエラーです。[1行目]お客様種別は必須入力です。姓は必須入力です。",
"moreInfo": null,
"requestId": "odm27k8mdqte3"
},
{
"errorCode": "4000101",
"errorMessage": "パラメータチェックエラーです。[2行目]姓は全角で入力してください。",
"developerMessage":"パラメータチェックエラーです。[2行目]姓は全角で入力してください。",
"moreInfo": null,
"requestId": "odm27k8mdqte3"
}
]
}
2.3.認証API
2.3.1.URI
https://api.customer.jp/oauth/v1/accesstokens
2.3.2.HTTPメソッド
POST
2.3.3.リクエストパラメータ
項目
|
型
|
必須
|
説明
|
---|---|---|---|
grantType | string | 〇 | client_credentialsを指定する。 |
clientId | string | 〇 | IPoEインターネットサービスのAPI利用申請申込時にNTTPCから提供されるクライアントIDを指定する。 |
clientSecret | string | 〇 | IPoEインターネットサービスのAPI利用申請申込時にNTTPCから提供されるパスワードを指定する。 |
2.3.4.リクエストサンプル
{
"grantType": "client_credentials",
"clientId": "**********",
"clientSecret": "**********"
}
2.3.5.レスポンスパラメータ
項目
|
型
|
説明
|
---|---|---|
accessToken | string | アクセストークン。このアクセストークンを用いて他のAPIを利用する。 |
tokenType | string | トークン種別。BearerTokenが固定で返る。 |
expiresIn | string | アクセストークンの有効期限。単位はsec。現在、3599 secが指定されている。 |
scope | string | アクセストークンスコープ。現在は空文字が指定されている。 |
issuedAt | string | アクセストークンの発行日時。 |
2.3.6.レスポンスサンプル
正常終了
HTTP/1.1 201 OK
{
"accessToken": "YOUR_ACCESS_TOKEN",
"tokenType": "BearerToken",
"expiresIn": "3599",
"scope": "",
"issuedAt": "1559289842141"
}
異常終了(クライアントIDとパスワードの不一致)
HTTP/1.1 401 Unauthorized
{
"errorCode": "401",
"errorMessage": "{"ErrorCode" : "invalid_client", "Error" :"ClientId is Invalid"}",
"developerMessage": "Authentication failed. Please check your clientId and clientSecret.",
"moreInfo": null,
"requestId": "apigwnode03-52047-8823559-84"
}
2.3.7.アクセストークンについて
- アクセストークンの追加発行
APIクライアントが複数ある場合など、アクセストークンを複数発行することが可能です。複数のアクセストークンを発行した場合においても、発行済みのアクセストークンは失効しません。 - アクセストークンの再発行
アクセストークンが失効した場合、再度、認証APIによりアクセストークンを入手してください。 - アクセストークンの利用
他のAPIを実行する場合、認証APIにて取得したアクセストークンをAuthorizationヘッダフィールドに設定し、APIリクエストを実行してください。
Authorization: Bearer YOUR_ACCESS_TOKEN - アクセストークンの有効期限
認証APIにて発行されるアクセストークンの有効期限は3600秒です。アクセストークンは有効期限内でのみ有効となり、有効期限を超過したアクセストークンは利用できません。有効期限切れのアクセストークンを用いたAPIリクエストに対して、APIはHTTPステータスコード「401 Unauthorized」を返答します。また、将来的に有効期限は変更される可能性がございます。
2.4.契約者別商品リスト取得API
2.4.1.URI
https://api.customer.jp/infoIpoe/v1/customerProducts
2.4.2.HTTPメソッド
GET
2.4.3.クエリパラメータ
項目
|
型
|
説明
|
---|---|---|
productName | string型 | 商品名。部分一致による検索を行う。 |
limit | integer型 | 取得件数。4桁以内の整数を入力する。で例えば、"500"を指定した場合、500件分の拠点情報が返ってくる。 |
offset | integer型 | 取得開始番号。4桁以内の整数を入力する。例えば、"11"を指定した場合、先頭から11件目以降の拠点情報が返ってくる。 |
2.4.4.レスポンスパラメータ
項目 | 型 | 説明 | ||
---|---|---|---|---|
customerProduct | オブジェクト配列 | |||
customerProductId | integer型 | 契約者別商品ID。 | ||
customerCode | string型 | システムID。 | ||
productCode | string型 | 商品コード。商品を一意に決定するコード。 | ||
productName | string型 | 商品名。 | ||
productType | string型 | 商品種別。現状、「1:主商品」「2:オンサイト保守オプション」のいずれかの値が入る。 | ||
detail | オブジェクト | 商品の概要 | ||
service | string型 | サービス区分。主商品の場合、「1:IPoEインターネットサービス」が入る。オプションの場合、nullが入る。 | ||
course | string型 | コース区分。主商品の場合、「1:固定IPコース」「2:動的IPコース」が入る。オプションの場合、nullが入る。 | ||
plan | string型 |
プラン区分。 主商品で固定IPコースの場合、「1:Eプラン」「2:Sプラン」「3:Pプラン」のいずれかの値が入る。 オプションの場合、nullが入る。 |
||
ipaddress | string型 |
IPアドレス区分。 主商品で固定IPコースの場合、現状、「2:IP4タイプ」「5:IP1タイプ」のいずれかの値が入る。 オプションの場合、nullが入る。 |
||
cpe | string型 |
CPE区分。主商品の場合、「1:専用CPE付き」「2:パートナーCPE」のいずれかの値が入る。オプションの場合、nullが入る。 |
||
line | string型 | 回線区分。主商品の場合、現状、「1:回線アンバンドル」が入る。オプションの場合、nullが入る。 | ||
shortestPeriod | string型 | 最低利用期間。商品に対して利用しなければならない期間を表す。この期間を割って解約した場合、違約金が発生する。 | ||
purchasePrice | string型 | 初期費用。この商品を購入する場合の初期費用が返る。 | ||
monthlyPrice | string型 | 月額費用。この商品を購入する場合の月額費用が返る。 | ||
measurePrice | string型 | 従量費用。現在はnullが入る。 | ||
productDependencies | オブジェクト配列 | 商品の依存関係。現状、商品種別が「2:オンサイト保守オプション」の場合のみ値が入る。 オーダする商品に依存関係がある場合、依存先の商品をオーダしなければ、その商品をオーダすることはできない。 |
||
productCode | string型 | 依存する主商品の商品コードが入る。 |
- 主商品には、service:サービス区分、course:コース区分、plan:プラン(帯域)区分、ipaddress:IPアドレス区分、cpe:CPE区分、line:回線区分がある。この各要素の組み合わせにより、主商品が決定される。
- オプションには、上記の概念がない。そのため、各要素に該当するパラメータにはnullが設定されている。
- オプションを購入する場合には、productCode:商品コードを用いる。
2.4.5.レスポンスサンプル
正常終了
HTTP/1.1 200 OK
{
"customerProduct": [
{
"customerProductId": 1,
"customerCode": "A10000101",
"productCode": "1-1-5-1-1",
"productName": "IPoEインターネットサービス 法人コース エントリー(E)プラン IP1タイプ パートナーCPE(Ⅰ型)",
"productType": 1,
"detail" : {
"service":"1",
"course": "1",
"plan": "1",
"ipaddress": "1",
"cpe": "1",
"line": "1",
},
"shortestPeriod": 12,
"purchasePrice": 7000,
"monthlyPrice": 1900,
"measuredPrice": null,
"productDependencies": []
},
{
"customerProductId": 2,
"customerCode": "A10000101",
"productCode": "0-1-1-3-1",
"productName": "専用CPE平日オンサイト保守オプション",
"productType": 2,
"detail" : {
"service":null,
"course": null,
"plan": null,
"ipaddress": null,
"cpe": null,
"line": null,
},
"shortestPeriod": 0,
"purchasePrice": 0,
"monthlyPrice": 500,
"measuredPrice": null,
"productDependencies": [
{
"productCode": "1-1-1-1-1"
}
]
}
]
}
異常終了(limitのバリデーションエラー)
HTTP/1.1 400 Bad Request
{
"errors": [
{
"errorCode": "4000102",
"errorMessage": "取得件数は0~4文字の間で入力してください。",
"developerMessage": "取得件数は0~4文字の間で入力してください。",
"moreInfo": null,
"requestId": "apigwnode03-52045-8824087-59"
}
]
}
2.5.オーダ登録API
2.5.1.URI
https://api.customer.jp/infoIpoe/v1/orders
2.5.2.HTTPメソッド
POST
2.5.3.ヘッダ
以下のヘッダを付与してリクエストを送信してください。
Content-Type: application/json; charset=utf-8
2.5.4.リクエストパラメータ
項目 | 必須 〇:必須 △:条件付き必須 |
型 | バリデーション | 説明 | ||
---|---|---|---|---|---|---|
orderType | 〇 | string型 | 数字 2桁以下 |
オーダ種別。現在は「1:新規登録」、「3:廃止登録」が |
||
startOrderPostData | △(オーダ種別が1の場合に必須) | オブジェクト | ||||
customerSiteName | string型 | 半角英数字、全角文字 64文字以下 |
拠点名。拠点を識別するための名称を設定する。 | |||
caseName | string型 | 半角英数字、全角文字 64文字以下 |
案件名。拠点をグルーピングする際に使用する。 拠点検索の際に案件名で検索することが可能である。 |
|||
lineId | 〇 | string型 | 半角英数字 11桁から16桁まで |
回線ID。 NTT東日本が提供する「フレッツ」の『開通のご案内』に記載されている「お客さまID」、もしくはNTT西日本が提供する「フレッツ」の『お申し込み内容のご案内』に記載されている「お客さまID」、もしくは光コラボレーション事業者が提供する光コラボレーション回線の回線を識別するIDである。 お客様が用意した回線の回線IDを設定する。 |
||
lineAccessKey | 〇 | string型 | 半角英数字 8桁 |
アクセスキー。 NTT東日本が提供する「フレッツ」の『開通のご案内』に記載されている「アクセスキー」、もしくはNTT西日本が提供する「フレッツ」の『お申し込み内容のご案内』に記載されている「アクセスキー(アクセスパスワード)」、もしくは光コラボレーション事業者が提供する光コラボレーション回線の「アクセスキー」に相当する文字列。 上記、回線IDに紐づくアクセスキーを設定する。 |
||
hopeToOpenAt | △(productオブジェクトのcpeが「1:専用CPE付き」の場合に必須) | string型 |
YYYYMMDD 申込日から16日以降 |
開通希望日。 拠点を開通させたい日付を表す。 |
||
products | 〇 | オブジェクト | ||||
productCode | 〇 | string型 |
半角英数字記号 256桁以下 |
商品コード。 購入したい商品コードを指定することにより、商品を購入することができる。 |
||
installationLocation | △(productオブジェクトのcpeが「1:専用CPE付き」の場合に必須) | オブジェクト | CPEの設置場所に関する情報を示すオブジェクト。 以下のオブジェクト配下の各項目にはCPEの設置場所を設定する。 |
|||
zipCode | 〇 | string型 |
半角数字 7桁 |
郵便番号。 | ||
prefectures | 〇 | string型 | 全角文字 3文字以上、4文字以下 |
都道府県。 | ||
address | 〇 | string型 | 半角英数字、全角文字、ハイフン 100文字以下 |
住所。 | ||
companyName | 〇 | string型 | 半角英数字、全角文字、ハイフン 64文字以下 |
会社名。 | ||
departmentName | string型 | 半角英数字、全角文字、ハイフン 64文字以下 |
部署名。 | |||
clientName | 〇 | string型 | 半角英数字、全角文字 20文字以下 |
現地担当者。 | ||
tel | 〇 | string型 | 半角数字 10桁から11桁まで |
電話番号。 | ||
terminalDestination | △(productオブジェクトのcpeが「1:専用CPE付き」の場合に必須) | オブジェクト | CPEの端末送付先に関する情報を示すオブジェクト。 以下のオブジェクト配下の各項目にはCPEの端末送付先を設定する。 |
|||
zipCode | 〇 | string型 |
半角数字 7桁 |
郵便番号。 | ||
prefectures | 〇 | string型 | 全角文字 3文字以上、4文字以下 |
都道府県。 | ||
address | 〇 | string型 | 半角英数字、全角文字、ハイフン 100文字以下 |
住所。 | ||
companyName | 〇 | string型 | 半角英数字、全角文字、ハイフン 64文字以下 |
会社名。 | ||
departmentName | string型 | 半角英数字、全角文字、ハイフン 64文字以下 |
部署名。 | |||
clientName | 〇 | string型 | 半角英数字、全角文字 20文字以下 |
現地担当者。 | ||
tel | 〇 | string型 | 半角数字 10桁から11桁まで |
電話番号。 | ||
hopeToAt | 〇 | string型 |
YYYYMMDD 申込日から15日以降 開通希望日-1日以前 |
到着希望日。 | ||
lanAddress | △(productオブジェクトのcpeが「1:専用CPE付き」、かつ、productオブジェクトのipaddressが「2:IP4タイプ」以外の場合に必須) | オブジェクト | LAN側IPアドレスに関する情報を示すオブジェクト。 | |||
lanNetworkAddress | 〇 | string型 |
半角数字、ピリオド( . )、スラッシュ( / ) 9桁から18桁まで |
LAN側ネットワークアドレス。 | ||
lanInterfaceAddress | 〇 | string型 |
半角数字、ピリオド( . ) 7桁から15桁まで |
LAN側インタフェースアドレス。 | ||
dhcpServerFunction | △(productオブジェクトのcpeが「1:専用CPE付き」の場合に必須) | オブジェクト | DHCPサーバ機能に関する情報を示すオブジェクト。 | |||
howToUse | 〇 | integer型 | 使用方法(0:なし, 1:Server) DHCPサーバ機能を利用する場合には、1を設定する。 |
|||
startAddress | △(howToUseが1の場合に必須) | string型 |
半角数字、ピリオド( . ) 7桁から15桁まで |
開始アドレス。 | ||
endAddress | △(howToUseが1の場合に必須) | string型 |
半角数字、ピリオド( . ) 7桁から15桁まで |
終了アドレス。 | ||
dns1 | string型 |
半角数字、ピリオド( . ) 7桁から15桁まで |
DNS1。 指定がない場合、NTTPCが用意するDNSサーバのIPアドレスが自動的に設定される。 |
|||
dns2 | string型 |
半角数字、ピリオド( . ) 7桁から15桁まで |
DNS2。 指定がない場合、NTTPCが用意するDNSサーバのIPアドレスが自動的に設定される。 |
|||
cancelOrderPostData | △(オーダ種別が3の場合に必須) | オブジェクト | ||||
customerSiteCode | ◯ | string型 |
半角英数記号 256桁まで |
保守番号。保守番号は拠点を一意に識別する番号である。 | ||
hopeToEndAt | ◯ | string型 |
YYYYMM 指定した月の末日が、現在日翌日から現在日の60日後までの範囲であること
例: 現在日時 2020/01/30 hopeToEndAt 2020/01 →OK(指定した月の末日2020/01/31が現在日翌日2020/01/31から現在日の60日後2020/03/30の範囲内であるため) hopeToEndAt 2020/03 →NG(指定した月の末日2020/03/31が現在日翌日2020/01/31から現在日の60日後2020/03/30の範囲外であるため)
現在日時 2020/01/31 hopeToEndAt 2020/01 →NG(指定した月の末日2020/01/31が現在日翌日2020/02/01から現在日の60日後2020/03/30の範囲外であるため) hopeToEndAt 2020/03 →OK(指定した月の末日2020/03/31が現在日翌日2020/01/31から現在日の60日後2020/03/31の範囲内であるため) |
廃止希望年月。指定した月の末日が廃止日時となる。 |
2.5.5.リクエストサンプル
CPE区分が「パートナーCPE」の主商品を購入する場合
{
"orderType": "1",
"startOrderPostData": {
"customerSiteName": "東京拠点",
"customerCode": "A10000105",
"caseName": "鈴木商店",
"lineId": "CAF1234567890",
"lineAccessKey": "a1b2c3d4",
"products": [
{
"productCode": "1-1-1-1-1"
}
]
}
CPE区分が「専用CPE付き」、IPアドレス区分が「IP1タイプ」の主商品を、オンサイト保守オプションなし、DHCPサーバ機能なしにて購入する場合
{
"orderType": "1",
"startOrderPostData": {
"customerSiteName": "東京拠点",
"customerCode": "A10000105",
"caseName": "鈴木商店",
"lineId": "CAF1234567890",
"lineAccessKey": "a1b2c3d4",
"hopeToOpenAt": "20190704",
"products": [
{
"productCode": "1-1-5-1-1"
}
],
"installationLocation": {
"zipCode": "1050003",
"prefectures": "東京都",
"address": "港区西新橋2−14−1",
"companyName": "株式会社NTTPCコミュニケーションズ",
"departmentName": "テクノロジー&オペレーション開発本部",
"clientName": "山田太郎",
"tel": "05033881648"
},
"terminalDestination": {
"zipCode": "1050003",
"prefectures": "東京都",
"address": "港区西新橋2−14−1",
"companyName": "株式会社NTTPCコミュニケーションズ",
"departmentName": "テクノロジー&オペレーション開発本部",
"clientName": "山田太郎",
"tel": "05033881648",
"hopeToAt": "20190703"
},
"dhcpServerFunction": {
"howToUse": 0
}
}
}
CPE区分が「専用CPE付き」、IPアドレス区分が「IP1タイプ」の主商品を、オンサイト保守オプションあり、DHCPサーバ機能ありにて購入する場合
{
"orderType": "1",
"startOrderPostData": {
"customerSiteName": "東京拠点",
"customerCode": "A10000105",
"caseName": "鈴木商店",
"lineId": "CAF1234567890",
"lineAccessKey": "a1b2c3d4",
"hopeToOpenAt": "20190704",
"products": [
{
"productCode": "1-1-5-1-1"
},
{
"productCode": "0-1-1-3-1"
}
],
"installationLocation": {
"zipCode": "1050003",
"prefectures": "東京都",
"address": "港区西新橋2−14−1",
"companyName": "株式会社NTTPCコミュニケーションズ",
"departmentName": "テクノロジー&オペレーション開発本部",
"clientName": "山田太郎",
"tel": "05033881648"
},
"terminalDestination": {
"zipCode": "1050003",
"prefectures": "東京都",
"address": "港区西新橋2−14−1",
"companyName": "株式会社NTTPCコミュニケーションズ",
"departmentName": "テクノロジー&オペレーション開発本部",
"clientName": "山田太郎",
"tel": "05033881648",
"hopeToAt": "20190703"
},
"lanAddress": {
"lanNetworkAddress": "123.123.123.123/32",
"lanInterfaceAddress": "123.123.123.123"
},
"dhcpServerFunction": {
"howToUse": 1,
"startAddress": "123.123.123.123",
"endAddress": "123.123.123.123",
"dns1": "123.123.123.123",
"dns2": "123.123.123.123"
}
}
}
拠点を廃止する場合
{
"orderType": "3",
"cancelOrderPostData": {
"customerCode": "A10000105",
"customerSiteCode": "int-12345678",
"hopeToEndAt": "201912"
}
}
2.5.6.レスポンスパラメータ
項目
|
型
|
説明
|
---|---|---|
orderCode | string型 | オーダ番号。拠点申込および廃止申込の際に払い出される。オーダを一意に識別する番号である。 |
2.5.7.レスポンスサンプル
正常終了
HTTP/1.1 201 Created
{
"orderCode": "A1000010100000001"
}
異常終了(存在しない商品、または、購入することができない商品を購入する際のエラー)
HTTP/1.1 400 Bad Request
{
"errors": [
{
"errorCode": "4000137",
"errorMessage": "指定された商品要素に該当する情報が存在しません。",
"developerMessage": "指定された商品要素に該当する情報が存在しません。",
"moreInfo": null,
"requestId": "apigwnode03-52048-8824749-96"
}
]
}
異常終了(オンサイト保守オプションを購入する際に依存する主商品(CPE区分が「専用CPE付き」の主商品)が含まれていない場合のエラー)
HTTP/1.1 400 Bad Request
{
"errors": [
{
"errorCode": "4000144",
"errorMessage": "商品の組み合わせに問題があるため購入できません。",
"developerMessage": "商品の組み合わせに問題があるため購入できません。",
"moreInfo": null,
"requestId": "apigwnode02-57836-12973174-63"
}
]
}
異常終了(回線が何らかの理由で利用できない場合のエラー)
HTTP/1.1 400 Bad Request
{
"errors": [
{
"errorCode": "4000144",
"errorMessage": "商品の組み合わせに問題があるため購入できません。",
"developerMessage": "商品の組み合わせに問題があるため購入できません。",
"moreInfo": null,
"requestId": "apigwnode02-57836-12973174-63"
}
]
}
異常終了(IPoEインターネットSO受付システムのサーバエラー)
HTTP/1.1 500 Intenal Server Error
{
"errors": [
{
"errorCode": "5000102",
"errorMessage": "システムエラー発生。NTTPCへお問い合わせてください。",
"developerMessage": "システムエラー発生。NTTPCへお問い合わせてください。",
"moreInfo": null,
"requestId": "apigwnode03-52048-8824749-25"
}
]
}
2.6.オーダ一覧取得API
2.6.1.URI
https://api.customer.jp/infoIpoe/v1/orders
2.6.2.HTTPメソッド
GET
2.6.3.クエリパラメータ
項目
|
型
|
説明
|
---|---|---|
customerSiteCode | string型 | 保守番号(完全一致)。 |
lineId | string型 | 回線ID(完全一致)。 |
orderCode | string型 | オーダ番号(完全一致)。 |
customerSiteName | string型 | 拠点名(完全一致)。 |
caseName | string型 | 案件名(完全一致)。 |
productName | string型 | 商品名(部分一致)。 |
status | string型 | ステータス(1:進行中, 2:完了, 3:エラー, 4:キャンセル済)(完全一致)。 |
orderType | integer型 | オーダ種別(1:新規, 2:変更, 3:廃止)。 |
hopeToStartAtFrom | string型 | 開通希望日(From)。 |
hopeToStartAtTo | string型 | 開通希望日(To)。 |
hopeToEndAtFrom | string型 | 廃止希望日(From)。 |
hopeToEndAtTo | string型 | 廃止希望日(To)。 |
limit | integer型 | 取得件数。4桁以内の整数を入力する。例えば、"500"を指定した場合、500件分の拠点情報が返ってくる。 |
offset | integer型 | 取得開始番号。4桁以内の整数を入力する。例えば、"11"を指定した場合、先頭から11件目以降の拠点情報が返ってくる。 |
2.6.4.レスポンスパラメータ
項目
|
型
|
説明
|
---|---|---|
orderCode | string型 | オーダ番号。 |
orderType | integer型 | オーダ種別(1:新規, 2:変更, 3:廃止)。 |
customerSiteCode | string型 | 保守番号。 |
customerSiteName | string型 | 拠点名。 |
status | string型 | ステータス(1:進行中, 2:完了, 3:エラー, 4:キャンセル済)。 |
applicationDate | string型 | 申込日。 |
hopeToStartAt | string型 | 開通希望日。 |
hopeToEndAt | string型 | 廃止希望日。 |
2.6.5レスポンスサンプル
正常終了
HTTP/1.1 200 OK
[
{
"orderCode": "A1000010100000001",
"orderType": 1,
"customerSiteCode": "int-12345678",
"customerSiteName": "東京拠点",
"status": "1",
"applicationDate": "20181215",
"hopeToStartAt": "20181215",
"hopeToEndAt": "20181231"
},
{
"orderCode": "A1000010100000002",
"orderType": 1,
"customerSiteCode": "int-23456789",
"customerSiteName": "東京拠点",
"status": "2",
"applicationDate": "20191215",
"hopeToStartAt": "20191215",
"hopeToEndAt": "20191231"
}
]
異常終了(開通希望日のフォーマットを誤ったことによるエラー)
HTTP/1.1 400 Bad Request
{
"errors": [
{
"errorCode": "4000118",
"errorMessage": "開通希望日(From)は正しい形式で入力してください。",
"developerMessage": "開通希望日(From)は正しい形式で入力してください。",
"moreInfo": null,
"requestId": "apigwnode03-52048-8826079-89"
}
]
}
2.7.オーダ詳細取得API
2.7.1.URI
https://api.customer.jp/infoIpoe/v1//orders/{orderCode}
2.7.2.HTTPメソッド
GET
2.7.3.レスポンスパラメータ
項目 | 型 | 説明 | |
---|---|---|---|
orderCode | string型 | オーダ番号。 | |
orderType | integer型 | オーダ種別(1:新規, 2:変更, 3:廃止)。 | |
customerCode | string型 | システムID。 | |
customerSiteCode | string型 | 保守番号。 | |
customerSiteName | string型 | 拠点名。 | |
status | string型 | ステータス(1:進行中, 2:完了, 3:エラー, 4:キャンセル済)。 | |
applicationDate | string型 | 申込日。 | |
hopeToStartAt | string型 | 開通希望日。 | |
hopeToEndAt | string型 | 廃止希望日。 | |
caseName | string型 | 案件名。 | |
lineBundleType | integer型 | 回線手配。拠点に対する回線手配方法について表す。 | |
lineType | string型 | 回線種別。 | |
lineId | string型 | 回線ID。 | |
lineAccessKey | string型 | 回線アクセスキー。 | |
terminalBundleType | integer型 |
端末手配。拠点に対する端末手配方法について表す。現在、「1:CPEバンドル」、「2:CPEアンバンドル」のいずれかの値が入る。 CPE区分が「専用CPE」の主商品を購入した場合「1:CPEバンドル」、CPE区分が「パートナーCPE」の主商品を購入した場合、「2:CPEアンバンドル」が返ってくる。 |
|
globalIp | string型 | グローバルIP。 | |
contracts | オブジェクト | 契約情報。 | |
productCode | string型 | 商品コード。 | |
productName | string型 | 商品名。 | |
productType | integer型 | 商品種別。現状、「1:主商品」「2:オンサイト保守オプション」のみ存在する。 | |
installationLocation | オブジェクト | 設置場所。 | |
zipCode | string型 | 郵便番号。 | |
prefectures | string型 | 都道府県。 | |
address | string型 | 住所。 | |
companyName | string型 | 会社名。 | |
departmentName | string型 | 部署名。 | |
clientName | string型 | 担当者名。 | |
tel | string型 | 電話番号。 | |
terminalDestination | オブジェクト | 端末送付先。 | |
zipCode | string型 | 郵便番号。 | |
prefectures | string型 | 都道府県。 | |
address | string型 | 住所。 | |
companyName | string型 | 会社名。 | |
departmentName | string型 | 部署名。 | |
clientName | string型 | 担当者名。 | |
tel | string型 | 電話番号。 | |
hopeToAt | string型 | 到着希望日。 | |
lanAddress | オブジェクト | LAN側IPアドレス。 | |
lanNetworkAddress | string型 | LAN側ネットワークアドレス。 | |
lanInterfaceAddress | string型 | LAN側インタフェースアドレス。 | |
dhcpServerFunction | オブジェクト | DHCPサーバ機能。 | |
startAddress | string型 | 開始アドレス。 | |
endAddress | string型 | 終了アドレス。 | |
dns1 | string型 | DNS1。 | |
dns1 | string型 | DNS2。 |
2.7.4.レスポンスサンプル
正常終了
HTTP/1.1 200 OK
{
"orderCode": "A1000010100000001",
"orderType": "1",
"customerCode": "A10000105",
"customerSiteCode": "int-12345678",
"customerSiteName": "東京拠点",
"status": "1",
"applicationDate": "20181215",
"hopeToStartAt": "20181215",
"hopeToEndAt": "20181231",
"caseName": "鈴木商店",
"lineBundleType": 2,
"lineType": "フレッツ光ネクスト ファミリータイプ",
"lineId": "CAF1234567890",
"lineAccessKey": "a1b2c3d4",
"terminalBundleType": 2,
"globalIp": "1.1.1.0/27",
"contracts": [
{
"productCode": "1-2-2-1-1",
"productName": "IPoEインターネットサービス 固定IPコース Sプラン IP4タイプ 専用CPE",
"productType": 1
}
],
"installationLocation": {
"zipCode": "1050003",
"prefectures": "東京都",
"address": "港区西新橋2−14−1",
"companyName": "株式会社NTTPCコミュニケーションズ",
"departmentName": "テクノロジー&オペレーション開発本部",
"clientName": "山田太郎",
"tel": "05033881648"
},
"terminalDestination": {
"zipCode": "1050003",
"prefectures": "東京都",
"address": "港区西新橋2−14−1",
"companyName": "株式会社NTTPCコミュニケーションズ",
"departmentName": "テクノロジー&オペレーション開発本部",
"clientName": "山田太郎",
"tel": "05033881648",
"hopeToAt": "20181215"
},
"lanAddress": {
"lanNetworkAddress": "123.123.123.123/32",
"lanInterfaceAddress": "123.123.123.123"
},
"dhcpServerFunction": {
"startAddress": "123.123.123.123",
"endAddress": "123.123.123.123",
"dns1": "123.123.123.123",
"dns2": "123.123.123.123"
}
異常終了(オーダ番号のフォーマットを誤ったことによるエラー)
HTTP/1.1 400 Bad Request
{
"errors": [
{
"errorCode": "4000110",
"errorMessage": "オーダ番号は半角英数で入力してください。",
"developerMessage": "オーダ番号は半角英数で入力してください。",
"moreInfo": null,
"requestId": "apigwnode03-52048-8826079-89"
}
]
}
2.8.拠点一覧取得API
2.8.1.URI
https://api.customer.jp/infoIpoe/v1/customerSites
2.8.2.HTTPメソッド
GET
2.8.3.クエリパラメータ
項目
|
型
|
説明
|
---|---|---|
customerSiteCode | string型 | 保守番号(完全一致)。保守番号は拠点を一意に識別する番号である。 |
customerSiteName | string型 | 拠点名(部分一致)。 |
customerType | string型 | 契約者種別(1:直販顧客、2:卸事業者)(完全一致)。現在は「2:卸事業者のみ存在する。 |
customerName | string型 | 契約者名(部分一致)。 |
status | string型 | ステータス(1:利用中, 2:廃止済み)(完全一致) |
startAtFrom | string型 | 開通日(From)(YYYYMMDD)。例えば、"20190624"を指定した場合、20190624以降に作成されたオーダ情報が返ってくる。 |
startAtTo | string型 | 開通日(To)(YYYYMMDD)。例えば、"20190624"を指定した場合、20190624以前に作成されたオーダ情報が返ってくる。 |
endAtFrom | string型 | 廃止日(From)(YYYYMMDD)(但し存在する日付であること) |
endAtTo | string型 | 廃止日(To)(YYYYMMDD)(但し存在する日付であること) |
caseName | string型 | 案件名(部分一致)。 |
lineId | string型 | 回線ID(完全一致)。 |
globalIp | string型 | グローバルIP(完全一致)。 |
limit | integer型 | 取得件数。4桁以内の整数を入力する。例えば、"500"を指定した場合、500件分の拠点情報が返ってくる。 |
offset | integer型 | 取得開始番号。4桁以内の整数を入力する。例えば、"11"を指定した場合、先頭から11件目以降の拠点情報が返ってくる。 |
2.8.4.レスポンスパラメータ
項目 | 型 | 説明 | |
---|---|---|---|
customerSite | オブジェクト配列 | ||
customerSiteCode | integer型 | 保守番号。拠点を一意に識別するための番号。 | |
customerSiteName | string型 | 拠点名。 | |
customerCode | string型 | システムID。 | |
customerType | string型 | 契約者種別。 | |
customerName | string型 | 契約者名。 | |
startAt | string型 | 開通日。拠点が開通した日付。 | |
endAt | string型 | 廃止日。拠点が廃止した日付。 | |
caseName | string型 | 案件名。拠点をグルーピングする際に使用する。 | |
lineBundleType | integer型 | 回線手配。拠点に対する回線手配方法について表す。現在、「1:回線アンバンドル」が入る。 | |
lineType | string型 | 回線種別。拠点で利用している回線の種別を表す。現状、nullが返ってくる。 | |
lineId | string型 | 回線ID。拠点で利用している回線の回線IDを表す。 | |
lineAccessKey | string型 | 回線アクセスキー。拠点で利用している回線の回線アクセスキーを表す。 | |
terminalBundleType | integer型 |
端末手配。拠点に対する端末手配方法について表す。現在、「1:CPEバンドル」、「2:CPEアンバンドル」のいずれかの値が入る。 CPE区分が「専用CPE」の主商品を購入した場合「1:CPEバンドル」、CPE区分が「パートナーCPE」の主商品を購入した場合、「2:CPEアンバンドル」が返ってくる。 |
|
pponeGwNodename | string型 | PP1:GWノード名。 | |
pptwoGwNodename | string型 | PP2:GWノード名。 | |
globalIp | string型 | グローバルIP。端末に割り当てられるグローバルIPを示す。 | |
vrf | string型 | VRF。 | |
tunnelIf | string型 | Tunnel IF番号。 |
2.8.5.レスポンスサンプル
正常終了
HTTP/1.1 200 OK
{
"customerSite": [
{
"customerSiteCode": "int-10000001",
"customerSiteName": "東京拠点",
"customerCode": "A10000101",
"customerType": 2,
"customerName": "NTTPCコミュニケーションズ",
"startAt": "20190819",
"endAt": null,
"caseName": "鈴木商店",
"lineBundleType": 1,
"lineType": null,
"lineId": "CAF1234567891",
"lineAccessKey": "a1b2c3d4",
"terminalBundleType": 1,
"globalIp": "10.32.54.76/32",
"pponeGwNodename": "test",
"pptwoGwNodename": "test",
"vrf": "test",
"tunnelIf": "10000001"
},
{
"customerSiteCode": "int-10000002",
"customerSiteName": "東京拠点",
"customerCode": "A10000101",
"customerType": 2,
"customerName": "NTTPCコミュニケーションズ",
"startAt": "20190821",
"endAt": null,
"caseName": "鈴木商店",
"lineBundleType": 2,
"lineType": null,
"lineId": "CAF1234567891",
"lineAccessKey": "a1b2c3d4",
"terminalBundleType": 3,
"globalIp": "10.23.42.51",
"pponeGwNodename": "pponeGwNodename",
"pptwoGwNodename": "pptwoGwNodename",
"vrf": "test",
"tunnelIf": "10000002"
}
]
}
異常終了(開通日のフォーマットを誤ったことによるエラー)
HTTP/1.1 400 Bad Request
{
"errors": [
{
"errorCode": "4000102",
"errorMessage": "設置日は8~8文字の間で入力してください。",
"developerMessage": "設置日は8~8文字の間で入力してください。",
"moreInfo": null,
"requestId": "apigwnode03-52048-8826079-89"
}
]
}
2.9.拠点詳細取得API
2.9.1.URI
https://api.customer.jp/infoIpoe/v1/customerSites/{customerSiteCode}
2.9.2.HTTPメソッド
GET
2.9.3.レスポンスパラメータ
項目 | 型 | 説明 | ||
---|---|---|---|---|
customerSite | オブジェクト配列 | |||
customerSiteCode | integer型 | 保守番号。拠点を一意に識別するための番号。 | ||
customerSiteName | string型 | 拠点名。 | ||
customerCode | string型 | システムID。 | ||
customerType | string型 | 契約者種別。 | ||
customerName | string型 | 契約者名。 | ||
status | string型 | ステータス。 | ||
startAt | string型 | 開通日。拠点が開通した日付。 | ||
endAt | string型 | 廃止日。拠点が廃止した日付。 | ||
caseName | string型 | 案件名。拠点をグルーピングする際に使用する。 | ||
lineBundleType | integer型 | 回線手配。拠点に対する回線手配方法について表す。現在、「1:回線アンバンドル」が入る。 | ||
lineType | string型 | 回線種別。拠点で利用している回線の種別を表す。現状、nullが返ってくる。 | ||
lineId | string型 | 回線ID。拠点で利用している回線の回線IDを表す。 | ||
lineAccessKey | string型 | 回線アクセスキー。拠点で利用している回線の回線アクセスキーを表す。 | ||
terminalBundleType | integer型 |
端末手配。拠点に対する端末手配方法について表す。現在、「1:CPEバンドル」、「2:CPEアンバンドル」のいずれかの値が入る。 CPE区分が「専用CPE付き」の主商品を購入した場合「1:CPEバンドル」、CPE区分が「パートナーCPE」の主商品を購入した場合、「2:CPEアンバンドル」が返ってくる。 |
||
customerSiteNumber | string型 | 拠点通番。お客様端末の設定に利用する。 | ||
eastOrWest | string型 | 東西区分。お客様端末の設定に利用する。 固定IPコースでCPE区分が「パートナーCPE」の主商品を購入した場合の拠点のみ、この項目が返る。CPE区分が「専用CPE」の主商品を購入した場合、および動的IPコースの拠点では、この項目は返却されない。 |
||
terminalHostname | string型 | CPEホスト名。お客様端末の設定に利用する。 固定IPコースでCPE区分が「パートナーCPE」の主商品を購入した場合の拠点のみ、この項目が返る。CPE区分が「専用CPE」の主商品を購入した場合、および動的IPコースの拠点では、この項目は返却されない。 |
||
terminalDomain | string型 | CPEドメイン名。お客様端末の設定に利用する。 固定IPコースでCPE区分が「パートナーCPE」の主商品を購入した場合の拠点のみ、この項目が返る。CPE区分が「専用CPE」の主商品を購入した場合、および動的IPコースの拠点では、この項目は返却されない。 |
||
pponeGwHostname | string型 | PP1:GWホスト名。お客様端末の設定に利用する。 固定IPコースでCPE区分が「パートナーCPE」の主商品を購入した場合の拠点のみ、この項目が返る。CPE区分が「専用CPE」の主商品を購入した場合、および動的IPコースの拠点では、この項目は返却されない。 |
||
pponeGwNodename | string型 | PP1:GWノード名。お客様端末の設定に利用する。 | ||
pponeGwFqdn | string型 | PP1:GW FQDN。お客様端末の設定に利用する。 固定IPコースでCPE区分が「パートナーCPE」の主商品を購入した場合の拠点のみ、この項目が返る。CPE区分が「専用CPE」の主商品を購入した場合、および動的IPコースの拠点では、この項目は返却されない。 |
||
pponeGwTep | string型 | PP1:GW TEPアドレス。お客様端末の設定に利用する。 固定IPコースでCPE区分が「パートナーCPE」の主商品を購入した場合の拠点のみ、この項目が返る。CPE区分が「専用CPE」の主商品を購入した場合、および動的IPコースの拠点では、この項目は返却されない。 |
||
pponeGwBgp | string型 | PP1:GW BGPアドレス。お客様端末の設定に利用する。 固定IPコースでCPE区分が「パートナーCPE」の主商品を購入した場合の拠点のみ、この項目が返る。CPE区分が「専用CPE」の主商品を購入した場合、および動的IPコースの拠点では、この項目は返却されない。 |
||
pponeGwPreSharedKey | string型 | PP1:PreSharedKey。お客様端末の設定に利用する。 固定IPコースでCPE区分が「パートナーCPE」の主商品を購入した場合の拠点のみ、この項目が返る。CPE区分が「専用CPE」の主商品を購入した場合、および動的IPコースの拠点では、この項目は返却されない。 |
||
pptwoGwHostname | string型 | PP2:GWホスト名。お客様端末の設定に利用する。 固定IPコースでCPE区分が「パートナーCPE」の主商品を購入した場合の拠点のみ、この項目が返る。CPE区分が「専用CPE」の主商品を購入した場合、および動的IPコースの拠点では、この項目は返却されない。 |
||
pptwoGwNodename | string型 |
PP2:ノード名。お客様端末の設定に利用する。 固定IPコースでCPE区分が「パートナーCPE」の主商品を購入した場合の拠点のみ、この項目が返る。CPE区分が「専用CPE」の主商品を購入した場合、および動的IPコースの拠点では、この項目は返却されない。 |
||
pptwoGwFqdn | string型 |
PP2:GW FQDN。お客様端末の設定に利用する。 固定IPコースでCPE区分が「パートナーCPE」の主商品を購入した場合の拠点のみ、この項目が返る。CPE区分が「専用CPE」の主商品を購入した場合、および動的IPコースの拠点では、この項目は返却されない。 |
||
pptwoGwTep | string型 | PP2:GW TEPアドレス。お客様端末の設定に利用する。 CPE区分が「パートナーCPE」の主商品を購入した場合の拠点のみ、この項目が返る。CPE区分が「専用CPE」の主商品を購入した場合の拠点では、この項目は返却されない。 |
||
pptwoGwBgp | string型 | PP2:GW BGPアドレス。お客様端末の設定に利用する。 固定IPコースでCPE区分が「パートナーCPE」の主商品を購入した場合の拠点のみ、この項目が返る。CPE区分が「専用CPE」の主商品を購入した場合、および動的IPコースの拠点では、この項目は返却されない。 |
||
pptwoGwPreSharedKey | string型 | PP2:PreSharedKey。お客様端末の設定に利用する。 CPE区分が「専用CPE付き」の主商品を購入した場合の拠点のみ、この項目が返る。CPE区分が「パートナーCPE」の主商品を購入した場合の拠点では、この項目は返却されない。 |
||
lanLoopback | string型 |
拠点LAN側Loopback I/Fアドレス。お客様端末の設定に利用する。 |
||
globalIp | string型 | グローバルIP。端末に割り当てられるグローバルIPを示す。お客様端末の設定に利用する。固定IPコースの主商品を購入した場合のみこの項目が返る。動的IPコースの拠点では、この項目は返却されない。 | ||
vrf | string型 |
VRF。お客様端末の設定に利用する。 固定IPコースでCPE区分が「パートナーCPE」の主商品を購入した場合の拠点のみ、この項目が返る。CPE区分が「専用CPE」の主商品を購入した場合、および動的IPコースの拠点では、この項目は返却されない。 |
||
tunnelIf | string型 |
Tunnel IF番号。お客様端末の設定に利用する。 固定IPコースでCPE区分が「パートナーCPE」の主商品を購入した場合の拠点のみ、この項目が返る。CPE区分が「専用CPE」の主商品を購入した場合、および動的IPコースの拠点では、この項目は返却されない。 |
||
contracts | 配列オブジェクト | 拠点に紐づく契約情報を示すオブジェクト。拠点についてどの商品を購入したかを示す。 | ||
productCode | string型 | 商品コード。拠点に対して、どの商品を購入したかを示す。 | ||
productName | string型 | 商品名。購入した商品の名称を示す。 | ||
productType | integer型 | 商品種別。現状、「1:主商品」「2:オンサイト保守オプション」のいずれかの値が入る。 | ||
startAt | string型 | 課金開始日。拠点が開通した日付が設定される。課金開始日の翌月からお客様向けに請求される。 | ||
endAt | string型 | 課金開始日。拠点が開通した日付が設定される。課金開始日の翌月からお客様向けに請求される。 | ||
customerSiteInstallationLocation | オブジェクト | CPEの設置場所に関する情報を示すオブジェクト。 固定IPコースでCPE区分が「パートナーCPE」の主商品を購入した場合の拠点のみ、この項目が返る。CPE区分が「専用CPE」の主商品を購入した場合、および動的IPコースの拠点では、このオブジェクトはnullで返る。 |
||
zipCode | string型 | 郵便番号。 | ||
prefectures | string型 | 都道府県。 | ||
address | string型 | 住所。 | ||
companyName | string型 | 会社名。 | ||
departmentName | string型 | 部署名。 | ||
clientName | string型 | 現地担当者。 | ||
tel | string型 | 電話番号。 | ||
customerSiteLanAddress | オブジェクト | LAN側IPアドレスに関する情報を示すオブジェクト。 固定IPコースでCPE区分が「パートナーCPE」の主商品を購入した場合の拠点のみ、この項目が返る。CPE区分が「専用CPE」の主商品を購入した場合、および動的IPコースの拠点では、このオブジェクトはnullで返る。 |
||
lanNetworkAddress | string型 | LAN側ネットワークアドレス。 | ||
lanInterfaceAddress | string型 | LAN側インターフェースアドレス。 | ||
customerSiteDhcpServerFunction | オブジェクト | DHCPサーバ機能に関する情報を示すオブジェクト。 固定IPコースでCPE区分が「パートナーCPE」の主商品を購入した場合の拠点のみ、この項目が返る。CPE区分が「専用CPE」の主商品を購入した場合、および動的IPコースの拠点では、このオブジェクトはnullで返る。 |
||
startAddress | string型 | 開始アドレス。 | ||
endAddress | string型 | 終了アドレス。 | ||
dns1 | string型 | DNS1。 | ||
dns2 | string型 | DNS2。 |
- CPE区分が「専用CPE付き」の主商品を購入した場合、以下のオブジェクトはnullで返ってくる。
- customerSiteInstallationLocation:端末設置場所情報
- customerSiteLanAddress:LAN側IPアドレス情報
- customerSiteDhcpServerFunction:DHCPサーバ機能情報
- CPE区分が「パートナーCPE」の主商品を購入した場合、以下の項目はレスポンスには含まれない。
- eastOrWest:東西区分
- terminalHostname:CPEホスト名
- terminalDomain:CPEドメイン名
- pponeGwHostname:PP1:GWホスト名
- pponeGwFqdn:PP1:GW FQDN
- pponeGwTep:PP1:GW TEPアドレス
- pponeGwBgp:PP1:GW BGPアドレス
- pptwoGwHostname:PP2:GWホスト名
- pptwoGwFqdn:PP2:GW FQDN
- pptwoGwTep:PP2:GW TEPアドレス
- pptwoGwBgp:PP2:GW BGPアドレス
2.9.4.レスポンスサンプル
正常終了(CPE区分が「パートナーCPE」の主商品を購入した拠点の場合)
HTTP/1.1 200 OK
{
"customerSite": {
"customerSiteCode": "int-10000002",
"customerSiteName": "東京拠点",
"customerCode": "A10000101",
"customerType": 2,
"customerName": "NTTPCコミュニケーションズ",
"startAt": "20190821",
"endAt": null,
"caseName": "鈴木商店",
"lineBundleType": 1,
"lineType": null,
"lineId": "CAF1234567891",
"lineAccessKey": "a1b2c3d4",
"terminalBundleType": 2,
"customerSiteNumber": "6000002",
"eastOrWest": null,
"terminalHostname": "int-10000002",
"terminalDomain": null,
"pponeGwHostname": null,
"pponeGwFqdn": null,
"pponeGwTep": null,
"pponeGwBgp": null,
"pponeGwPreSharedKey": "2mCj3aAVsw0yy0uTCgg3ApiUhVP84d",
"pptwoGwHostname": null,
"pptwoGwFqdn": null,
"pptwoGwTep": null,
"pptwoGwBgp": null,
"pptwoGwPreSharedKey": "8j588aCTCmlPmC5L4lhd7tIaYvAu79",
"lanLoopback": null,
"globalIp": null,
"pponeGwNodename": null,
"pptwoGwNodename": null,
"vrf": null,
"tunnelIf": "10000002",
"contract": [
{
"productCode": "1-1-5-1-1",
"productName": "IPoEインターネットサービス 固定IPコース Eプラン IP1タイプ パートナーCPE",
"productType": 1,
"startAt": null,
"endAt": null
}
],
"customerSiteInstallationLocation": null,
"customerSiteLanAddress": null,
"customerSiteDhcpServerFunction": null
}
}
正常終了(CPE区分が「専用CPE付き」、IPアドレス区分が「IP1」の主商品を、オンサイト保守オプションあり、DHCPサーバ機能ありにて購入した拠点の場合)
HTTP/1.1 200 OK
{
"customerSite": {
"customerSiteCode": "int-10000001",
"customerSiteName": "東京拠点",
"customerCode": "A10000101",
"customerType": 2,
"customerName": "NTTPCコミュニケーションズ",
"startAt": "20190819",
"endAt": null,
"caseName": "鈴木商店",
"lineBundleType": 1,
"lineType": null,
"lineId": "CAF1234567891",
"lineAccessKey": "a1b2c3d4",
"terminalBundleType": 1,
"globalIp": "10.32.54.76/32",
"contract": [
{
"productCode": "1-1-5-1-1",
"productName": "IPoEインターネットサービス 固定IPコース Eプラン IP1タイプ 専用CPE",
"productType": 1,
"startAt": null,
"endAt": null
},
{
"productCode": "0-1-1-3-2",
"productName": "専用CPE24/365オンサイト保守オプション",
"productType": 2,
"startAt": null,
"endAt": null
}
],
"customerSiteInstallationLocation": {
"zipCode": "1050003",
"prefectures": "東京都",
"address": "港区西新橋2−14−1",
"companyName": "株式会社NTTPCコミュニケーションズ",
"departmentName": "テクノロジー&オペレーション開発本部",
"clientName": "山田太郎",
"tel": "05033881648"
},
"customerSiteLanAddress": {
"lanNetworkAddress": "123.123.123.123/32",
"lanInterfaceAddress": "123.123.123.123"
},
"customerSiteDhcpServerFunction": {
"startAddress": "123.123.123.123",
"endAddress": "123.123.123.123",
"dns1": "123.123.123.123",
"dns2": "123.123.123.123"
}
}
}
異常終了(存在しない保守番号、または、閲覧権限のない保守番号を指定した際のエラー)
HTTP/1.1 400 Bad Request
{
"errors": [
{
"errorCode": "4000137",
"errorMessage": "指定された保守番号に該当する情報が存在しません。",
"developerMessage": "指定された保守番号に該当する情報が存在しません。",
"moreInfo": null,
"requestId": "apigwnode03-52047-8825470-52"
}
]
}
3.API利用のユースケース
3.1.認証から各種APIを利用するまでの流れ
各APIを利用するためには、認証APIによる認証を実行する必要があります。
認証APIで得られた認証トークンを利用し、各APIを利用します。
認証トークンの有効期限は3600秒であるため、ほかのAPIの利用時に再利用できます。
3.2.APIによるIPoEインターネットサービス申込の流れ
契約者商品別商品リスト取得APIから、お客様が購入することができる商品リストを取得する必要があります。
商品リストからお客様が購入したい商品を選択し、オーダ登録APIを利用する際に商品情報を設定してください。
オーダ登録APIの処理が正常に終了すると、オーダ番号がレスポンスとして返ってきます。
オーダ番号は他のAPIから取得することはできませんのでご注意ください。
3.3.APIによる拠点情報取得からCPE設定までの流れ
拠点が開通しましたら、APIから拠点情報が取得できるようになります。
CPE区分が「パートナーCPE」の主商品を購入していた場合、この拠点情報にはお客様端末の設定情報が含まれています。
端末情報を設定するユーザがお客様システムへアクセスして、
端末設定情報を入手できるようなユースケースが考えられます。
※CPE区分が「専用CPE付き」の主商品を購入した場合、お客様端末の設定情報は含まれていないため、ご注意ください。
コメント
0件のコメント