SIM - IoT Connect Mobile Type S リファレンス (2.0.0)
Download OpenAPI specification:Download
SIM情報参照API Deprecated
SIM情報参照API
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. UUID 形式 |
hsn required | string ^[0-9A-F]{10}$ Example: 013AAF0006 ハードウェアシリアル番号(HSN) |
header Parameters
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: 9dc03494823a841338430052e9ee95e0 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK
Bad Request
Response samples
- 200
- 400
{- "eid": "89033024063202496400000008151710",
- "simGrade": "normal",
- "simType": "hard",
- "simOrderNo": "ORDER-20200807-0913",
- "profileSwitching": true
}
SIM廃止API Deprecated
SIM廃止API
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. UUID 形式 |
hsn required | string ^[0-9A-F]{10}$ Example: 013AAF0006 ハードウェアシリアル番号(HSN) |
header Parameters
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e00 クライアントが Keystone を利用して取得した認証 Token |
Responses
Accepted
Bad Request
Conflict
Response samples
- 202
- 400
- 409
{- "tid": "string"
}
SIMに紐付くProfile一覧参照API Deprecated
SIMに紐付くProfile一覧参照API
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. UUID 形式 |
hsn required | string ^[0-9A-F]{10}$ Example: 013AAF0007 ハードウェアシリアル番号(HSN) |
header Parameters
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e05 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK
Bad Request
Response samples
- 200
- 400
{- "profiles": [
- {
- "imsi": "440130000096015"
}
]
}
SIMへのプロファイル追加API Deprecated
SIMへのプロファイル追加API
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. UUID 形式 |
hsn required | string ^[0-9A-F]{10}$ Example: 013AAF0007 ハードウェアシリアル番号(HSN) |
header Parameters
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e06 クライアントが Keystone を利用して取得した認証 Token |
Request Body schema: application/json
SIMへのプロファイル追加APIのリクエストBody
hsn required | string 10 characters ハードウェアシリアル番号(HSN) |
imsi required | string <= 15 characters International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。 |
Responses
Accepted
Bad Request
Conflict
Request samples
- Payload
{- "hsn": "013AAA0025",
- "imsi": "440130000096016"
}
Response samples
- 202
- 400
- 409
{- "tid": "tran-20201105-20623",
- "requestBody": {
- "hsn": "013AAA0025",
- "imsi": "440130000096016"
}
}
SIM発注API Deprecated
SIMを発注するAPI
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. UUID 形式 |
header Parameters
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e03 クライアントが Keystone を利用して取得した認証 Token |
Request Body schema: application/json
SIMを発注するAPIのリクエストBody
simGroupId required | string ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ SIMグループID |
simType required | string Enum: "chip" "hard" SIM種別 chip:チップSIM, hard:ハードSIM |
simGrade required | string Enum: "industrial" "normal" SIMグレード ( Industrial:インダストリアル normal:ノーマル ) |
provider required | string Enum: "nttc" "tsl" "nttcTsl" HPLMN(Home Public Land Mobile Network)を提供する事業者。 |
profileSwitching required | boolean eSIM切替機能 ※NTTCOMプロファイル以外はtrue固定 |
quantity required | integer [ 1 .. 20000 ] SIM枚数(simTypeが"chipSim"の場合は500-20000, simTypeがhardSimの場合は1-20000) |
contractorName required | string 契約者氏名 |
contractorCompany | string Deprecated 契約者事業者名 |
shippingPostalCode required | string 宛先郵便番号 |
shippingPrefecture required | string 宛先都道府県 |
shippingCity required | string 宛先市区郡町村 |
shippingCityAdditionalInfo | string 宛先大字通称など(省略可) |
shippingAddress required | string 宛先町番地 |
shippingBuilding required | string 宛先ビル名等 |
packageRecipient required | string 宛先氏名 |
packageRecipientCompany | string 発送先会社名 |
phoneNumber required | string 宛先電話番号 |
contractorEmailAddress required | string ^[a-zA-Z0-9.!#$%&''*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)+$ 契約者メールアドレス |
additionalService | string Enum: "eSimSecurity" "eSimAppletOta" "eSimAppletIta" SIM付加サービス |
Responses
Accepted
Bad Request
Request samples
- Payload
{- "simGroupId": "c634dd4f-8e49-4f20-a8fc-99cb6386e699",
- "simType": "hard",
- "simGrade": "normal",
- "provider": "nttc",
- "profileSwitching": false,
- "quantity": 20,
- "contractorName": "山田 太郎",
- "shippingPostalCode": "100-0004",
- "shippingPrefecture": "東京都",
- "shippingCity": "千代田区",
- "shippingAddress": "大手町2-3-1",
- "shippingBuilding": "大手町プレイスウェストタワー31F",
- "packageRecipient": "情報システム部 田中太郎",
- "packageRecipientCompany": "NTT",
- "phoneNumber": "000-0000-0000",
- "contractorEmailAddress": "shuhei49@example.org",
- "additionalService": "eSimSecurity"
}
Response samples
- 202
- 400
{- "tid": "ORDER-20200807-0919",
- "requestBody": {
- "simGroupId": "c634dd4f-8e49-4f20-a8fc-99cb6386e699",
- "simType": "hard",
- "simGrade": "normal",
- "provider": "nttc",
- "profileSwitching": false,
- "quantity": 20,
- "contractorName": "山田 太郎",
- "shippingPostalCode": "100-0004",
- "shippingPrefecture": "東京都",
- "shippingCity": "千代田区",
- "shippingAddress": "大手町2-3-1",
- "shippingBuilding": "大手町プレイスウェストタワー31F",
- "packageRecipient": "情報システム部 田中太郎",
- "packageRecipientCompany": "NTT",
- "phoneNumber": "000-0000-0000",
- "contractorEmailAddress": "example@ntt.com",
- "additionalService": "eSimSecurity"
}
}
SIMを休止するAPI Deprecated
SIMを休止状態にするAPI
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. UUID 形式 |
hsn required | string ^[0-9A-F]{10}$ Example: 013AAF0007 ハードウェアシリアル番号(HSN) |
header Parameters
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e03 クライアントが Keystone を利用して取得した認証 Token |
Request Body schema: application/json
SIMを休止状態にするAPIのリクエストBody
hsn required | string 10 characters ハードウェアシリアル番号(HSN) |
imsi | string <= 15 characters International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。マルチアクセスSIMの場合のみ指定可能。 |
Responses
Accepted
Bad Request
Conflict
Request samples
- Payload
{- "hsn": "013AAA0025"
}
Response samples
- 202
- 400
- 409
{- "tid": "tran-20200807-00005",
- "requestBody": {
- "hsn": "013AAA0025"
}
}
SIMを再開するAPI Deprecated
休止状態のSIMを再開させるAPI
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. UUID 形式 |
hsn required | string ^[0-9A-F]{10}$ Example: 013AAF0007 ハードウェアシリアル番号(HSN) |
header Parameters
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e00 クライアントが Keystone を利用して取得した認証 Token |
Request Body schema: application/json
SIMを再開するAPIのリクエストBody
hsn required | string 10 characters ハードウェアシリアル番号(HSN) |
imsi | string <= 15 characters International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。マルチアクセスSIMの場合のみ指定可能。 |
Responses
Accepted
Bad Request
Conflict
Request samples
- Payload
{- "hsn": "013AAA0025"
}
Response samples
- 202
- 400
- 409
{- "tid": "tran-20200807-00005",
- "requestBody": {
- "hsn": "013AAA0025"
}
}
プロファイルを同期するAPI Deprecated
eSIMのプロファイルを同期するAPI
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. UUID 形式 |
hsn required | string ^[0-9A-F]{10}$ Example: 013AAF0007 ハードウェアシリアル番号(HSN) |
header Parameters
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e00 クライアントが Keystone を利用して取得した認証 Token |
Request Body schema: application/json
eSIMのプロファイルを同期するAPIのリクエストBody
hsn required | string ハードウェアシリアル番号(HSN) |
Responses
Accepted
Bad Request
Conflict
Request samples
- Payload
{- "hsn": "013AAA0025"
}
Response samples
- 202
- 400
- 409
{- "tid": "tran-20200807-00004",
- "requestBody": {
- "hsn": "013AAA0025"
}
}
保存したSIM送付先住所を取得するAPI Deprecated
保存したSIM送付先住所を取得するAPI
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. UUID 形式 |
header Parameters
X-Auth-Token required | string クライアントが Keystone を利用して取得した認証 Token |
Responses
OK
Bad Request
Response samples
- 200
- 400
{- "shippingAddresses": [
- {
- "contractorName": "山田 太郎",
- "shippingPostalCode": "100-0004",
- "shippingPrefecture": "東京都",
- "shippingCity": "千代田区",
- "shippingAddress": "大手町2-3-1",
- "shippingBuilding": "大手町プレイスウェストタワー31F",
- "packageRecipient": "情報システム部 田中太郎",
- "packageRecipientCompany": "NTT",
- "phoneNumber": "000-0000-0000",
- "contractorEmailAddress": "hoge@example.com"
}
]
}
SIM送付先住所を保存/更新するAPI Deprecated
SIM送付先住所を保存/更新するAPI
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. UUID 形式 |
header Parameters
X-Auth-Token required | string クライアントが Keystone を利用して取得した認証 Token |
Request Body schema: application/json
contractorName required | string 契約者氏名 |
contractorCompany | string Deprecated 契約者事業者名 |
shippingPostalCode required | string 宛先郵便番号 |
shippingPrefecture required | string 宛先都道府県 |
shippingCity required | string 宛先市区郡町村 |
shippingCityAdditionalInfo | string 宛先大字通称など(省略可) |
shippingAddress required | string 宛先町番地 |
shippingBuilding required | string 宛先ビル名等 |
packageRecipient required | string 部署名・担当者名 |
packageRecipientCompany | string 発送先会社名 |
phoneNumber required | string 宛先電話番号 |
contractorEmailAddress required | string <email> 契約者メールアドレス |
Responses
OK
Bad Request
Request samples
- Payload
{- "contractorName": "山田 太郎",
- "shippingPostalCode": "100-0004",
- "shippingPrefecture": "東京都",
- "shippingCity": "千代田区",
- "shippingAddress": "大手町2-3-1",
- "shippingBuilding": "大手町プレイスウェストタワー31F",
- "packageRecipient": "山田 太郎",
- "packageRecipientCompany": "NTT",
- "phoneNumber": "000-0000-0000",
- "contractorEmailAddress": "hoge@example.com"
}
Response samples
- 400
{- "message": "Bad Request",
- "detail": "path parameter 'tenantId' is invalid"
}
EIS情報を取得するAPI Deprecated
EIS情報を取得するAPI
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. UUID 形式 |
hsn required | string ^[0-9A-F]{10}$ Example: 013AAF0007 ハードウェアシリアル番号(HSN) |
header Parameters
X-Auth-Token required | string クライアントが Keystone を利用して取得した認証 Token |
Responses
OK
Bad Request
Response samples
- 200
- 400
全SIM/profile情報を取得するAPI Deprecated
全SIM/profile情報を取得するAPI
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. UUID 形式 |
query Parameters
limit | integer [ 0 .. 1000 ] 全体で見てプロファイルを最大で何件返すか。指定なしで全件返す |
offset | integer >= 0 全体で見て何件目から返すか。デフォルト0 |
header Parameters
X-Auth-Token required | string クライアントが Keystone を利用して取得した認証 Token |
Responses
OK
Bad Request
Response samples
- 200
- 400
{- "sims": [
- {
- "hsn": "013AAA0026",
- "eid": "89033024063202496400000008151710",
- "simOrderNo": "ORDER-20200807-0913",
- "simType": "hard",
- "simGrade": "normal",
- "profileSwitching": false,
- "simGroupName": "default",
- "profiles": [
- {
- "imsi": "440130000096018",
- "iccid": "8981120000000830189",
- "msisdn": "812023284117111",
- "provider": "nttc",
- "profileStatus": "suspend",
- "esimStatus": "enabled",
- "plan": "fixed",
- "limit": null,
- "totalLimit": null,
- "upLimit": 1048576,
- "totalUpLimit": 1048576,
- "downLimit": 1048576,
- "puk1": "53946056",
- "puk2": "53946056",
- "cn": false,
- "actIpAddress": null,
- "sbyIpAddress": null,
- "upStream": true,
- "icgw": false,
- "icgwInProgress": false,
- "icgwEastIpAddress": null,
- "icgwWestIpAddress": null,
- "dedicatedPlan": false,
- "shareGroupName": "グループA",
- "testMode": true,
- "enabledAt": "2020-07-07",
- "testModeEndedAt": null,
- "shareGroupLeftAt": null,
- "globalStaticIpAddress": null,
- "billingSpan": null,
- "expDate": null,
- "multiAccess": false
}
], - "additionalService": null,
- "oemEncKey": null,
- "oemMacKey": null,
- "oemKekKey": null
}, - {
- "hsn": "013AAA0027",
- "eid": "89033024063202496400000008151709",
- "simOrderNo": "ORDER-20200807-0912",
- "simType": "hard",
- "simGrade": "normal",
- "profileSwitching": true,
- "simGroupName": "default",
- "profiles": [
- {
- "imsi": "440130000096018",
- "iccid": "8981120000000830189",
- "msisdn": "812023284117111",
- "provider": "nttc",
- "profileStatus": "suspend",
- "esimStatus": "enabled",
- "plan": "payg",
- "limit": 10240,
- "totalLimit": 10240,
- "upLimit": null,
- "totalUpLimit": null,
- "downLimit": null,
- "puk1": "53946057",
- "puk2": "53946057",
- "cn": true,
- "actIpAddress": "10.0.0.5",
- "sbyIpAddress": "10.0.1.6",
- "upStream": false,
- "icgw": false,
- "icgwInProgress": false,
- "icgwEastIpAddress": null,
- "icgwWestIpAddress": null,
- "dedicatedPlan": false,
- "shareGroupName": null,
- "testMode": null,
- "enabledAt": "2020-07-07",
- "testModeEndedAt": null,
- "shareGroupLeftAt": null,
- "globalStaticIpAddress": null,
- "billingSpan": null,
- "expDate": null,
- "multiAccess": false
}, - {
- "imsi": "440130000096018",
- "iccid": "8981120000000830189",
- "msisdn": "812023284117111",
- "provider": "nttc",
- "profileStatus": "suspend",
- "esimStatus": "enabled",
- "plan": "fixed",
- "limit": 10240,
- "totalLimit": 10240,
- "upLimit": null,
- "totalUpLimit": null,
- "downLimit": null,
- "puk1": "53946056",
- "puk2": "53946056",
- "cn": false,
- "actIpAddress": null,
- "sbyIpAddress": null,
- "upStream": false,
- "icgw": true,
- "icgwInProgress": false,
- "icgwEastIpAddress": "10.96.0.1",
- "icgwWestIpAddress": "10.224.0.1",
- "dedicatedPlan": false,
- "shareGroupName": "グループB",
- "testMode": false,
- "enabledAt": "2020-07-07",
- "testModeEndedAt": "2020-07-26",
- "shareGroupLeftAt": "2020-07-26",
- "globalStaticIpAddress": null,
- "billingSpan": null,
- "expDate": null,
- "multiAccess": false
}
], - "additionalService": "eSimSecurity",
- "oemEncKey": "89033024063202a96400000008151710",
- "oemMacKey": "89033024063202b96400000008151711",
- "oemKekKey": "89033024063202c96400000008151712"
}
], - "total": 3
}
利用可能なSIM付加サービスを表示するAPI Deprecated
利用可能なSIM付加サービスを表示するAPI
path Parameters
tenantId required | string SDPFのテナントに一意に与えられる ID. UUID 形式 |
Responses
OK
Bad Request
Response samples
- 200
- 400
{- "additionalServices": [
- "eSimSecurity",
- "eSimAppletOta",
- "eSimAppletIta"
]
}