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を提供いたします。

2.2.共通仕様

2.2.1.プロトコル

HTTP/1.1

2.2.2.暗号化

セキュリティの観点から、SSLによる暗号化を必須とする。

2.2.3.APIリクエスト

リクエストボディのデータ形式はJSONとする。

2.2.4.APIレスポンス

IPoEインターネットサービスで提供するAPIでは、すべてにリクエストに対して以下のHTTPステータスコードを返します。

また、上記のAPIにてHTTPステータスが400番台の場合、以下の形式でエラーメッセージを返します。

エラーメッセージの例を以下に示します。
例えば、バリデーションエラーが複数発生した場合、エラーメッセージが複数返ることがあります。

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.リクエストパラメータ

2.3.4.リクエストサンプル

{
 "grantType": "client_credential",
 "clientId": "**********",
 "clientSecret": "**********"
}

2.3.5.レスポンスパラメータ

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.アクセストークンについて

1. アクセストークンの追加発行
   APIクライアントが複数ある場合など、アクセストークンを複数発行することが可能です。複数のアクセストークンを発行した場合においても、発行済みのアクセストークンは失効しません。
   
   
2. アクセストークンの再発行
   アクセストークンが失効した場合、再度、認証APIによりアクセストークンを入手してください。
   
   
3. アクセストークンの利用
   他のAPIを実行する場合、認証APIにて取得したアクセストークンをAuthorizationヘッダフィールドに設定し、APIリクエストを実行してください。
   Authorization: Bearer YOUR_ACCESS_TOKEN
4. アクセストークンの有効期限
   認証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.クエリパラメータ

2.4.4.レスポンスパラメータ

• 主商品には、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-1-1-1",
 "productName": "IPoEインターネットサービス　法人コース エントリー(E)プラン　IP1(D)タイプ パートナーCPE(Ⅰ型)",
 "productType": 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,
 "course": "0",
 "plan": "1",
 "ipaddress": "1",
 "cpe": "3",
 "line": "1",
 "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.リクエストパラメータ

2.5.5.リクエストサンプル

CPE区分が「パートナーCPE(Ⅰ型)」もしくは「パートナーCPE(Ⅱ型)」の主商品を購入する場合

