1はじめに
2API仕様
- 2.1API一覧
- 2.2共通仕様
  - 2.2.1プロトコル
  - 2.2.2暗号化
  - 2.2.3API方針
  - 2.2.4APIリクエスト
  - 2.2.5APIレスポンス
- 2.3認証API
  - 2.3.1URI
  - 2.3.2HTTPメソッド
  - 2.3.3リクエストパラメータ
  - 2.3.4リクエストサンプル
  - 2.3.5レスポンスパラメータ
  - 2.3.6レスポンスサンプル
  - 2.3.7アクセストークンについて
- 2.4契約者別商品リスト取得API
  - 2.4.1URI
  - 2.4.2HTTPメソッド
  - 2.4.3クエリパラメータ
  - 2.4.4レスポンスパラメータ
  - 2.4.5レスポンスサンプル
- 2.5オーダー登録API
  - 2.5.1URI
  - 2.5.2HTTPメソッド
  - 2.5.3ヘッダ
  - 2.5.4リクエストパラメータ
  - 2.5.5リクエストサンプル
  - 2.5.6レスポンスパラメータ
  - 2.5.7レスポンスサンプル
- 2.6拠点一覧取得API
  - 2.6.1URI
  - 2.6.2HTTPメソッド
  - 2.6.3クエリパラメータ
  - 2.6.4レスポンスパラメータ
  - 2.6.5レスポンスサンプル
- 2.7拠点詳細取得API
  - 2.7.1URI
  - 2.7.2HTTPメソッド
  - 2.7.3レスポンスパラメータ
  - 2.7.4レスポンスサンプル
3API利用のユースケース

はじめに

本資料は、株式会社エヌ・ティ・ティピー・シーコミュニケーションズ(以下、NTTPC)が提供するIPoEインターネットサービスのカスタマコントロールのAPI仕様書です。

今後、本資料は予告なく変更される可能性があります。

API仕様

API一覧

IPoEインターネットサービスでは、以下のAPIを提供いたします。

＃	API種別	利用用途
1	認証API	APIを利用するための認証を行う。本APIで取得したトークン情報をその他のAPIにて認証情報として利用する。
2	契約者別商品リスト取得API	お客様が購入することができる商品リストを取得する。本APIにて取得できる商品はPC社への申込時に申込書に記述した商品に限る。本APIで取得した商品リストから購入したい商品情報をオーダー登録APIにて利用する。
3	オーダー登録API	IPoEインターネットサービスを利用するためのオーダー登録を実施する。オーダーが進捗しIPoEインターネットサービスを利用できるようになった時点で拠点が生成される。
4	拠点一覧取得API	お客様が利用している拠点の一覧を取得する。
5	拠点詳細取得API	お客様が利用している拠点の詳細情報を取得する。

共通仕様

プロトコル

HTTP/1.1

暗号化

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

API方針

IPoEインターネットサービスで提供するAPIはRESTful APIに準拠する。

APIリクエスト

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

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。主に問い合わせで利用する。

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

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"
        }
    ]
}

認証API

URI

https://api.customer.jp/oauth/v1

HTTPメソッド

POST

リクエストパラメータ

項目	型	必須	説明
grantType	string	〇	client_credentialを指定する。
clientId	string	〇	IPoEインターネットサービスのAPI利用申請申込時に、NTTPCから提供しましたクライアントIDを指定してください。
clientSecret	string	〇	IPoEインターネットサービスのAPI利用申請申込時に、NTTPCから提供しましたパスワードを指定してください。

リクエストサンプル

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

レスポンスパラメータ

項目	型	説明
accessToken	string	アクセストークン。このアクセストークンを用いて他のAPIを利用する。
tokenType	string	トークン種別。BearerTokenが固定で返る。
expiresIn	string	アクセストークンの有効期限。単位はsec。現在、3599 secが指定されている。
scope	string	アクセストークンスコープ。現在は空文字が指定されている。
issudAt	string	アクセストークンの発行日時。

レスポンスサンプル

正常終了

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"
}

アクセストークンについて

