Skip to content

API Calls

Tal Ater edited this page Aug 5, 2017 · 7 revisions

Requests

Captain to Mission Control

The captain can call Mission Control to register/deregister itself, negotiate missions, report status, and more.

Registration

  • Register vehicle
  • Deregister vehicle

Mission Planning

  • Report mission proposal (following RFP)

Status Reports

  • Report Current state
  • Send photo
  • Send video
  • Report pickup completed (user placed package in vehicle)
  • Report drop-off completed (user took package from vehicle)

Mission Control to Captain

The captain responds to requests from Mission Control for mission negotiation, status reports, and more.

Mission Planning

  • Receive Mission RFP
  • Receive Mission Approval (following an RFP)

Status Reports

  • Receive request for current state
  • Receive request for current mission
  • Receive request for drone details
  • Receive request for photo
  • Receive request for video

Web UI to Mission Control

The captain responds to requests from the Web UI for status reports, wallet details, and more.

Status reports

  • Receive requests for current state
  • Receive requests for current mission

Wallet management

  • Receive requests for Wallets list
  • Receive requests for Wallet details

Commands

  • Receive requests to Register with Mission Control
  • Receive requests to Deregister with Mission Control

Captain to Vehicle

Status

  • Request current state

Commands

  • Request taking a photo
  • Request taking a video
  • Command to move to coordinates

Vehicle to Captain

Status

  • Send Photo
  • Send Video
  • Report that a move command was completed

Authentication

When a captain registers itself, it receives back a new key from mission control that needs to be included in all other calls to/from mission control.

This key is unique per Captain and registration.

The only request between Captain and Mission Control that does not require this key is the register call.