Table of Contents

Membuat image target baru | POST /targets

Upload recognition image dan buat image target baru.

Action

POST /targets

Authentication

Required

Http Header

Content-Type=application/json

HTTP Header: Authorization (saat menggunakan API Key Token authentication)

Request parameters

Field Type Required Description
image String(base64) Yes String base64-encoded dari image content. Mendukung image format JPG dan PNG. Ukuran image maksimum 2MB.
active String No "1" berarti enable target, "0" berarti disable target. Default adalah "1".
name String Yes Nama target. Hanya mendukung huruf Inggris, tanda baca Inggris, dan angka. Panjang minimum 1 karakter, maksimum 64 karakter.
size String (Float) Yes Lebar recognition image (unit cm). Tinggi recognition image akan dihitung otomatis oleh sistem berdasarkan image yang Anda upload. Ukuran recognition image sesuai dengan ukuran virtual content. Default 20.
meta String Yes Biasanya digunakan untuk menyimpan informasi AR content dalam format text string. Default adalah "". Contoh: informasi JSON dari recognized object, base64 encoding image, atau URL download address file besar di cloud storage. Maksimum 2MB.
type String (Float) Yes Harus fixed sebagai string "ImageTarget". Case harus sama persis.
allowSimilar String No Apakah forcibly allow adding jika ada similar image. Default 0. Similar image dapat memengaruhi recognition result, sehingga default direkomendasikan.
Catatan
  • batas maksimum image: 2MB
  • batas maksimum meta: 2MB

Request example

    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"
    }

Response example

    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
    }

Response fields

Field Description
statusCode Status code. 0 berarti authentication benar. Untuk informasi lebih lanjut, lihat Status codes
result Error message atau target image information
timestamp Server-side time saat response dikembalikan. Menggunakan format Unix timestamp dalam milidetik
result.targetId Unique ID target image
result.trackingImage String base64-encoded dari tracking image
result.name Target name
result.size Lebar recognition image (unit cm). Tinggi recognition image akan dihitung otomatis oleh sistem berdasarkan image yang Anda upload. Ukuran recognition image sesuai dengan ukuran overlaid virtual content
result.meta Informasi tambahan base64-encoded, misalnya string yang dihasilkan dari base64-encoding json string
result.type Fixed sebagai ImageTarget
result.active "1" enabled, "0" disabled

Error codes

Lihat Daftar lengkap status codes dan error codes

Instruksi penggunaan Meta

  • Mengaitkan video URL
    • Untuk setiap recognition target, Anda dapat menyimpan video URL yang terkait dengan target khusus tersebut dalam field meta
    • Setelah aplikasi Anda mengenali target, gunakan URL dalam meta untuk connect ke server, download, dan play video, misalnya https://my_server/my_videos/my_video_001.mp4
  • Mengaitkan 3D model
    • Untuk setiap recognition target, Anda dapat menyimpan field meta yang berisi 3D model atau Unity asset bundle yang terkait dengan target khusus tersebut
    • Anda perlu melakukan base64-encode model lalu menyimpannya di meta, atau menyimpan URL model di metadata
    • Setelah aplikasi mengenali target, aplikasi akan merender 3D model pada detected target