アクセストークンの追加発行
APIクライアントが複数ある場合など、アクセストークンを複数反抗することが可能です。複数のアクセストークンを発行した場合においても、発行済みのアクセストークンは失効しません。
アクセストークンの再発行
アクセストークンが失効した場合、再度、認証APIによりアクセストークンを入手してください。
アクセストークンの利用
他のAPIを実行する場合、認証APIにて取得したアクセストークンをAuthorizationヘッダフィールドに設定し、APIリクエストを実行してください。
Authorization: Bearer YOUR_ACCESS_TOKEN
アクセストークンの有効期限
認証APIにて発行されるアクセストークンの有効期限は3600秒です。アクセストークンは有効期限内でのみ有効となり、有効期限を超過したアクセストークンは利用できません。有効期限切れのアクセストークンを用いたAPIリクエストに対して、APIはHTTPステータスコード「401 Unauthorized」を返答します。また、将来的に有効期限は変更される可能性がございます。

契約者別商品リスト取得API

URI

https://api.customer.jp/infoIpoe/v1/customerProducts

HTTPメソッド

GET

クエリパラメータ

項目	型	説明
productName	string型	商品名。部分一致による検索を行う。
limit	integer型	取得件数。4桁以内の整数を入力する。で例えば、"500"を指定した場合、500件分の拠点情報が返ってくる。
offset	integer型	取得開始番号。4桁以内の整数を入力する。例えば、"11"を指定した場合、先頭から11件目以降の拠点情報が返ってくる。

レスポンスパラメータ

項目			型	説明
customerProduct			オブジェクト配列
	customerProductId		integer型	契約者別商品ID。
	customerCode		string型	システムID。
	productCode		string型	商品コード。商品を一意に決定するコード。
	productName		string型	商品名。
	productType		string型	商品種別。現状、「1：主商品」「2：オンサイト保守オプション」のみ存在する。
	course		string型	コース区別。主商品の場合、「1：法人コース」のみ存在する。オプションの場合、nullが返る。 ※将来的に、この項目がなくなる可能性あり。
	plan		string型	プラン区別。主商品の場合、「1：エントリー(E)」「2：スタンダード(S)」「3：プレミアム(P)」が存在する。オプションの場合、nullが返る。
	ipaddress		string型	IPアドレス区別。主商品の場合、現状、「1：IP1(D)タイプ」「2：IP4タイプ」「5：IP1タイプ」が存在する。オプションの場合、nullが返る。
	cpe		string型	CPE区別。主商品の場合、「1：専用CPE付き」「2：パートナーCPE(Ⅰ型)」、「3：パートナーCPE(Ⅱ型)」が存在する。オプションの場合、nullが返る。
	line		string型	回線区別。主商品の場合、現状、「1：回線アンバンドル」が存在する。オプションの場合、nullが返る。
	shortestPeriod		string型	最低利用期間。商品に対して利用しなければならない期間を表す。この期間を割って解約した場合、違約金が発生する。
	purchasePrice		string型	初期費用。この商品を購入する場合の初期費用が返る。
	monthlyPrice		string型	月額費用。この商品を購入する場合の月額費用が返る。
	measurePrice		string型	従量費用。現在はnullが返る。
	productDependencies		オブジェクト配列	製品の依存関係。現状、商品種別が「2：オンサイト保守オプション」の場合のみ値が返る。選択した商品に依存関係がある場合、依存先の商品を購入しなければ、選択した商品を購入することはできない。
		productCode	string型	依存する主商品の商品コードが返る。

主商品には、course:コース区別、plan:プラン(帯域)区別、ipaddress:IPアドレス区別、cpe:CPE区別、line:回線区別がある。この各要素の組み合わせにより、主商品が決定される。
オプションには、上記の概念がない。そのため、各要素に該当するパラメータにはnullが設定されている。
オプションを購入する場合には、productCode:商品コードを用いる。

レスポンスサンプル

正常終了

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"
        }
    ]
}

オーダー登録API

URI

https://api.customer.jp/infoIpoe/v1/orders

HTTPメソッド

POST

ヘッダ

以下のヘッダをお付けください。

Content-Type: application/json; charset=utf-8

リクエストパラメータ

