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

Download OpenAPI specification:Download

本ページでは、 IoT Connect Mobile Type S の API の概要と利用方法をご覧いただけます。関係する機能と API のエンドポイントは以下の3つです。

(SDPF 共通) Keystone: 全ての API の認証機能を提供する。エンドポイント: https://api.ntt.com/keystone
(SDPF 共通) 管理機能: ユーザやテナント等の管理機能を提供する。エンドポイント: https://api.ntt.com/sss
IoT Connect Mobile Type S: 本サービスの管理機能を提供する。エンドポイント: https://api.ntt.com/icms-esim 本ページではそれぞれについて説明します。

(SDPF 共通) API の認証機能

API へのアクセスには認証 Token 及び API 鍵 / API 秘密鍵の取得が必要です。以下のページを参考にご準備ください。

APIコールの基礎について
Flexible InterConnect APIの利用開始 IoT Connect Mobile Type Sでは定期的な API 鍵、 API 秘密鍵の更新を推奨しております。以下の手順を参考にご計画の上、 API 鍵更新を実施してください。
各種情報の確認とAPI鍵の更新

ユーザやテナント等、 Smart Data Platform 全体にかかる管理機能を提供するサービスです。ご利用方法の詳細は以下のページをご参照ください。

本ページでは SIM情報取得API の仕様を詳細に記述しています。認証の準備が整ったら、試しにこの API を動作確認されることをおすすめします。また、本 API は以下の点に注意してご利用ください。

SIM情報を扱う API

tenantId required	string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. UUID 形式
hsn required	string ^[0-9A-F]{10}$ Example: 013AAF0007 ハードウェアシリアル番号(HSN)

X-Auth-Token

required

string ^[0-9a-f]{32}$

Example: 9dc03494823a841338430052e9ee95e0

クライアントが Keystone を利用して取得した認証 Token

200

400

Bad Request

get/tenants/{tenantId}/sims/{hsn}

http://api.ntt.com/icms-esim/tenants/{tenantId}/sims/{hsn}

Content type

application/json

Copy

Expand all Collapse all


{"eid": "89033024063202496400000008151710",
"simGrade": "normal",
"simType": "hard",
"simOrderNo": "ORDER-20200807-0913",
"profileSwitching": true
}