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

1.はじめに

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

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

2.API仕様

2.1API一覧

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

＃	API種別	利用用途
1	認証API	APIを利用するための認証を行う。本APIで取得したトークン情報をその他のAPIにて認証情報として利用する。
2	契約者別商品リスト取得API	お客様が購入することができる商品リストを取得する。本APIにて取得できる商品はPC社への申込時に申込書に記述した商品に限る。本APIで取得した商品リストから購入したい商品情報をオーダ登録APIにて利用する。
3	オーダ登録API	IPoEインターネットサービスを利用するための新規オーダ登録、および利用終了するための廃止オーダ登録を実施する。新規オーダが進捗し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

API仕様については以下をご参照ください。

API仕様書.pdf
5 MB Download

このセクションの記事

カスタマーコントロール　API仕様書

1.はじめに

2.API仕様

2.1API一覧

2.2.共通仕様

2.2.1.プロトコル

2.2.2.暗号化

2.2.3.APIリクエスト

2.2.4.APIレスポンス

2.3.認証API

コメント

このセクションの記事

1.はじめに

2.API仕様

2.1API一覧

2.2.共通仕様

2.2.1.プロトコル

2.2.2.暗号化

2.2.3.APIリクエスト

2.2.4.APIレスポンス

2.3.認証API

関連記事