docomo business SIGN IoTカタログ APIリファレンス (1.0.0)

Download OpenAPI specification:

docomo business SIGN IoTカタログ APIリファレンス

IoTカタログ用API

モバイル回線契約から環境構築まで行うAPI

MAXIV Value(インターネット)注文

MAXIV契約とValue(インターネット)回線契約を行います。

path Parameters

tenantId

required

string = 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters

X-Auth-Token

required

string = 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Request Body schema: application/json

required	object (sim-request) SIM発注申込内容
required	object (maxiv) MAXIV申込内容

Responses

Request samples

Payload

Content type

application/json

{"sim": {"simType": "chip",
"simGrade": "industrial",
"quantity": 20,
"shippingAddressId": "fbfd5c9c6718320e7fdec080b74a7abd"
},
"maxiv": {"companyName": "テスト会社",
"adminEmail": "user@example.com",
"period": 1,
"quantity": 0
}
}

Response samples

202
400
409

Content type

application/json

{"id": "e4eaaaf2d14211e1b3e4080027620cdd"
}

SkyWay Value(インターネット)注文

SkyWay契約とValue(インターネット)回線契約を行います。

path Parameters

tenantId

required

string = 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters

X-Auth-Token

required

string = 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Request Body schema: application/json

required	object (sim-request) SIM発注申込内容
required	object (skyway) SkyWay申込内容

Responses

Request samples

Payload

Content type

application/json

{"sim": {"simType": "chip",
"simGrade": "industrial",
"quantity": 20,
"shippingAddressId": "fbfd5c9c6718320e7fdec080b74a7abd"
},
"skyway": {"email": "user@example.com"
}
}

Response samples

202
400
409

Content type

application/json

{"id": "e4eaaaf2d14211e1b3e4080027620cdd"
}

ThingsCloud Value(インターネット)注文

ThingsCloud環境構築とValue(インターネット)回線契約を行います。

path Parameters

tenantId

required

string = 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters

X-Auth-Token

required

string = 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Request Body schema: application/json

required	object (sim-request) SIM発注申込内容
required	object (thingsCloud-request) ThingsCloud発注申込内容

Responses

Request samples

Payload

Content type

application/json

{"sim": {"simType": "chip",
"simGrade": "industrial",
"quantity": 20,
"shippingAddressId": "fbfd5c9c6718320e7fdec080b74a7abd"
},
"thingsCloud": {"adminEmail": "sampleAdmin@example.com",
"adminName": "sampleAdminName",
"domain": "sample-domain.je1.thingscloud.ntt.com",
"pricePlan": "standard",
"tenantGrade": "basic"
}
}

Response samples

202
400
409

Content type

application/json

{"id": "e4eaaaf2d14211e1b3e4080027620cdd"
}

クラウドサービス Value(インターネット)注文

クラウドサービス Value(インターネット)回線契約を行います。

path Parameters

tenantId

required

string = 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters

X-Auth-Token

required

string = 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Request Body schema: application/json

required

object (sim-request)

SIM発注申込内容

Responses

Request samples

Payload

Content type

application/json

{"sim": {"simType": "chip",
"simGrade": "industrial",
"quantity": 20,
"shippingAddressId": "fbfd5c9c6718320e7fdec080b74a7abd"
}
}

Response samples

202
400
409

Content type

application/json

{"id": "e4eaaaf2d14211e1b3e4080027620cdd"
}

Value(インターネット)注文

Value(インターネット)回線契約を行います。

path Parameters

tenantId

required

string = 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters

X-Auth-Token

required

string = 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Request Body schema: application/json

required

object

SIM発注申込内容

Responses

Request samples

Payload

Content type

application/json

{"sim": {"simType": "chip",
"simGrade": "industrial",
"additionalService": "eSimAppletOta",
"quantity": 20,
"shippingAddressId": "fbfd5c9c6718320e7fdec080b74a7abd"
}
}

Response samples

202
400
409

Content type

application/json

{"id": "e4eaaaf2d14211e1b3e4080027620cdd"
}

Value(閉域)注文

Value(閉域)回線契約とFIC-Connection契約を行います。

path Parameters

tenantId

required

string = 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters

X-Auth-Token

required

string = 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Request Body schema: application/json

required	object SIM発注申込内容
required	Array of objects プロファイル用IPセグメント
required	object (fic-request) FIC-Connection申込内容

Responses

Request samples

Payload

Content type

application/json

{"sim": {"simType": "chip",
"simGrade": "industrial",
"additionalService": "eSimAppletOta",
"quantity": 20,
"shippingAddressId": "fbfd5c9c6718320e7fdec080b74a7abd"
},
"profileActSegment": [{"segment": "10.0.0.0/23"
}
],
"fic": {"name": "SIGN-XXX",
"routerId": "F020123456789",
"bandwidth": "100M"
}
}

Response samples

202
400
409

Content type

application/json

{"id": "e4eaaaf2d14211e1b3e4080027620cdd"
}

PaasなしMEC 注文

Paas接続無しでMNOのSIM発注を行います

path Parameters

tenantId

required

string = 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters

X-Auth-Token

required

string = 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Request Body schema: application/json

required

object (mno-sim-request)

MNO SIM発注申込内容

Responses

Request samples

Payload

Content type

application/json

