跳到內容

建立或取代機械人(beta)

Beta
PUT
/v1/robots/{robotId}
curl --request PUT \
--url https://api.example.yas/v1/robots/rbt_example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "partnerId": "partner", "schemaVersion": "2026-11", "sourceSystem": "partner-export", "model": "M1", "serial": "SN-1001", "vin": "VIN-1001", "firmwareVersion": "1.4.2" }'

Beta。用 server key 建立或取代一台機械人。請送 partnerId、schemaVersion、sourceSystem、model 與 serial。之後再送會蓋掉舊內容。選填欄位不送就會清掉。updatedAt 是 ISO-8601 UTC。

robotId
required
string

Example

rbt_example

Request Bodyrequired

小節:Request Bodyrequired
Media typeapplication/json
object
partnerId
required

合作夥伴 id。必須與 server key 相符。

string
schemaVersion
required

這次內容的 schema 版本。例子:2026-11。

string
sourceSystem
required

送出這次內容的系統名稱。例子:partner-export。

string
model
required

機械人型號。

string
serial
required

序號。

string
vin

車輛識別碼。沒有就可以不送。

string
massKg

質量,單位是千克。

number
lengthM

長度,單位是米。

number
widthM

闊度,單位是米。

number
heightM

高度,單位是米。

number
ratedSpeedMps

額定速度,單位是米每秒。

number
maxSpeedMps

這台機械人設計上的最高速度,單位是米每秒。

number
batteryType

電池化學或電池組類型。例子:lithium。

string
batteryCapacityWh

電池容量,單位是瓦時。

number
sensorSuite

這台機械人的傳感器名稱。例子:lidar。

Array<string>
controller

控制器名稱。

string
firmwareVersion

送出時的韌體版本。

string
deployedOn

機械人投入使用的日期,格式 YYYY-MM-DD。

string format: date
metadata

合作夥伴的額外欄位。照送出的內容保存。

object
key
additional properties
any

Example

{
"partnerId": "partner",
"schemaVersion": "2026-11",
"sourceSystem": "partner-export",
"model": "M1",
"serial": "SN-1001",
"vin": "VIN-1001",
"firmwareVersion": "1.4.2"
}

機械人已保存。之後再送會蓋掉它。

Media typeapplication/json
object
robotId
required
string
updatedAt
required
string format: date-time

Example

{
"robotId": "rbt_example",
"updatedAt": "2026-10-15T10:00:00.000Z"
}
400缺少必填欄位。
Media typeapplication/json
object
error
required

穩定的錯誤代碼。沒有 stack trace。

string

Example

{
"error": "invalid_body"
}
401沒有 server key,或 server key 不正確。
Media typeapplication/json
object
error
required

穩定的錯誤代碼。沒有 stack trace。

string

Example

{
"error": "invalid_credentials"
}
403server key 可以只限車輛、只限機械人,或兩者都可以。超出範圍的呼叫是 403 `forbidden`,而且不會保存。`identity_mismatch` 表示 `partnerId` 與 server key 不符。
Media typeapplication/json
object
error
required

穩定的錯誤代碼。沒有 stack trace。

string

Example

{
"error": "forbidden"
}