Soracom

SORACOM API (以下、API) を呼び出す際は、API キーと API トークンが必要です。これらの情報は、他人に知られないよう秘密にしてください。

API キーと API トークンを発行する

Auth:auth API を呼び出して認証を行い、API キーと API トークンを発行します。なお、SAM ユーザーとして API を呼び出す場合と、ルートユーザーとして API を呼び出す場合では、API キーと API トークンを発行するために指定する情報が異なります。

• SAM ユーザーの API キーと API トークンを発行する
• ルートユーザーの API キーと API トークンを発行する

なお、ルートユーザーと SAM ユーザーの違いについては、ルートユーザーと SAM ユーザー を参照してください。

SAM ユーザーの API キーと API トークンを発行する

SAM ユーザーとして API を呼び出す場合は、SAM ユーザーに API を呼び出すための権限を設定し、以下のいずれかの方法で Auth:auth API を呼び出して API キーと API トークンを発行します。権限設定について詳しくは、SAM ユーザーの権限を設定する を参照してください。

• 認証キー ID、および認証キーシークレットを使用して認証する。

  SAM ユーザーの認証キー ID、および認証キーシークレットを発行する手順について詳しくは、認証キーを生成する を参照してください。

  $ curl -X POST https://api.soracom.io/v1/auth \
  -H "Content-Type: application/json" \
  -d '{
    "authKeyId": "keyId-xxxxxxx",
    "authKey": "secret-xxxxxxx"
  }'
  
  # Response:
  # 200 OK
  #
  # {
  #   "apiKey": "API キー",
  #   "operatorId": "オペレーター ID",
  #   "userName": "SAM ユーザー名",
  #   "token": "API トークン"
  # }
  

• オペレーター ID、SAM ユーザー名、およびコンソールログインパスワードを使用して認証する。

  curl -X POST https://api.soracom.io/v1/auth \
  -H "Content-Type: application/json" \
  -d '{
    "operatorId": "オペレーター ID",
    "userName": "SAM ユーザー名",
    "password": "コンソールログインパスワード"
  }'
  
  # Response:
  # 200 OK
  #
  # {
  #   "apiKey": "API キー",
  #   "operatorId": "オペレーター ID",
  #   "userName": "SAM ユーザー名",
  #   "token": "API トークン"
  # }
  

ルートユーザーの API キーと API トークンを発行する

ルートユーザーとして API を呼び出す場合は、Auth:auth API を呼び出して API キーと API トークンを発行します。

• 認証キー ID、および認証キーシークレットを使用して認証する。

• メールアドレス、およびパスワードを使用して認証する。

  $ curl -X POST https://api.soracom.io/v1/auth \
  -H "Content-Type: application/json" \
  -d '{
    "email": "email@example.com",
    "password": "superStrongPassw0rd"
  }'
  
  # Response:
  # 200 OK
  #
  # {
  #   "apiKey": "API キー",
  #   "operatorId": "オペレーター ID",
  #   "token": "API トークン"
  # }
  

API キーと API トークンを無効化する

API の呼び出しが終わったら、Auth:logout API を呼び出して API キーと API トークンを無効化してください。

$ curl -X POST https://api.soracom.io/v1/auth/logout \
-H "X-Soracom-API-Key: $X_SORACOM_API_KEY" \
-H "X-Soracom-Token: $X_SORACOM_TOKEN"

API キーと API トークンを無効化すると

無効化された API キーと API トークンを利用して、API を呼び出すことはできません。

• SORACOM API を呼び出した場合: Invalid API key エラーが返されます。
• SORACOM CLI を実行した場合:
  • soracom sims list などのコマンドを実行するたびに API キーと API トークンを取得する仕組みです。つまり、1 回発行された API キーと API トークンは再利用されないため、API キーと API トークンを無効化しても、無効化する前と変わらずに SORACOM CLI を実行できます。
  • API キーと API トークンの発行頻度を減らす の説明のように API キーと API トークンを再利用しているときは、Invalid API key エラーが返されます。
• ユーザーコンソールにログインしている場合: API キーと API トークンが無効化されたユーザーが操作すると、ログイン画面に戻されます。