SIMS - IoT Connect Mobile Type S リファレンス (2.0.0)

Download OpenAPI specification:Download

概要

本APIでは、IoT Connect Mobile Type S に関するリソースの参照・操作が可能です。

sims

SIMに関する API

SIM情報参照API

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

200

OK

400

Bad Request

get/tenants/{tenantId}/sims/{hsn}
https://api.ntt.com/icms-esim/v2/tenants/{tenantId}/sims/{hsn}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "eid": "89033024063202496400000008151710",
  • "simGrade": "normal",
  • "simType": "hard",
  • "simOrderNo": "ORDER-20200807-0913",
  • "profileSwitching": true
}

SIM廃止API

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

202

Accepted

400

Bad Request

409

Conflict

delete/tenants/{tenantId}/sims/{hsn}
https://api.ntt.com/icms-esim/v2/tenants/{tenantId}/sims/{hsn}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "tid": "string"
}

SIMに紐付くProfile一覧参照API

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

200

OK

400

Bad Request

get/tenants/{tenantId}/sims/{hsn}/profiles
https://api.ntt.com/icms-esim/v2/tenants/{tenantId}/sims/{hsn}/profiles

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "profiles":
    [
    ]
}

SIMへのプロファイル追加API

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

202

Accepted

400

Bad Request

409

Conflict

post/tenants/{tenantId}/sims/{hsn}/profiles
https://api.ntt.com/icms-esim/v2/tenants/{tenantId}/sims/{hsn}/profiles

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "hsn": "013AAA0025",
  • "imsi": "440130000096016"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "tid": "tran-20201105-20623",
  • "requestBody":
    {
    }
}

SIM発注API

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 ^(normal|industrial)
Enum: "industrial" "normal"

SIMグレード ( Industrial:インダストリアル normal:ノーマル )

provider
required
string ^(nttc|tsl)
Enum: "nttc" "tsl"

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
required
string

契約者事業者名

shippingPostalCode
required
string

宛先郵便番号

shippingPrefecture
required
string

宛先都道府県

shippingCity
required
string

宛先市区郡町村

shippingCityAdditionalInfo
string

宛先大字通称など(省略可)

shippingAddress
required
string

宛先町番地

shippingBuilding
required
string

宛先ビル名等

packageRecipient
required
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])?)+$

契約者メールアドレス

Responses

202

Accepted

400

Bad Request

post/tenants/{tenantId}/sims
https://api.ntt.com/icms-esim/v2/tenants/{tenantId}/sims

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "simGroupId": "c634dd4f-8e49-4f20-a8fc-99cb6386e699",
  • "simType": "hard",
  • "simGrade": "industrial",
  • "provider": "tsl",
  • "profileSwitching": true,
  • "quantity": 20,
  • "contractorName": "山田 太郎",
  • "contractorCompany": "NTTコミニケーションズ",
  • "shippingPostalCode": "100-0004",
  • "shippingPrefecture": "東京都",
  • "shippingCity": "千代田区",
  • "shippingAddress": "大手町2-3-1",
  • "shippingBuilding": "大手町プレイスウェストタワー31F",
  • "packageRecipient": "山田 太郎",
  • "phoneNumber": "000-0000-0000",
  • "contractorEmailAddress": "shuhei49@example.org"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "tid": "ORDER-20200807-0919",
  • "requestBody":
    {
    }
}

SIMを休止するAPI

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)

Responses

202

Accepted

400

Bad Request

409

Conflict

put/tenants/{tenantId}/sims/{hsn}/deActive
https://api.ntt.com/icms-esim/v2/tenants/{tenantId}/sims/{hsn}/deActive

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "hsn": "013AAA0025"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "tid": "tran-20200807-00005",
  • "requestBody":
    {
    }
}

SIMを再開するAPI

休止状態の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)

Responses

202

Accepted

400

Bad Request

409

Conflict

put/tenants/{tenantId}/sims/{hsn}/reActive
https://api.ntt.com/icms-esim/v2/tenants/{tenantId}/sims/{hsn}/reActive

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "hsn": "013AAA0025"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "tid": "tran-20200807-00005",
  • "requestBody":
    {
    }
}

プロファイルを同期するAPI

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

202

Accepted

400

Bad Request

409

Conflict

put/tenants/{tenantId}/sims/{hsn}/audit
https://api.ntt.com/icms-esim/v2/tenants/{tenantId}/sims/{hsn}/audit

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "hsn": "013AAA0025"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "tid": "tran-20200807-00004",
  • "requestBody":
    {
    }
}

保存したSIM送付先住所を取得するAPI

保存した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

200

OK

400

Bad Request

get/tenants/{tenantId}/sims/shipping/address
https://api.ntt.com/icms-esim/v2/tenants/{tenantId}/sims/shipping/address

Response samples