This website is available for multi language.

obniz API

ハードウェアをAPIとして操作

API経由で全てをコントロール

obnizはWebsocketAPIに対してjsonでやり取りすることでハードウェアを操作する仕組みです。
IOのオンオフからUART/SPIでの送受信などIOに関する操作を中心に全てが行なえます。

ハードウェアをインターネット経由で操作する新しい方法です。

特にWebsocketAPIをHTMLから使えばハードウェアを双方向で簡単に操作可能です。
obniz.jsはWebsocketAPIをラップして使いやすくしたものです。

このページではAPIの詳細について記載しています。

エンドポイント

obnizはそれぞれ別々のエンドポイントを持ちます。個体識別番号(obnizId)ごとにURLが異なります。

WebSocket API

wss://obniz.io/obniz/{obniz_id}/ws/1

アクセストークン発行前であればobnizIdのみで接続が可能です。以下がSDKを使用せずjsだけで直接接続するExampleです。

<!-- HTML Example -->
<html>
<body>
<script>
  // Simplest example
  var host = 'wss://obniz.io'

  function connect() {
    var socket = new WebSocket(host + '/obniz/OBNIZ_ID_HERE/ws/1');

    socket.onmessage = function (event) {
      var arr = JSON.parse(event.data);
      for (var i=0; i<arr.length; i++) {
        var obj = arr[i];
        if (obj.ws && obj.ws.redirect) {
          host = obj.ws.redirect;
          socket.onmessage = null;
          socket.close();
          connect();
        }
        if (obj.ws && obj.ws.ready) {
          socket.send(JSON.stringify([{display:{clear:true}}, {display:{text:"Works fine."}}]));
        }
      }
    }

  }

  connect();

</script>
</body>
</html>

REST API

WebsocketAPIの他にREST APIも用意されています。こちらは送信のみでハードウェアからの情報受取はできません。

POST https://obniz.io/obniz/{obniz_id}/api/1

リクエストボディはapplication/jsonに限られます。
こちらもアクセストークン発行前であればobnizIdのみで接続できます。

Curlでの例です.

curl https://obniz.io/obniz/1234-5678/api/1 -H "Content-Type: application/json" -X POST -d '[{"display":{"clear":true, "text":"Works fine."}}]'

セキュリティ

ハードウェアがアカウントに紐付けられるとアクセストークンの発行が可能となります。 これはobnizを利用する上で必須ではありませんが、推奨となるセキュリティオプションです。
詳しくはデバイス管理のドキュメントをご覧ください。

JSON フォーマット

APIでのやりとりは全てJSONとなります。
送受信されるJSONはWebsocket API フォーマットがベースで、REST APIも同じものとなります。

obniz WebSocket format

最短で翌日に届きます

obniz BoardはAmazonや公式ストアから購入できます。最短で当日出荷いたします。
取り扱い店舗はこちらから。

製品紹介

フォーラム

obnizフォーラムでは、obnizユーザー同士で意見交換することができます。
疑問・質問もお気軽にどうぞ。

フォーラム

お問い合わせ

製品・サービスに関するお問い合わせや、導入・開発のご相談など、お気軽にお問い合わせください。

お問い合わせフォーム