項目			必須〇：必須 △：条件付き必須	型	バリデーション	説明
orderType			〇	string型	数字 2桁以下	オーダ種別。現在は「1：新規登録」のみ有効である。
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日以降	開通希望日。拠点を開通したい日付を表す。
	product		〇	オブジェクト
		course	〇	string型	数字 2桁以下	コース区別。「1：標準コース」のみが存在する。 ※将来的に、この項目がなくなる可能性あり。
		plan	〇	string型	数字 2桁以下	プラン区別。「1：エントリー(E)」「2：スタンダード(S)」「3：プレミアム(P)」が存在する。
		ipaddress	〇	string型	数字 2桁以下	IPアドレス区別。現状、「1：IP1(D)タイプ」「2：IP4タイプ」「5：IP1タイプ」が存在する。
		cpe	〇	string型	数字 2桁以下	CPE区別。「1：専用CPE付き」「2：パートナーCPE(Ⅰ型)」、「3：パートナーCPE(Ⅱ型)」が存在する。
		line	〇	string型	数字 2桁以下	回線区別。現状、「1：回線アンバンドル」が存在する。
	options			オブジェクト配列		オプション。
		productCode		string型	半角英数字記号 256桁以下	オプションの商品コード。購入したいオプションの商品コードを指定することにより、オプションを購入することができる。
	installationLocation		△(productオブジェクトのcpeが「1：専用CPE付き」の場合に必須)	オブジェクト		CPEを設置する場所に関する情報を示すオブジェクト。以下のオブジェクト配下の各項目にはCPEを設置したい場所を設定する。
		zipCode	△(productオブジェクトのcpeが「1：専用CPE付き」の場合に必須)	string型	半角数字 7桁	郵便番号。
		prefectures	△(productオブジェクトのcpeが「1：専用CPE付き」の場合に必須)	string型	全角文字 3文字以上、4文字以下	都道府県。
		address	△(productオブジェクトのcpeが「1：専用CPE付き」の場合に必須)	string型	半角英数字、全角文字、ハイフン 100文字以下	住所。
		companyName	△(productオブジェクトのcpeが「1：専用CPE付き」の場合に必須)	string型	半角英数字、全角文字、ハイフン 64文字以下	会社名。
		departmentName		string型	半角英数字、全角文字、ハイフン 64文字以下	部署名。
		clientName	△(productオブジェクトのcpeが「1：専用CPE付き」の場合に必須)	string型	半角英数字、全角文字 20文字以下	現地担当者。
		tel	△(productオブジェクトのcpeが「1：専用CPE付き」の場合に必須)	string型	半角数字 10桁から11桁まで	電話番号。
	terminalDestination		△(productオブジェクトのcpeが「1：専用CPE付き」の場合に必須)	オブジェクト		CPEを送付する場所に関する情報を示すオブジェクト。以下のオブジェクト配下の各項目にはCPEを送付したい場所を設定する。
		zipCode	△(productオブジェクトのcpeが「1：専用CPE付き」の場合に必須)	string型	半角数字 7桁	郵便番号。
		prefectures	△(productオブジェクトのcpeが「1：専用CPE付き」の場合に必須)	string型	全角文字 3文字以上、4文字以下	都道府県。
		address	△(productオブジェクトのcpeが「1：専用CPE付き」の場合に必須)	string型	半角英数字、全角文字、ハイフン 100文字以下	住所。
		companyName	△(productオブジェクトのcpeが「1：専用CPE付き」の場合に必須)	string型	半角英数字、全角文字、ハイフン 64文字以下	会社名。
		departmentName		string型	半角英数字、全角文字、ハイフン 64文字以下	部署名。
		clientName	△(productオブジェクトのcpeが「1：専用CPE付き」の場合に必須)	string型	半角英数字、全角文字 20文字以下	現地担当者。
		tel	△(productオブジェクトのcpeが「1：専用CPE付き」の場合に必須)	string型	半角数字 10桁から11桁まで	電話番号。
		hopeToAt	△(productオブジェクトのcpeが「1：専用CPE付き」の場合に必須)	string型	YYYYMMDD 申込日から15日以降開通希望日-1日以前	到着希望日。
	lanAddress		△(productオブジェクトのcpeが「1：専用CPE付き」、かつ、productオブジェクトのipaddressが「2：IP4タイプ」以外の場合に必須)	オブジェクト		LAN側アドレスに関する情報を示すオブジェクト。
		lanNetworkAddress	△(productオブジェクトのcpeが「1：専用CPE付き」、かつ、productオブジェクトのipaddressが「2：IP4タイプ」以外の場合に必須)	string型	半角数字、ピリオド( . )、スラッシュ( / ) 9桁から18桁まで	LAN側ネットワークアドレス。
		lanInterfaceAddress	△(productオブジェクトのcpeが「1：専用CPE付き」、かつ、productオブジェクトのipaddressが「2：IP4タイプ」以外の場合に必須)	string型	半角数字、ピリオド( . ) 7桁から15桁まで	LAN側インタフェースアドレス。
	dhcpServerFunction		△(productオブジェクトのcpeが「1：専用CPE付き」の場合に必須)	オブジェクト		DHCPサーバ機能に関する情報を示すオブジェクト。
		howToUse	△(productオブジェクトのcpeが「1：専用CPE付き」の場合に必須)	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アドレスが自動的に設定される。
