Table of Contents

Criar novo alvo de imagem | POST /targets

Carregar imagem de reconhecimento para criar um novo alvo de imagem

Action

POST /targets

Autenticação

Obrigatório

Cabeçalho HTTP

Content-Type=application/json

Cabeçalho HTTP: Authorization (ao usar autenticação por token de API Key)

Parâmetros de 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" ativa o alvo, "0" desativa 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. O tamanho corresponde ao conteúdo virtual. Padrão: 20.
meta String Sim Usado geralmente para armazenar informações de conteúdo AR, formato de string de texto, padrão: "". Ex: informações JSON do objeto, codificação base64 de imagem ou URL de download de arquivo em armazenamento em nuvem. Máximo: 2MB.
type String (Float) Sim Deve ser configurado exatamente como a string "ImageTarget", respeitando maiúsculas/minúsculas.
allowSimilar String Não Se permite forçar adição caso existam imagens similares, padrão 0. Imagens similares podem afetar reconhecimento, recomenda-se usar padrão.
Nota
  • image limitado a 2MB máximo
  • meta limitado a 2MB máximo

Exemplo de solicitação

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

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",
            "modified":1514735000000
            "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 do alvo
timestamp Horário do servidor no momento da resposta. Formato Unix timestamp em milissegundos
result.targetId ID único do 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). Altura calculada automaticamente. Tamanho corresponde ao conteúdo virtual
result.meta Informações adicionais codificadas em base64, ex: string gerada após codificar JSON em base64
result.type Fixo como ImageTarget
result.active "1" ativo, "0" inativo

Códigos de erro

Consulte Lista completa de códigos de status e erros

Instruções de uso do Meta

  • Associar URL de vídeo
    • Para cada alvo de reconhecimento, armazene o URL do vídeo associado no campo meta
    • Após reconhecimento, seu app usa o URL no meta para conectar ao servidor, baixar e reproduzir o vídeo, ex: https://my_server/my_videos/my_video_001.mp4
  • Associar modelo 3D
    • Para cada alvo, armazene modelos 3D ou pacotes de recursos Unity no campo meta
    • Codifique o modelo em base64 antes de armazenar no meta, ou armazene o URL do modelo nos metadados
    • Quando o app reconhecer o alvo, renderizará o modelo 3D sobre o alvo detectado