認証
Soracom API は API キーと API トークンによる認証を使用します。まず auth/issueToken エンドポイントで認証情報を送信してトークンを取得し、以降のリクエストの Authorization ヘッダーにそのトークンを含めます。
- Soracom コンソールで API キーと API トークンを作成します
- POST /v1/auth で認証し、API トークンを取得します
- 以降のすべてのリクエストに X-Soracom-API-Key と X-Soracom-Token ヘッダーを含めます
ベース URL
Soracom API はグローバルと日本のカバレッジタイプに対応する 2 つのエンドポイントを提供しています。
| カバレッジタイプ | ベース URL |
|---|---|
| グローバルカバレッジ | https://g.api.soracom.io/v1 |
| 日本カバレッジ | https://api.soracom.io/v1 |
ページネーション
リスト系エンドポイントはカーソルベースのページネーションを使用します。レスポンスに含まれる last_evaluated_key を次のリクエストの last_evaluated_key パラメータとして渡すことで、次のページを取得できます。
レート制限
API リクエストにはレート制限が適用されます。制限を超えた場合、HTTP 429 ステータスコードが返されます。Retry-After ヘッダーを参照して、リトライまでの待機時間を確認してください。
エラーハンドリング
Soracom API は標準的な HTTP ステータスコードを返します。エラーレスポンスには code と message フィールドが含まれ、問題の詳細が示されます。
400 — リクエストのパラメータが不正です401 — 認証が必要です、またはトークンが期限切れです403 — このリソースへのアクセス権がありません404 — リソースが見つかりません429 — レート制限を超えました