changeOrderPostData				オブジェクト
endOrderPostData				オブジェクト

リクエストサンプル

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"
    }
  "changeOrderPostData": {},
  "endOrderPostData": {}
}

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": "05033881648"
    },
    "terminalDestination": {
      "zipCode": "1050003",
      "prefectures": "東京都",
      "address": "港区西新橋2−14−1",
      "companyName": "株式会社NTTPCコミュニケーションズ",
      "departmentName": "テクノロジー＆オペレーション開発本部",
      "clientName": "山田太郎",
      "tel": "05033881648",
      "hopeToAt": "20190703"
    },
    "dhcpServerFunction": {
      "howToUse": 0
    }
  },
  "changeOrderPostData": {},
  "endOrderPostData": {}
}

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": "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"
    }
  },
  "changeOrderPostData": {},
  "endOrderPostData": {}
}

レスポンスパラメータ

項目	型	説明
orderCode	string型	オーダ番号。拠点申込の際に払い出される。オーダを一意に識別する番号である。※現在、オーダ番号は他のAPIのレスポンスにも含まれないため、ご注意ください。

レスポンスサンプル

正常終了

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": "4000139",
            "errorMessage": "アクセス回線状態エラー。「入力した回線の契約内容の誤り（存在しない、無効、回線が廃止済み）」もしくは「移転・品目変更をNTT側で処理中」です。回線の契約内容が合っている場合は、日にちをおいて再オーダーしてください。",
            "developerMessage": "アクセス回線状態エラー。「入力した回線の契約内容の誤り（存在しない、無効、回線が廃止済み）」もしくは「移転・品目変更をNTT側で処理中」です。回線の契約内容が合っている場合は、日にちをおいて再オーダーしてください。　申込結果コード：980",
            "moreInfo": null,
            "requestId": "apigwnode03-52047-8825470-33"
        }
    ]
}

異常終了（IPoEインターネットSO受付システムのサーバエラー）

HTTP/1.1 500 Intenal Server Error
{
    "errors": [
        {
            "errorCode": "5000102",
            "errorMessage": "システムエラー発生。NTTPCへお問い合わせてください。",
            "developerMessage": "システムエラー発生。NTTPCへお問い合わせてください。",
            "moreInfo": null,
            "requestId": "apigwnode03-52048-8824749-25"
        }
    ]
}

拠点一覧取得API

URI

https://api.customer.jp/infoIpoe/v1/customerSites

HTTPメソッド

GET

クエリパラメータ

項目	型	説明
customerSiteCode	string型	保守番号（完全一致）。保守番号は拠点を一意に識別する番号である。
customerSiteName	string型	拠点名（部分一致）。
customerType	string型	契約者種別（1:直販顧客、2:卸事業者）（完全一致）。現在は「2:卸事業者のみ存在する。
customerName	string型	契約者名（部分一致）。
startAtFrom	string型	開通日(From)（YYYYMMDD）。例えば、"20190624"を指定した場合、20190624以降に作成されたオーダ情報が返ってくる。
startAtTo	string型	開通日(To)（YYYYMMDD）。例えば、"20190624"を指定した場合、20190624以前に作成されたオーダ情報が返ってくる。
caseName	string型	案件名(部分一致)。
lineId	string型	回線ID(完全一致)。
globalIp	string型	グローバルIP(完全一致)。
limit	integer型	取得件数。4桁以内の整数を入力する。例えば、"500"を指定した場合、500件分の拠点情報が返ってくる。
offset	integer型	取得開始番号。4桁以内の整数を入力する。例えば、"11"を指定した場合、先頭から11件目以降の拠点情報が返ってくる。

レスポンスパラメータ

