REST API

REST APIではWebsocket APIと同じデータを受け付けます。こちらはデバイスへの一方向の指示のみ可能です。

エンドポイント

以下のURLが REST APIのエンドポイントで、obniz IDが必要です。

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

アクセストークン発行前であればobnizIdのみで利用が可能です。以下のプロパティがQueryStringにより設定可能です。

プロパティ(query)デフォルト値説明
access_tokenなしアクセストークン設定済みデバイスの場合に必要です。

リクエストボディはapplication/jsonに限られます。

以下がCurlでAPI利用例です。

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