投稿日

ソラコム公式ドキュメントの歩き方

みなさん、こんにちは。

ソラコムではサービスの拡張だけではなく、Web サイトやドキュメントも日々更新しています。すべての人にわかりやすく、、というのはなかなか難しいのですが、ソラコムのサービスや事例など、必要な情報を必要な方に正しくお伝えできるように心がけています。
そこで、今日はソラコム公式ドキュメントの歩き方をご紹介します！

ソラコムでは公式サイトとして、以下の2つがあります。

soracom.jp は IoT やソラコムという名前は知っているけど、もっと詳しく知りたいという方を対象に、dev.soracom.io はソラコムのユーザーを対象としています。
もちろん、両方とも限定しているわけではありませんので、気になる記事があればご覧いただけると幸いです。

事例をみよう！

ソラコムの Web サイト soracom.jp には技術的な説明だけでなく、IoTの事例もたくさんあります。Web だけで40の事例が掲載されています。(2019年11月時点）

事例はこちらからご覧いただけます。最新の事例はもとより、業界毎や使用しているSORACOMのサービスにあった事例を探すことができます。

さらに、事例がまとまったPDFも用意しています。

こちらの事例集にはシステム構成図もあるので、より詳しく学ぶことができます。

やや技術よりなドキュメント

事例をご覧いただきワクワクしたところで、次はやや技術よりなドキュメントをご紹介します。IoTシステムを構築するにあたって、「これまでの技術やシステムとなにが異なるのか？」という点を知っておくのは大事なことだと考えています。

まずは、セルラーベストプラクティスガイドをご覧ください。当ガイドでは、以下のような形で、IoTシステム設計のポイントを挙げています。

  • ポイント1:ネットワーク切断や通信速度低下に常に備える！
  • ポイント2:設置環境に合わせたデバイスを選定する！
  • ポイント3:セルラー通信は公共の電波を使っていることを考慮する！

さらには、リファレンスアーキテクチャーを提供しています。ここでは、よくあるIoTシステムのシステム構成を紹介しています。



たとえば、遠隔監視用ウェブカメラの管理システムはこのような形で、利点、応用例、技術的な解説をまとめています。

こちらも IoT システムを検討する際の参考になれば幸いです！そして、ソラコムのご利用を開始する際はこちらをご確認ください。

ソラコムユーザー向けのガイド

そして、ユーザーの皆様、これからソラコムを使おうと思っているユーザー、エンジニアの方には、dev.soracom.io からユーザーガイド、開発者ガイドを用意しています。

これらのガイドは以下のような構成となっています。

  • 概要 – サービスの概要を説明しています、
  • 機能の説明 – 仕組みや利用方法、設定項目の説明などを記載しています。
  • Getting Started – 特定の使用方法で、実際に利用するにあたっての手順を記載しています。
  • 制限事項と注意事項 – サービスの制限事項を記載しています。

そしてソラコムの for Developers サイトで最もアクセスがあるのは、、、、API Reference です！

こちらは Swagger というツールをベースにしていて、実際に当ページからAPIを実行することができます。

こちらにソラコムアカウント(Operator)のユーザーID、パスワードをいれて「認証」をクリックすると API token が取得できます。

listSubscribers のタブを開き、

「Try it out!」をクリックすると、subscriberlistを取得できました！

Curlコマンドも表示されますので、これをコピーして、そのまま Terminal などに貼り付け、コマンドを実行することもできます。

今後も引き続き技術ドキュメントだけでなく事例なども充実させていきます。
ぜひご覧いただき、少しでもお役に立てれば幸いです！

ソラコム 江木(nori)

エンジニアブログ