{
 "orderType": "1",
 "startOrderPostData": {
 "customerSiteName": "東京拠点",
 "customerCode": "A10000105",
 "caseName": "鈴木商店",
 "lineId": "CAF1234567890",
 "lineAccessKey": "a1b2c3d4",
 "product": {
 "course": "1",
 "plan": "1",
 "ipaddress": "1",
 "cpe": "2",
 "line": "1"
 }
}

CPE区分が「専用CPE付き」、IPアドレス区分が「IP1(D)タイプ」の主商品を、オンサイト保守オプションなし、DHCPサーバ機能なしにて購入する場合

{
 "orderType": "1",
 "startOrderPostData": {
 "customerSiteName": "東京拠点",
 "customerCode": "A10000105",
 "caseName": "鈴木商店",
 "lineId": "CAF1234567890",
 "lineAccessKey": "a1b2c3d4",
 "hopeToOpenAt": "20190704",
 "product": {
 "course": "1",
 "plan": "1",
 "ipaddress": "1",
 "cpe": "1",
 "line": "1"
 },
 
 "installationLocation": {
 "zipCode": "1050003",
 "prefectures": "東京都",
 "address": "港区西新橋2−14−1",
 "companyName": "株式会社NTTPCコミュニケーションズ",
 "departmentName": "総務部",
 "clientName": "山田太郎",
 "tel": "0300000000"
 },
 "terminalDestination": {
 "zipCode": "1050003",
 "prefectures": "東京都",
 "address": "港区西新橋2−14−1",
 "companyName": "株式会社NTTPCコミュニケーションズ",
 "departmentName": "総務部",
 "clientName": "山田太郎",
 "tel": "0300000000",
 "hopeToAt": "20190703"
 },
 "dhcpServerFunction": {
 "howToUse": 0
 }
 }
}

CPE区分が「専用CPE付き」、IPアドレス区分が「IP1(D)タイプ」の主商品を、オンサイト保守オプションあり、DHCPサーバ機能ありにて購入する場合

{
 "orderType": "1",
 "startOrderPostData": {
 "customerSiteName": "東京拠点",
 "customerCode": "A10000105",
 "caseName": "鈴木商店",
 "lineId": "CAF1234567890",
 "lineAccessKey": "a1b2c3d4",
 "hopeToOpenAt": "20190704",
 "product": {
 "course": "1",
 "plan": "1",
 "ipaddress": "1",
 "cpe": "1",
 "line": "1"
 },
 "options": [
 {
 "productCode": "0-1-1-3-1"
 }
 ],
 "installationLocation": {
 "zipCode": "1050003",
 "prefectures": "東京都",
 "address": "港区西新橋2−14−1",
 "companyName": "株式会社NTTPCコミュニケーションズ",
 "departmentName": "総務部",
 "clientName": "山田太郎",
 "tel": "0300000000"
 },
 "terminalDestination": {
 "zipCode": "1050003",
 "prefectures": "東京都",
 "address": "港区西新橋2−14−1",
 "companyName": "株式会社NTTPCコミュニケーションズ",
 "departmentName": "総務部",
 "clientName": "山田太郎",
 "tel": "0300000000",
 "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.レスポンスパラメータ

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.クエリパラメータ

2.6.4.レスポンスパラメータ

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.レスポンスパラメータ

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,
 "customerSiteNumber": "6837561",
 "eastOrWest": "east",
 "terminalHostname": "int-12345678",
 "terminalDomain": "cpe.msone.jp",
 "pponeGwHostname": "ipoe-east-PP1-3",
 "pponeGwFqdn": "ipoe-east-PP1-3.cpe.msone.jp",
 "pponeGwTep": "2001:2c0:7:hoge::hoge",
 "pponeGwBgp": "100.64.hoge.hoge",
 "pponeGwPreSharedKey": "hogeDAr4MgXZ5hn76SPGBmya6mhoge",
 "pptwoGwHostname": "ipoe-east-PP2-3",
 "pptwoGwFqdn": "ipoe-east-PP2-3.cpe.msone.jp",
 "pptwoGwTep": "2001:2c0:7:hoge::hoge",
 "pptwoGwBgp": "100.64.hoge.hoge",
 "pptwoGwPreSharedKey": "hogeDAr4MgXZ5hn76SPGBmya6mhoge",
 "lanLoopback": "100.64.hoge.hoge",
 "globalIp": "1.1.1.0/27",
 "pponeGwNodename": "hoge1",
 "pptwoGwNodename": "hoge2",
 "vrf": "1234",
 "tunnelIf": "12345678",
 "contracts": [
 {
 "productCode": "1-2-2-1-1",
 "productName": "IPoEインターネットサービス　法人コース スタンダード(S)プラン　IP4タイプ　専用CPE付き",
 "productType": 1
 }
 ],
 "installationLocation": {
 "zipCode": "1050003",
 "prefectures": "東京都",
 "address": "港区西新橋2−14−1",
 "companyName": "株式会社NTTPCコミュニケーションズ",
 "departmentName": "総務部",
 "clientName": "山田太郎",
 "tel": "0300000000"
 },
 "terminalDestination": {
 "zipCode": "1050003",
 "prefectures": "東京都",
 "address": "港区西新橋2−14−1",
 "companyName": "株式会社NTTPCコミュニケーションズ",
 "departmentName": "総務部",
 "clientName": "山田太郎",
 "tel": "0300000000",
 "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.クエリパラメータ

2.8.4.レスポンスパラメータ

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.レスポンスパラメータ

• CPE区分が「専用CPE付き」の主商品を購入した場合、以下のオブジェクトはnullで返ってくる。
  • customerSiteInstallationLocation：端末設置場所情報
  • customerSiteLanAddress：LAN側IPアドレス情報
  • customerSiteDhcpServerFunction：DHCPサーバ機能情報
• CPE区分が「パートナー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(Ⅰ型)」もしくは「パートナー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",
 "customerSiteContract": [
 {
 "customerSiteContractId": 3,
 "customerSiteContractCode": null,
 "productCode": "1-1-1-3-1",
 "productName": "IPoEインターネットサービス　法人コース エントリー(E)プラン　IP1(D)タイプ パートナーCPE(Ⅱ型)",
 "productType": 1,
 "course": "1",
 "plan": "1",
 "ipaddress": "1",
 "cpe": "3",
 "line": "1",
 "chargeStartAt": null,
 "chargeEndAt": null
 }
 ],
 "customerSiteInstallationLocation": null,
 "customerSiteLanAddress": null,
 "customerSiteDhcpServerFunction": null
 }
}

正常終了（CPE区分が「専用CPE付き」、IPアドレス区分が「IP1(D)」の主商品を、オンサイト保守オプションあり、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",
 "pponeGwNodename": "test",
 "pptwoGwNodename": "test",
 "vrf": "test",
 "tunnelIf": "10000001",
 "customerSiteContract": [
 {
 "customerSiteContractId": 1,
 "customerSiteContractCode": null,
 "productCode": "1-1-1-1-1",
 "productName": "IPoEインターネットサービス　法人コース エントリー(E)プラン　IP1(D)タイプ　専用CPE付き",
 "productType": 1,
 "course": "1",
 "plan": "1",
 "ipaddress": "1",
 "cpe": "1",
 "line": "1",
 "chargeStartAt": null,
 "chargeEndAt": null
 },
 {
 "customerSiteContractId": 2,
 "customerSiteContractCode": null,
 "productCode": "0-1-1-3-2",
 "productName": "専用CPE24/365オンサイト保守オプション",
 "productType": 2,
 "course": null,
 "plan": null,
 "ipaddress": null,
 "cpe": null,
 "line": null,
 "chargeStartAt": null,
 "chargeEndAt": null
 }
 ],
 "customerSiteInstallationLocation": {
 "zipCode": "1050003",
 "prefectures": "東京都",
 "address": "港区西新橋2−14−1",
 "companyName": "株式会社NTTPCコミュニケーションズ",
 "departmentName": "総務部",
 "clientName": "山田太郎",
 "tel": "0300000000"
 },
 "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区分が「専用CPE付き」の主商品を購入した場合、お客様端末の設定情報は含まれていないため、ご注意ください。