Table of Contents

創建新的影像目標 | 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 模型