創建新的圖像目標 | POST /targets
上傳識別圖像，創建新的圖像目標
Action
POST /targets
認證
Http Header
Content-Type=application/json
HTTP Header: Authorization (當採用 API Key Token 方式認證)
請求參數
| Field | Type | Required | Description |
|---|---|---|---|
| image | String(base64) | Yes | 圖像內容的 base64 編碼字符串，支持 JPG 和 PNG 格式圖像。圖片最大 2MB。 |
| active | String | No | "1" 表示啓用目標，"0" 表示停用目標。默認爲 "1"。 |
| name | String | Yes | 目標名稱，僅支持英文字母、英文標點、數字，長度最小 1 個字符，最大 64 個字符。 |
| size | String（Float） | Yes | 識別圖寬度(單位 cm )。識別圖的高度將由系統根據您上傳的圖片自動計算。識別圖的大小和虛擬內容的大小對應。默認 20。 |
| meta | String | Yes | 一般用於存儲 AR 內容信息，文本字符串格式，默認是""。 例如：識別物的 JSON 信息，圖片的 base64 編碼，或者是大文件在雲存儲的 URL 下載地址。最大 2MB。 |
| type | String (Float) | Yes | 必須固定配置爲字符串 "ImageTarget"，注意大小寫需要完全一樣。 |
| allowSimilar | String | No | 如果存在相似圖是否強制允許添加，默認 0。相似圖可能影響識別結果，建議採用默認。 |
附註
- image 限制最大 2MB
- meta 限制最大 2MB
請求示例
POST /targets/ HTTP/1.1
Host:
Date: Mon, 1 Jan 2018 00:00:00 GMT
Content-Type: application/json
{
"image":"/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgM...",
"active":"1",
"name":"easyar",
"size":"5",
"meta":"496fbbabc2b38ecs3460a...",
"type":"ImageTarget",
"timestamp": 1514736000000,
"appKey": "test_app_key",
"signature": "89985e2420899196db5bdf16b3c2ed0922c0c221"
}
返回示例
HTTP/1.1 200 OK
Content-Type: application/json
{
"statusCode": 0,
"result": {
"target": {
"targetId":"e61db301-e80f-4025-b822-9a00eb48d8d2",
"trackingImage":"/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgM..."，
"name": "easyar",
"size": "5",
"meta": "496fbbabc2b38ecs3460a...",
"type": "ImageTarget",
"modified":1514735000000
"active":"1"，
"trackableRate": 0,
"detectableRate": 0,
"detectableDistinctiveness"：0,
"detectableFeatureCount", 0,
"trackableDistinctiveness", 0,
"trackableFeatureCount", 0,
"trackableFeatureDistribution", 0,
"trackablePatchContrast", 0,
"trackablePatchAmbiguity", 0
}
},
"timestamp": 1514736000000
}
返回字段
| 字段 | 描述 |
|---|---|
| statusCode | 狀態碼 0 表示認證正確，更多參考 狀態碼 |
| result | 錯誤消息，或者目標圖信息 |
| timestamp | 響應返回時的服務器端時間。使用 Unix 時間戳格式，以毫秒爲單位 |
| result.targetId | 目標圖的唯一 ID |
| result.trackingImage | 跟蹤圖像的 base64 編碼字符串 |
| result.name | 目標名稱 |
| result.size | 識別圖寬度（單位 cm ）。識別圖的高度將由系統根據您上傳的圖片自動計算。識別圖的大小和疊加虛擬內容的大小對應 |
| result.meta | base64 編碼的附加信息，例如將 json 字符串 base64 編碼後生成的字符串 |
| result.type | 固定爲 ImageTarget |
| result.active | "1" 啓用，"0" 停用 |
錯誤碼
參見 狀態碼以及錯誤碼大全
Meta 使用說明
- 關聯視頻 URL
- 對於每個識別目標，您可以存儲包含與該特定目標關聯的視頻 URL，關聯在 meta 字段裏
- 在您的應用識別目標後，使用 meta 中的 URL 連接到服務器，下載並播放視頻, 例如
https://my_server/my_videos/my_video_001.mp4
- 關聯 3D 模型
- 對於每個識別目標，您可以存儲包含 3D 模型或 Unity 資源包以與該特定目標關聯的 meta 字段
- 需要使用 base64 編碼模型再存儲在 meta 中，或者在元數據中存儲模型的 URL
- 當應用識別目標後，會在檢測到的目標上渲染 3D 模型