Modificar propriedades da imagem alvo | PUT /target/<target_id>
Modifica as propriedades da imagem alvo correspondente ao target_id. Utiliza o método Http patch para alterar parâmetros, mantendo inalterados os parâmetros não modificados.
Action
PUT /target/<target_id>
Autenticação
Cabeçalho HTTP
Content-Type=application/json
HTTP Header: Authorization (ao usar autenticação por token de chave API)
Parâmetros da solicitação
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| image | String(base64) | Sim | String codificada em base64 do conteúdo da imagem, suporta formatos JPG e PNG. Tamanho máximo da imagem: 2MB. |
| active | String | Não | "1" para ativar o alvo, "0" para desativar o alvo. Padrão: "1" |
| name | String | Sim | Nome do alvo, suporta apenas letras inglesas, pontuação em inglês, números. Comprimento mínimo: 1 caractere, máximo: 64 caracteres |
| size | String (Float) | Sim | Largura da imagem de reconhecimento (em cm). A altura será calculada automaticamente pelo sistema com base na imagem enviada. O tamanho da imagem de reconhecimento corresponde ao tamanho do conteúdo virtual. Padrão: 20 |
| meta | String | Sim | Geralmente usado para armazenar informações de conteúdo AR, formato de string de texto, padrão: "". Exemplo: informações JSON do objeto reconhecido, codificação base64 da imagem ou URL de download de arquivo grande em armazenamento em nuvem. Máximo: 2MB. |
| type | String (Float) | Sim | Deve ser configurado fixamente como a string "ImageTarget", observe que as maiúsculas/minúsculas devem ser idênticas. |
| allowSimilar | String | Não | Se deve permitir forçosamente a adição caso exista imagem semelhante, padrão: 0. Imagens semelhantes podem afetar o reconhecimento, recomenda-se usar o padrão. |
Nota
- image limitado a 2MB máximo.
- meta limitado a 2MB máximo.
Exemplo de solicitação
PUT /target/e61db301-e80f-4025-b822-9a00eb48d8d2 HTTP/1.1
Host:
Date: Mon, 1 Jan 2018 00:00:00 GMT
Content-Type: application/json
{
"active":"1",
"name":"easyar",
"size":"5",
"meta":"496fbbabc2b38ecs3460a...",
"timestamp": 1514736000000,
"appKey": "test_app_key",
"signature": "89985e2420899196db5bdf16b3c2ed0922c0c221"
}
Exemplo de resposta
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",
"date": "2016-06-15T09:56:30.000Z",
"active":"1",
"trackableRate": 0,
"detectableRate": 0,
"detectableDistinctiveness":0,
"detectableFeatureCount": 0,
"trackableDistinctiveness": 0,
"trackableFeatureCount": 0,
"trackableFeatureDistribution": 0,
"trackablePatchContrast": 0,
"trackablePatchAmbiguity": 0
}
},
"timestamp": 1514736000000
}
Campos de resposta
| Campo | Descrição |
|---|---|
| statusCode | Código de status 0 indica autenticação correta. Mais referências em Códigos de status |
| result | Mensagem de erro ou informações da imagem alvo |
| timestamp | Horário do servidor no momento da resposta. Usa formato Unix timestamp em milissegundos |
| result.targetId | ID único da imagem alvo |
| result.trackingImage | String codificada em base64 da imagem de rastreamento |
| result.name | Nome do alvo |
| result.size | Largura da imagem de reconhecimento (em cm). A altura será calculada automaticamente pelo sistema. O tamanho corresponde ao conteúdo virtual sobreposto |
| result.meta | Informações adicionais codificadas em base64, por exemplo, string gerada após codificar uma string JSON em base64 |
| result.type | Fixado como ImageTarget |
| result.active | "1" ativado, "0" desativado |
Códigos de erro
Consulte Códigos de status e erros completos