Criar um novo image target | POST /targets
Faça upload de uma recognition image e crie um novo image target.
Action
POST /targets
Authentication
Http Header
Content-Type=application/json
HTTP Header: Authorization (ao usar API Key Token authentication)
Request parameters
| Field | Type | Required | Description |
|---|---|---|---|
| image | String(base64) | Yes | String base64-encoded do image content. Images nos formatos JPG e PNG são suportadas. Tamanho máximo da image: 2MB. |
| active | String | No | "1" significa enable target, "0" significa disable target. O default é "1". |
| name | String | Yes | Target name. Suporta apenas letras inglesas, pontuação inglesa e dígitos. Comprimento mínimo de 1 character e máximo de 64 characters. |
| size | String (Float) | Yes | Largura da recognition image (unit: cm). A altura da recognition image será calculada automaticamente pelo sistema com base na image que você upload. O tamanho da recognition image corresponde ao tamanho do virtual content. Default 20. |
| meta | String | Yes | Geralmente usado para armazenar AR content information em formato text string. O default é "". Por exemplo: JSON information do objeto reconhecido, base64 encoding de uma image, ou URL download address de um arquivo grande em cloud storage. Máximo 2MB. |
| type | String (Float) | Yes | Deve ser configurado fixamente como a string "ImageTarget". A diferenciação entre maiúsculas e minúsculas deve corresponder exatamente. |
| allowSimilar | String | No | Se deve permitir forçadamente adicionar quando existir similar image. Default 0. Similar images podem afetar recognition results, portanto o default é recomendado. |
Nota
- limite máximo de image: 2MB
- limite máximo de 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 significa que authentication está correta. Para mais informações, consulte Status codes |
| result | Error message ou target image information |
| timestamp | Server-side time quando a response é retornada. Usa Unix timestamp format em milissegundos |
| result.targetId | Unique ID da target image |
| result.trackingImage | String base64-encoded da tracking image |
| result.name | Target name |
| result.size | Largura da recognition image (unit: cm). A altura da recognition image será calculada automaticamente pelo sistema com base na image que você upload. O tamanho da recognition image corresponde ao tamanho do virtual content sobreposto |
| result.meta | Additional information base64-encoded, por exemplo a string gerada após base64-encoding de uma json string |
| result.type | Fixed as ImageTarget |
| result.active | "1" enabled, "0" disabled |
Error codes
Consulte Lista completa de status codes e error codes
Instruções de uso de Meta
- Associar um video URL
- Para cada recognition target, você pode armazenar no field meta o video URL associado a esse target específico
- Depois que sua aplicação reconhecer o target, use a URL em meta para conectar ao servidor, fazer download e reproduzir o vídeo, por exemplo
https://my_server/my_videos/my_video_001.mp4
- Associar um 3D model
- Para cada recognition target, você pode armazenar um field meta contendo um 3D model ou Unity asset bundle associado a esse target específico
- É necessário fazer base64 encoding do model e armazená-lo em meta, ou armazenar a URL do model nos metadata
- Depois que a aplicação reconhecer o target, ela renderiza o 3D model no detected target