Membuat target gambar baru | POST /targets
Unggah gambar pengenalan untuk membuat target gambar baru
Action
POST /targets
Autentikasi
Http Header
Content-Type=application/json
HTTP Header: Authorization (saat menggunakan metode autentikasi API Key Token)
Parameter permintaan
| Field | Type | Diperlukan | Deskripsi |
|---|---|---|---|
| image | String(base64) | Ya | String encoding base64 konten gambar, mendukung format gambar JPG dan PNG. Ukuran gambar maksimal 2MB. |
| active | String | Tidak | "1" mengaktifkan target, "0" menonaktifkan target. Default "1". |
| name | String | Ya | Nama target, hanya mendukung huruf alfabet Inggris, tanda baca Inggris, angka, panjang minimal 1 karakter, maksimal 64 karakter. |
| size | String(Float) | Ya | Lebar gambar pengenalan (satuan cm). Tinggi gambar akan dihitung otomatis oleh sistem berdasarkan gambar yang diunggah. Ukuran gambar pengenalan sesuai dengan ukuran konten virtual. Default 20. |
| meta | String | Ya | Biasanya digunakan untuk menyimpan informasi konten AR, format string teks, default "". Contoh: informasi JSON objek, encoding base64 gambar, atau URL unduhan file besar di penyimpanan cloud. Maksimal 2MB. |
| type | String (Float) | Ya | Harus dikonfigurasi tetap sebagai string "ImageTarget", perhatikan huruf besar kecil harus persis sama. |
| allowSimilar | String | Tidak | Apakah memperbolehkan penambahan jika ada gambar serupa, default 0. Gambar serupa dapat memengaruhi hasil pengenalan, disarankan menggunakan default. |
Catatan
- image dibatasi maksimal 2MB
- meta dibatasi maksimal 2MB
Contoh permintaan
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"
}
Contoh respons
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
}
Kolom respons
| Kolom | Deskripsi |
|---|---|
| statusCode | Kode status 0 menunjukkan autentikasi benar, lebih lanjut lihat Kode status |
| result | Pesan kesalahan, atau informasi gambar target |
| timestamp | Waktu server saat respons dikembalikan. Menggunakan format stempel waktu Unix, dalam milidetik |
| result.targetId | ID unik gambar target |
| result.trackingImage | String encoding base64 gambar pelacakan |
| result.name | Nama target |
| result.size | Lebar gambar pengenalan (satuan cm). Tinggi gambar akan dihitung otomatis oleh sistem berdasarkan gambar yang diunggah. Ukuran gambar pengenalan sesuai dengan ukuran konten virtual yang ditumpangkan |
| result.meta | Informasi tambahan encoding base64, misalnya string yang dihasilkan setelah mengkodekan string json dengan base64 |
| result.type | Tetap ImageTarget |
| result.active | "1" aktifkan, "0" nonaktifkan |
Kode kesalahan
Lihat Daftar kode status dan kesalahan
Petunjuk penggunaan meta
- Mengaitkan URL video
- Untuk setiap target pengenalan, Anda dapat menyimpan URL video yang terkait dengan target spesifik tersebut di dalam kolom meta
- Setelah aplikasi Anda mengenali target, gunakan URL dari meta untuk terhubung ke server, mengunduh dan memutar video, misalnya
https://my_server/my_videos/my_video_001.mp4
- Mengaitkan model 3D
- Untuk setiap target pengenalan, Anda dapat menyimpan model 3D atau paket sumber daya Unity yang terkait dengan target spesifik di kolom meta
- Perlu mengkodekan model dengan base64 sebelum menyimpan di meta, atau menyimpan URL model dalam metadata
- Ketika aplikasi mengenali target, model 3D akan dirender pada target yang terdeteksi