項目		型	説明
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(Ⅰ型)」もしくは「パートナーCPE(Ⅱ型)」の主商品を購入した場合、「2：CPEアンバンドル」が返ってくる。
	pponeGwNodename	string型	PP1:GWノード名。
	pptwoGwNodename	string型	PP2:GWノード名。
	globalIp	string型	グローバルIP。端末に割り当てられるグローバルIPを示す。
	vrf	string型	VRF。
	tunnelIf	string型	Tunnel IF番号。

レスポンスサンプル

正常終了

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"
        }
    ]
}

拠点詳細取得API

URI

https://api.customer.jp/infoIpoe/v1/customerSites/{customerSiteCode}

HTTPメソッド

GET

レスポンスパラメータ

項目			型	説明
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(Ⅰ型)」もしくは「パートナーCPE(Ⅱ型)」の主商品を購入した場合、「2：CPEアンバンドル」が返ってくる。
	terminalZipcode		string型	端末設置場所　郵便番号。郵便番号はハイフンなしで表示される。
	terminalAddress1		string型	端末設置場所　住所。
	terminalAddress2		string型	端末設置場所　番地以下。
	terminalAddress3		string型	端末設置場所　ビル名　フロア。
	terminalTel		string型	端末設置場所　郵便番号。
	terminalCompanyName		string型	端末設置場所　会社名
	customerSiteNumber		string型	拠点通番。お客様端末の設定に利用する。
	eastOrWest		string型	東西区分。お客様端末の設定に利用する。 CPE区別が「専用CPE付き」の主商品を購入した場合の拠点のみ、この項目が返る。CPE区別が「パートナーCPE(Ⅰ型)」もしくは「パートナーCPE(Ⅱ型)」の主商品を購入した場合の拠点では、この項目は返却されない。
	terminalHostname		string型	CPEホスト名。お客様端末の設定に利用する。 CPE区別が「専用CPE付き」の主商品を購入した場合の拠点のみ、この項目が返る。CPE区別が「パートナーCPE(Ⅰ型)」もしくは「パートナーCPE(Ⅱ型)」の主商品を購入した場合の拠点では、この項目は返却されない。
	terminalDomain		string型	CPEドメイン名。お客様端末の設定に利用する。 CPE区別が「専用CPE付き」の主商品を購入した場合の拠点のみ、この項目が返る。CPE区別が「パートナーCPE(Ⅰ型)」もしくは「パートナーCPE(Ⅱ型)」の主商品を購入した場合の拠点では、この項目は返却されない。
	pponeGwHostname		string型	PP1:GWホスト名。お客様端末の設定に利用する。 CPE区別が「専用CPE付き」の主商品を購入した場合の拠点のみ、この項目が返る。CPE区別が「パートナーCPE(Ⅰ型)」もしくは「パートナーCPE(Ⅱ型)」の主商品を購入した場合の拠点では、この項目は返却されない。
	pponeGwNodename		string型	PP1:GWノード名。お客様端末の設定に利用する。
	pponeGwFqdn		string型	PP1:GW FQDN。お客様端末の設定に利用する。 CPE区別が「専用CPE付き」の主商品を購入した場合の拠点のみ、この項目が返る。CPE区別が「パートナーCPE(Ⅰ型)」もしくは「パートナーCPE(Ⅱ型)」の主商品を購入した場合の拠点では、この項目は返却されない。
	pponeGwTep		string型	PP1:GW TEPアドレス。お客様端末の設定に利用する。 CPE区別が「専用CPE付き」の主商品を購入した場合の拠点のみ、この項目が返る。CPE区別が「パートナーCPE(Ⅰ型)」もしくは「パートナーCPE(Ⅱ型)」の主商品を購入した場合の拠点では、この項目は返却されない。
	pponeGwBgp		string型	PP1:GW BGPアドレス。お客様端末の設定に利用する。 CPE区別が「専用CPE付き」の主商品を購入した場合の拠点のみ、この項目が返る。CPE区別が「パートナーCPE(Ⅰ型)」もしくは「パートナーCPE(Ⅱ型)」の主商品を購入した場合の拠点では、この項目は返却されない。
	pponeGwPreSharedKey		string型	PP1:PreSharedKey。お客様端末の設定に利用する。 CPE区別が「専用CPE付き」の主商品を購入した場合の拠点のみ、この項目が返る。CPE区別が「パートナーCPE(Ⅰ型)」もしくは「パートナーCPE(Ⅱ型)」の主商品を購入した場合の拠点では、この項目は返却されない。
	pptwoGwHostname		string型	PP2:GWホスト名。お客様端末の設定に利用する。 CPE区別が「専用CPE付き」の主商品を購入した場合の拠点のみ、この項目が返る。CPE区別が「パートナーCPE(Ⅰ型)」もしくは「パートナーCPE(Ⅱ型)」の主商品を購入した場合の拠点では、この項目は返却されない。
	pptwoGwNodename		string型	PP2:ノード名。お客様端末の設定に利用する。
	pptwoGwFqdn		string型	PP2:GW FQDN。お客様端末の設定に利用する。 CPE区別が「専用CPE付き」の主商品を購入した場合の拠点のみ、この項目が返る。CPE区別が「パートナーCPE(Ⅰ型)」もしくは「パートナーCPE(Ⅱ型)」の主商品を購入した場合の拠点では、この項目は返却されない。
	pptwoGwTep		string型	PP2:GW TEPアドレス。お客様端末の設定に利用する。 CPE区別が「専用CPE付き」の主商品を購入した場合の拠点のみ、この項目が返る。CPE区別が「パートナーCPE(Ⅰ型)」もしくは「パートナーCPE(Ⅱ型)」の主商品を購入した場合の拠点では、この項目は返却されない。
	pptwoGwBgp		string型	PP2:GW BGPアドレス。お客様端末の設定に利用する。 CPE区別が「専用CPE付き」の主商品を購入した場合の拠点のみ、この項目が返る。CPE区別が「パートナーCPE(Ⅰ型)」もしくは「パートナーCPE(Ⅱ型)」の主商品を購入した場合の拠点では、この項目は返却されない。
	lanLoopback		string型	拠点LAN側Loopback I/Fアドレス。お客様端末の設定に利用する。 CPE区別が「専用CPE付き」の主商品を購入した場合の拠点のみ、この項目が返る。CPE区別が「パートナーCPE(Ⅰ型)」もしくは「パートナーCPE(Ⅱ型)」の主商品を購入した場合の拠点では、この項目は返却されない。
	globalIp		string型	グローバルIP。端末に割り当てられるグローバルIPを示す。お客様端末の設定に利用する。
	vrf		string型	VRF。お客様端末の設定に利用する。
	tunnelIf		string型	Tunnel IF番号。お客様端末の設定に利用する。
	customerSiteContract		配列オブジェクト	拠点に紐づく契約情報を示すオブジェクト。拠点についてどの商品を購入したかを示す。
		customerSiteContractId	integer型	拠点契約ID。
		customerSiteContractCode	string型	拠点契約コード。現状、nullが設定される。
		productCode	string型	商品コード。拠点に対して、どの商品を購入したかを示す。
		productName	string型	商品名。購入した商品の名称を示す。
		productType	integer型	商品種別。現状、「1：主商品」「2：オンサイト保守オプション」が存在する。
		course	string型	コース区別。主商品の場合、「1：法人コース」のみ存在する。オプションの場合、nullが返る。 ※将来的に、この項目がなくなる可能性あり。
		plan	string型	プラン区別。主商品の場合、「1：エントリー(E)」「2：スタンダード(S)」「3：プレミアム(P)」が存在する。オプションの場合、nullが返る。
		ipaddress	string型	IPアドレス区別。主商品の場合、現状、「1：IP1(D)タイプ」「2：IP4タイプ」「5：IP1タイプ」が存在する。オプションの場合、nullが返る。
		cpe	string型	CPE区別。主商品の場合、「1：専用CPE付き」「2：パートナーCPE(Ⅰ型)」、「3：パートナーCPE(Ⅱ型)」が存在する。オプションの場合、nullが返る。
		line	string型	回線区別。主商品の場合、現状、「1：回線アンバンドル」が存在する。オプションの場合、nullが返る。
		chargeStartAt	string型	課金開始日。拠点が開通した日付が設定される。課金開始日の翌月からお客様向けに請求される。
		chargeEndAt	string型	課金終了日。拠点が廃止すると設定される。終了していない場合はnullを返す。
	customerSiteInstallationLocation		オブジェクト	CPEを設置する場所に関する情報を示すオブジェクト。 CPE区別が「専用CPE付き」の主商品を購入した場合の拠点のみ、このオブジェクトが返る。CPE区別が「パートナーCPE(Ⅰ型)」もしくは「パートナーCPE(Ⅱ型)」の主商品を購入した場合の拠点では、このオブジェクトはnullで返る。
		zipCode	string型	郵便番号。
		prefectures	string型	都道府県。
		address	string型	住所。
		companyName	string型	会社名。
		departmentName	string型	部署名。
		clientName	string型	現地担当者。
		tel	string型	電話番号。
	customerSiteLanAddress		オブジェクト	LAN側アドレスに関する情報を示すオブジェクト。 CPE区別が「専用CPE付き」の主商品を購入した場合の拠点のみ、このオブジェクトが返る。CPE区別が「パートナーCPE(Ⅰ型)」もしくは「パートナーCPE(Ⅱ型)」の主商品を購入した場合の拠点では、このオブジェクトはnullで返る。
		lanNetworkAddress	string型	LAN側ネットワークアドレス。
		lanInterfaceAddress	string型	LAN側インターフェースアドレス。
	customerSiteDhcpServerFunction		オブジェクト	DHCPサーバ機能に関する情報を示すオブジェクト。 CPE区別が「専用CPE付き」の主商品を購入した場合の拠点のみ、このオブジェクトが返る。CPE区別が「パートナーCPE(Ⅰ型)」もしくは「パートナーCPE(Ⅱ型)」の主商品を購入した場合の拠点では、このオブジェクトはnullで返る。
		startAddress	string型	開始アドレス。
		endAddress	string型	終了アドレス。
		dns1	string型	DNS1。
		dns2	string型	DNS2。

