REST APIではWebsocket APIと同じデータを受け付けます。こちらはデバイスへの一方向の指示のみ可能です。
エンドポイント
以下のURLが REST APIのエンドポイントで、obniz IDが必要です。
POST https://obniz.com/obniz/{obniz_id}/api/1
アクセストークン発行前であればobnizIdのみで利用が可能です。以下のプロパティがリクエストヘッダにより設定可能です。
プロパティ(query)
デフォルト値
説明
access_token
なし
デバイス管理でデバイスごとに発行したアクセストークン。または「デバイス制御」権限のあるAPIキーまたはWebAppトークンかOAuthトークン。
リクエストボディはapplication/json
に限られます。
以下がCurlでAPI利用例です。
curl https://obniz.com/obniz/1234-5678/api/1 -H "Content-Type: application/json" -X POST -d '[{"display":{"clear":true, "text":"Works fine."}}]'