{"sim": {"mailAddress": "test@example.com",
"orders": {"simGroup": {"simGroupName": "新IoT_JP9_NSA1"
},
"sim": {"plan": "3G",
"planCode": null,
"quantity": 20,
"simType": "nano",
"shippingAddressId": "fbfd5c9c6718320e7fdec080b74a7abd",
"pinCode": "1234",
"options": {"worldWing": false,
"copySending": false
}
}
},
"verification": {"formsId": "string",
"employeeDocument": "string",
"employeeDocumentType": "idCard"
}
}
}

Response samples

202
400
409

Content type

application/json

{"id": "e4eaaaf2d14211e1b3e4080027620cdd"
}

FIC外接MEC 注文

MNO SIM発注とFIC-Connection契約を行います。

path Parameters

tenantId

required

string = 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters

X-Auth-Token

required

string = 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Request Body schema: application/json

required	object (mno-sim-request) MNO SIM発注申込内容
required	object (fic-request) FIC-Connection申込内容

Responses

Request samples

Payload

Content type

application/json

{"sim": {"mailAddress": "test@example.com",
"orders": {"simGroup": {"simGroupName": "新IoT_JP9_NSA1"
},
"sim": {"plan": "3G",
"planCode": null,
"quantity": 20,
"simType": "nano",
"shippingAddressId": "fbfd5c9c6718320e7fdec080b74a7abd",
"pinCode": "1234",
"options": {"worldWing": false,
"copySending": false
}
}
},
"verification": {"formsId": "string",
"employeeDocument": "string",
"employeeDocumentType": "idCard"
}
},
"fic": {"name": "SIGN-XXX",
"routerId": "F020123456789",
"bandwidth": "100M"
}
}

Response samples

202
400
409

Content type

application/json

{"id": "e4eaaaf2d14211e1b3e4080027620cdd"
}

アプリケーション接続MEC 注文

MNO SIM発注とICGW on MEC接続を行います。

path Parameters

tenantId

required

string = 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters

X-Auth-Token

required

string = 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Request Body schema: application/json

required	object (mno-sim-request) MNO SIM発注申込内容
	object (icgwonmec-request) ICGW on MEC 申込内容

Responses

Request samples

Payload

Content type

application/json

{"sim": {"mailAddress": "test@example.com",
"orders": {"simGroup": {"simGroupName": "新IoT_JP9_NSA1"
},
"sim": {"plan": "3G",
"planCode": null,
"quantity": 20,
"simType": "nano",
"shippingAddressId": "fbfd5c9c6718320e7fdec080b74a7abd",
"pinCode": "1234",
"options": {"worldWing": false,
"copySending": false
}
}
},
"verification": {"formsId": "string",
"employeeDocument": "string",
"employeeDocumentType": "idCard"
}
},
"icgw": {"description": "テストクラスタ"
}
}

Response samples

202
400
409

Content type

application/json

{"id": "e4eaaaf2d14211e1b3e4080027620cdd"
}

IoTカタログ注文履歴一覧取得

申込まれた注文の一覧を返却します。

path Parameters

tenantId

required

string = 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

query Parameters

templateType	string Enum: "maxiv_open" "things_cloud_open" "mvno_open" "mvno_closed" "skyway_open" "cloud_service_open" "mec_no_paas" "fic_on_mec" "icgw_on_mec" テンプレート種別
status	string Enum: "processing" "completed" テンプレート種別

header Parameters

X-Auth-Token

required

string = 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

200
400

Content type

application/json

{"orders": [{"id": "e4eaaaf2d14211e1b3e4080027620cdd",
"templateType": "maxiv_open",
"orderedAt": "2024-06-10T06:30:30Z",
"status": "processing"
}
]
}

IoTカタログ注文履歴取得

申込まれた注文の詳細を返却します。

path Parameters

tenantId required	string = 32 characters 0-9a-f Example: 550e8400e29b41d4a716446655440000 テナントID
id required	string^[0-9a-f]{32}$ Example: e4eaaaf2d14211e1b3e4080027620cdd IoTカタログ注文を一意に特定するID

header Parameters

X-Auth-Token

required

string = 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

200
400
404

Content type

application/json

Example

example-maxiv-open

{"id": "e4eaaaf2d14211e1b3e4080027620cdd",
"templateType": "maxiv_open",
"orderedAt": "2024-06-10T06:30:30Z",
"status": "processing",
"orderProgresses": [{"orderName": "create-sim",
"status": "processing",
"linkedOrderId": "ORDER-20200807-0919"
}
],
"request": {"sim": {"simType": "chip",
"simGrade": "industrial",
"quantity": 20,
"shippingAddressId": "fbfd5c9c6718320e7fdec080b74a7abd",
"contractorName": "山田 太郎",
"shippingPostalCode": "100-0004",
"shippingPrefecture": "東京都",
"shippingCity": "千代田区",
"shippingCityAdditionalInfo": null,
"shippingAddress": "大手町2-3-1",
"shippingBuilding": "大手町プレイスウェストタワー31F",
"packageRecipient": "情報システム部 田中太郎",
"packageRecipientCompany": "NTT",
"phoneNumber": "000-0000-0000",
"contractorEmailAddress": "example@ntt.com"
},
"maxiv": {"companyName": "テスト会社",
"adminEmail": "user@example.com",
"period": 1,
"quantity": 0
}
}
}