CPE区別が「専用CPE付き」の主商品を購入した場合、以下のオブジェクトはnullで返ってくる。
- customerSiteInstallationLocation：端末設置場所情報
- customerSiteLanAddress：LANアドレス情報
- 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アドレス

レスポンスサンプル

正常終了（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": "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"
        }
    ]
}

API利用のユースケース

認証から各種APIを利用するまでの流れ

各APIを利用するためには、認証APIによる認証を実行する必要があります。
認証APIで得られた認証トークンを利用し、各APIを利用します。
認証トークンの有効期限は3600秒であるため、ほかのAPIの利用時に再利用できます。

APIによるIPoEインターネットサービス申込の流れ

契約者商品別商品リスト取得APIから、お客様が購入することができる商品リストを取得する必要があります。
商品リストからお客様が購入したい商品を選択し、オーダー登録APIを利用する際に商品情報を設定してください。
オーダー登録APIの処理が正常に終了すると、オーダー番号がレスポンスとして返ってきます。
オーダー番号は他のAPIから取得することはできませんのでご注意ください。

APIによる拠点情報取得からCPE設定までの流れ

拠点が開通しましたら、APIから拠点情報が取得できるようになります。
CPE区別が「パートナーCPE(Ⅰ型)」もしくは「パートナーCPE(Ⅱ型)」の主商品を購入していた場合、この拠点情報にはお客様端末の設定情報が含まれています。
端末情報を設定するユーザがお客様システムへアクセスして、
端末設定情報を入手できるようなユースケースが考えられます。
※CPE区別が「専用CPE付き」の主商品を購入した場合、お客様端末の設定情報は含まれていないため、ご注意ください。

このセクションの記事

はじめに

API仕様

API一覧

共通仕様

プロトコル

暗号化

API方針

APIリクエスト

APIレスポンス

認証API

URI

HTTPメソッド

リクエストパラメータ

リクエストサンプル

レスポンスパラメータ

レスポンスサンプル

アクセストークンについて

契約者別商品リスト取得API

URI

HTTPメソッド

クエリパラメータ

レスポンスパラメータ

レスポンスサンプル

オーダー登録API

URI

HTTPメソッド

ヘッダ

リクエストパラメータ

リクエストサンプル

レスポンスパラメータ

レスポンスサンプル

拠点一覧取得API

URI

HTTPメソッド

クエリパラメータ

レスポンスパラメータ

レスポンスサンプル

拠点詳細取得API

URI

HTTPメソッド

レスポンスパラメータ

レスポンスサンプル

API利用のユースケース

認証から各種APIを利用するまでの流れ

APIによるIPoEインターネットサービス申込の流れ

APIによる拠点情報取得からCPE設定までの流れ

関連記事