このページではロボットをカスタマイズする際に利用できるAPIについて記述する。SysUI経由で内部APPからのみ送受信可能なものは、連携が×となっておりそれ以外は、HTTP通信によって外部機器から送受信可能となっている。 なお、指示や取得への応答は、ほとんどのAPIで非同期となっており、info型で返却される。これは、複数の外部連携機器や画面同期を実現するための仕組みであり、どこで操作が行われても全連携システムに、結果が同報的に送信されることを担保する仕組みである。

　BUDDYの顔画面（ブラウザ）上で動くアプリは全てSysUIのiframeの内部で動作する。APIは全てjavascriptのsysuiクラスで実装済みであり、アプリでは親クラスを継承して関数を呼び出すだけとなる。詳細は標準アプリを参照すること。

　受信側は特殊なつくりとなっており、アプリのルートディレクトリ内に配置されるservice_event_dispatch_setting.jsonというファイルの設定に従って、iframeの内部で動くアプリのURLを強制的に切り替える動作をする。これは画面の非同期的処理を実現するための簡便な仕掛けである。

　従って、service_event_dispatch_setting.jsonに以下のような登録があると、

    {
      "title": "*****",
      "id": "info_move_start",
      "dispatch_type": "1",
      "url": "http://localhost/intruder/onmove.php"
    },

ロボットがinfo_move_start（移動開始通知）を送信すると、SysUIがアプリの画面を強制的にonmove.phpに切り替えるという設定となる。これによって、常時通信を監視しなくても、イベント駆動型の画面切り替えが簡便に製造可能となる。

　外部APIは上記とはまったくことなる仕組みであり、SysUIの継承や制約なく、独自の外部システムと連携するためのAPIである。送信はBUDDYのIPアドレス:8088/api/requestに向けてPOSTをする形で実行し、応答は非同期的に設定されたすべての宛先（内部APIを含めて ）に対してロボット側からPOSTの形で実行される。

APIには4種類あり、以下一覧ではそれぞれに分けて説明する。すべてPOSTで送信する。

1. 設定
   • ロボットに対して設定を行うコマンド
2. 取得
   • 取得はロボットの設定等を取得する。
3. 指示
   • 記号なしリスト指示はロボットに対して指示を行う。
   • その際の応答は、命令を受信したというACK以外はinfoやresなどでpush形で返却されることを想定している。
4. 通知
   • ロボットからpush形でくる通知系。目的地に着いた時や障害物検知停止した時など。内部APIとしては、イベント通知登録を事前にしておくことで、画面を強制遷移させる形で受信することができる。

※汎用USB機能を使用される際のPOSTの宛先は以下となります。

http://localhost:8088/api/request

{

"type":"req_move",	
"data":{	
	"speech_text":"○○○○へ移動します",
	"audio_dataid":"",
	"notice":"ON",
	"goal_destination_id":"1234567890123456",
	"speed_rate":100,
	"another_route": 1
}	

}