Skip to main content

AUTH BLE Endpoint

Overview​

The AUTH BLE endpoint authenticates the robot request to communicate with the LOP. This endpoint requires a valid OTP from the robot for authorization. Authentication is required to access all other BLE endpoints in the LOP. Otherwise, access to other endpoints will be denied.

BLE Request from Robot to LOP​

{
  "code": "AUTH",
  "otp": "otp-from-robot-here"
}

BLE Response from LOP to Robot​

Success:​

{
  "code": "AUTH_OK",
  "value": "OK: Authenticated"
}

Failure:​

Missing OTP:

{
  "code": "ERROR",
  "value": "Bad Request: OTP missing"
}

Invalid OTP:

{
  "code": "ERROR",
  "value": "Forbidden: Invalid OTP"
}

Unauthenticated Access Response​

If the robot has not provided a valid OTP but tries to access other BLE endpoints, the LOP will respond with the following unauthenticated access response:

{
  "code": "ERROR",
  "value": "Unauthorized: Please authenticate first"
}