docomo business SIGN IoTカタログAPIリファレンス (1.0.0)
Download OpenAPI specification:Download
docomo business SIGN IoTカタログ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
| sim required | object (sim-request) |
| maxiv required | object (maxiv) |
Responses
202
Accepted.
400
Bad Request
409
Conflict
500
Internal Server Error
post/tenants/{tenantId}/market-place/open/maxiv
https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/market-place/open/maxiv
Request samples
- Payload
Content type
application/json
Copy
Expand all Collapse all {- "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
Copy
Expand all Collapse all {- "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
| sim required | object (sim-request) |
| skyway required | object (skyway) |
Responses
202
Accepted.
400
Bad Request
409
Conflict
500
Internal Server Error
post/tenants/{tenantId}/market-place/open/skyway
https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/market-place/open/skyway
Request samples
- Payload
Content type
application/json
Copy
Expand all Collapse all {- "sim": {
- "simType": "chip",
- "simGrade": "industrial",
- "quantity": 20,
- "shippingAddressId": "fbfd5c9c6718320e7fdec080b74a7abd"
}, - "skyway": {
- "email": "user@example.com"
}
}Response samples
- 202
- 400
- 409
Content type
application/json
Copy
Expand all Collapse all {- "id": "e4eaaaf2d14211e1b3e4080027620cdd"
}Things Cloud Value(インターネット)注文
Things Cloud環境構築と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
| sim required | object (sim-request) |
| thingsCloud required | object (thingsCloud-request) |
Responses
202
Accepted.
400
Bad Request
409
Conflict
500
Internal Server Error
post/tenants/{tenantId}/market-place/open/things-cloud
https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/market-place/open/things-cloud
Request samples
- Payload
Content type
application/json
Copy
Expand all Collapse all {- "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
Copy
Expand all Collapse all {- "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
| sim required | object (sim-request) |
Responses
202
Accepted.
400
Bad Request
409
Conflict
500
Internal Server Error
post/tenants/{tenantId}/market-place/open/mvno
https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/market-place/open/mvno
Request samples
- Payload
Content type
application/json
Copy
Expand all Collapse all {- "sim": {
- "simType": "chip",
- "simGrade": "industrial",
- "quantity": 20,
- "shippingAddressId": "fbfd5c9c6718320e7fdec080b74a7abd"
}
}Response samples
- 202
- 400
- 409
Content type
application/json
Copy
Expand all Collapse all {- "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
| sim required | object (sim-request) |
| profileActSegment required | Array of objects プロファイル用IPセグメント |
| fic required | object (fic-request) |
Responses
202
Accepted.
400
Bad Request
409
Conflict
500
Internal Server Error
post/tenants/{tenantId}/market-place/closed/mvno
https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/market-place/closed/mvno
Request samples
- Payload
Content type
application/json
Copy
Expand all Collapse all {- "sim": {
- "simType": "chip",
- "simGrade": "industrial",
- "quantity": 20,
- "shippingAddressId": "fbfd5c9c6718320e7fdec080b74a7abd"
}, - "profileActSegment": [
- {
- "segment": "10.0.0.0/23"
}
], - "fic": {
- "name": "newIoT-XXX",
- "routerId": "F020123456789",
- "bandwidth": "100M"
}
}Response samples
- 202
- 400
- 409
Content type
application/json
Copy
Expand all Collapse all {- "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" テンプレート種別 |
| status | string Enum: "processing" "completed" テンプレート種別 |
header Parameters
| X-Auth-Token required | string 32 characters 0-9a-f Example: 098e5cb2b91c4b63a64e47dfe17a5f76 ログイン時に取得するIDトークン |
Responses
200
OK
400
Bad Request
500
Internal Server Error
get/tenants/{tenantId}/market-place/orders
https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/market-place/orders
Response samples
- 200
- 400
Content type
application/json
Copy
Expand all Collapse all {- "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
200
OK
400
Bad Request
404
Not Found
500
Internal Server Error
get/tenants/{tenantId}/market-place/orders/{id}
https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/market-place/orders/{id}
Response samples
- 200
- 400
- 404
Content type
application/json
Example
example-maxiv-open
Copy
Expand all Collapse all {- "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
}
}
}