Soracom

Users

開発者向けツール

カバレッジタイプ

SORACOM プラットフォームは、主に SIM カードの使えるエリアの違いにより、カバレッジタイプという概念を導入しています。また、各サービスの接続拠点として使われる場所を ランデブーポイント と呼びます。

現時点では、以下の 2 種類のカバレッジタイプが用意されています。

  1. カバレッジタイプ Japan

    SORACOM Air の日本でのサービス開始当初からご提供している SIM で利用可能なカバレッジタイプです。 SIM は日本国内においてのみ利用可能です。ランデブーポイントは Tokyo で、Canal/Direct/Door/Gate といったプライベート接続サービスは AWS 東京リージョン (ap-northeast1) で接続されます。 Beam/Funnel の接続元も AWS 東京リージョンとなります。

  2. カバレッジタイプ Global

    カバレッジタイプ Global の SIM は、世界の140を超える国や地域で利用可能です。 現時点でランデブーポイントは東京 (日本)、オレゴン (米国)、フランクフルト (ドイツ) があります。 Canal/Direct/Door/Gate のプライベート接続サービスや Beam/Funnel の接続元は AWS 東京リージョン (ap-northeast-1)、AWS オレゴンリージョン (us-west-2) , または、AWS フランクフルトリージョン (eu-central-1) で接続されます。

それぞれのカバレッジタイプ用に個別の API エンドポイントがありますので、操作対象のカバレッジタイプに応じて適切な API エンドポイントを使用してください。

  • カバレッジタイプ Japan の API を呼び出すには以下のいずれかの API エンドポイントを使用します。どちらを呼び出しても効果は同じです。
  • カバレッジタイプ Global の API を呼び出すには以下の API エンドポイントを使用します。

カバレッジタイプ Japan および Global どちらの API エンドポイントでもアカウントのパスワード認証が可能で、取得された API Key や API Token はどちらのエンドポイントに対しても利用可能です。すなわち、API を呼び出したいアカウントがどちらのカバレッジタイプに対応したものか事前にわからなくても、アカウントの認証を行うことができます。

認証の結果得られた API Token には、そのアカウントで利用できるカバレッジタイプの情報が含まれています。API Token (JWT 形式) の Payload の Private claim operator.coverageType の内容を参照してください。

例えば、JavaScript で API Token からカバレッジタイプを取り出す際のコード例は以下のとおりです。

// token には /v1/auth API からのレスポンスに含まれる API Token の文字列が入っています
var parts = token.split('.');
var claims = JSON.parse(atob(unescape(encodeURIComponent(parts[1]))));
console.log(claims.operator.coverageTypes);
// => ["jp","g"]

operator.coverageTypes は、上の例のように文字列の配列形式で格納されています。

  • jp: カバレッジタイプ Japan に対応しています。
  • g: カバレッジタイプ Global に対応しています。
このガイドで紹介するコードはあくまでサンプルです。実際のシステムで API Token を利用する際には API Token の署名の検証を行ってください。また、エラー処理も正しく行ってください。