1. Início
  2. Base de Conhecimento
  3. Recursos
Searching...

Recursos

Adicionar/actualizar recurso

Adicionar ou actualizar (se for encontrado algum recurso com determinado guia de recurso) o recurso publicado.
 
URL:

PÓS http://api.aurelon.com/api/v2/

recurso

 
Pedir cabeçalhos:
Content-Type : dados multipartes/formato
MisKey : ver Autenticação
HardwareHash : ver Autenticação
SerialNumber : ver Autenticação
ApplicationVersion : ver Autenticação
Timestamp : formato ISO hora UTC.
A data/hora de modificação do recurso como “2018-11-01T08:41:34Z”. Quando o carimbo da hora não é fornecido, assume-se que ‘agora’. O carimbo da hora é comparado com o carimbo da hora do recurso na loja de nuvem. Só são aceites recursos mais recentes.
 
Pedido de corpo:
Dados do formulário 1: necessário

    • Nome: JsonString
    • Tipo de conteúdo: aplicação/json
    • Objecto JSON contendo:
    • ResourceGUID – necessário – o GUIA DE RECURSOS
    • ResourceChecksum – necessário – SHA1 checksum do recurso em formato de caixa alta.

 

  • ResourceType – necessário
    • o tipo do recurso
    • tipo de recurso conhecido: “NormalProfile”, “DefectProfile”, “FotobaMarks”, “Label”, “ColorMapping”, “Template”, “LayoutTemplate”, “Library”, “Preview”
    • o tipo de recurso pode ser um valor personalizado
    • se o tipo de recurso não for especificado, o tipo de recurso é definido como “Genérico”.
  • Meta – Objecto JSON contendo os metadados sobre o recurso;
  • MediaType – necessário para “NormalProfile” – a etiqueta Media do PMM.
  • ProfileGroup – necessário para “NormalProfile” – a etiqueta ProfileGroup do PMM
  • Nome – necessário

Dados do formulário 2: necessário

  • Nome: Nome do recurso, qualquer nome permitido
  • Tipo de conteúdo: aplicação/octet-stream
  • Conteúdo binário do recurso
  • Apenas um ficheiro aceite

 
Resposta:
O tipo de conteúdo da resposta está no formato JSON
 
O sucesso:

  • 200 OK : “Recurso adicionado com sucesso”

 
Erro:

  • 401 Não Autorizado : {“Mensagem”: “Invalid HardwareHash”}
  • 401 Não Autorizado : {“Mensagem”: “Inválido MisKey”}
  • 415 Tipo de meios de comunicação não suportados : {“Mensagem”: “Este pedido não está devidamente formatado”}
  • 401 Não Autorizado : {“Mensagem”: “”MisKey” ou “HardwareHash”, cabeçalho “SerialNumber” e “ApplicationVersion” são necessários”}
  • 400 Mau Pedido : {“Mensagem”: “Nenhum ficheiro de entrada especificado”}
  • 400 Mau Pedido : {“Message”:””ResourceGUID”, “ResourceChecksum” e “ResourceType” são necessários”}
  • 400 Mau Pedido : {“Mensagem”: “Validação do Timestamp falhou”}
  • 500 Erro do Servidor Interno : {“Mensagem”: “Erro do Servidor Interno”}

 

Obter recursos

Obter o ficheiro de recurso
 
URL:

GET http://api.aurelon.com/api/v2/

resource/<ResourceGUID>

 
Pedir cabeçalhos:
MisKey : ver Autenticação
HardwareHash : ver Autenticação
SerialNumber : ver Autenticação
ApplicationVersion : ver Autenticação
 
Resposta:
Devolver o ficheiro de recurso especificado no comando como aplicação do tipo de conteúdo/octet-stream
 
O sucesso:

  • 200 OK : Ficheiro de recurso fluxo binário

 
Erro:

  • 401 Não Autorizado : {“Mensagem”: “Inválida MisKey”}
  • 401 Não Autorizado : {“Mensagem”: “Invalid HardwareHash”}
  • 404 Não Autorizado : {“Mensagem”: “ResourceGUID não encontrado”}
  • 401 Não Autorizado : {“Mensagem”: “”MisKey” ou “HardwareHash”, “SerialNumber” e “ApplicationVersion” cabeçalho necessário”}
  • 500 Erro do Servidor Interno : {“Mensagem”: “Erro do Servidor Interno”}

Eliminar recurso

Eliminar o recurso com determinado recurso GUID.
 
URL:

DELETE http://api.aurelon.com/api/v2/

resource/<ResourceGUID>

 
Pedir cabeçalhos:
MisKey : ver Autenticação
HardwareHash : ver Autenticação
SerialNumber : ver Autenticação
ApplicationVersion : ver Autenticação
 
Resposta:
Aplicação do tipo de conteúdo/json contendo o resultado da operação.
 
O sucesso:

  • 200 OK : “Recurso eliminado com sucesso”

 
Erro:

  • 400 Mau Pedido : {“Message”:””ResourceGUID” valor requerido”}
  • 400 Mau Pedido : {“Mensagem”: “Recurso ainda em uso”}
  • 401 Não Autorizado : {“Mensagem”: “Invalid HardwareHash”}
  • 401 Não Autorizado : {“Mensagem”: “Inválido MisKey”}
  • 401 Não Autorizado : {“Mensagem”: “”MisKey” ou “HardwareHash”, cabeçalho “SerialNumber” e “ApplicationVersion” são necessários”}
  • 404 Não Encontrado : {“Mensagem”: “ResourceGUID não foi encontrado”}
  • 500 Erro do Servidor Interno : {“Mensagem”: “Erro do Servidor Interno”}

 

Listar recursos

Obter uma lista filtrada de todos os recursos da organização
 
URL:

PÓS http://api.aurelon.com/api/v2/

recurso

/lista

 
Pedir cabeçalhos:
Content-Type : aplicação/json
MisKey : ver Autenticação
HardwareHash : ver Autenticação
SerialNumber : ver Autenticação
ApplicationVersion : ver Autenticação
 
Pedido de corpo:
Objecto JSON contendo o tipo a filtrar:

  • ResourceTypes – necessário – um conjunto com um ou mais dos seguintes tipos (*,NormalProfile, DefectProfile, FotobaMarks, Etiqueta, ColorMapping, Template, LayoutTemplate, Biblioteca, Pré-visualização). Quando * é utilizado, então todos os recursos são listados.
  • Domínio – opcional – Domínio a consultar, valores permitidos Particular e Público. Por defeito, se não for especificado, Privado.

 
Ex:
{“ResourceTypes”:[“Label”, “Template”]}
 
Resposta:
Devolver os recursos da empresa filtrados por pedido de filtro corporal. A lista é um conjunto de matrizes embaladas. Cada item da matriz como um recurso representado por um conjunto de 4 elementos.
O método embalado é utilizado para poupar espaço na transferência. Os 4 elementos seguintes são apresentados pela ordem seguinte:

  1. ResourceGUID
  2. ResourceType
  3. SHA1 checksum
  4. Nome

 
O sucesso:

  • 200 OK : Devolver lista de recursos

[
[“88de5c02-cce6-411f-950f-be309caa4439″,”Label”,”acox3″,”MyName”],
[“1cb6e329-d001-4aff-970e-7cfaf025f27b”,”Label”,”1r3ff”,”Ticket”],
[“267437af-459b-4b9d-8ace-5d52658c4626″,”Template”,”erffeff”,”MyTmp”]
]
 
Erro:

  • 401 Não Autorizado : {“Mensagem”: “Invalid HardwareHash”}
  • 401 Não Autorizado : {“Mensagem”: “Inválido MisKey”}
  • 401 Não Autorizado : {“Mensagem”: “”MisKey” ou “HardwareHash”, cabeçalho “SerialNumber” e “ApplicationVersion” são necessários”}
  • 415 Tipo de meios de comunicação não suportados : {“Mensagem”: “Tipo esperado: aplicação/json”}
  • 500 Erro do Servidor Interno : {“Mensagem”: “Erro do Servidor Interno”}

 

Obter Informações de Recursos

Obter a informação básica do ficheiro de recurso para efeitos de sincronização
 
URL:

GET http://api.aurelon.com/api/v2/

resource/info/<ResourceGUID>

 
Pedir cabeçalhos:
MisKey : ver Autenticação
HardwareHash : ver Autenticação
SerialNumber : ver Autenticação
ApplicationVersion : ver Autenticação
 
Resposta:
Devolver a informação dos recursos em formato JSON
 
O sucesso:

  • 200 OK : Informação de recursos formatada JSON. ResourceGUID, ResourceChecksum, ResourceType, Timestamp, Meta e Meta.Name estão sempre disponíveis.
    {“ResourceGUID”: “”
     “ResourceChecksum”: “CF837A01C1F0342B121911A4FE17449D6B463310”,
     “ResourceType”: “NormalProfile”,
     “Timestamp”: “2018-11-01T08:41:34Z”,
     “Domínio”: “Privado”,
     “Meta”: {
     “Nome”: “Media > Mode”,
     “ProfileGroup”: “PDF”,
     “Media”: “Papel”,
     “Modo”: “600dpi”: “600dpi
     }

 
Erros:

  • 401 Não Autorizado : {“Mensagem”: “Inválido MisKey”}
  • 401 Não Autorizado : {“Mensagem”: “Invalid HardwareHash”}
  • 401 Não Autorizado : {“Message”:””MisKey” ou “HardwareHash”, “SerialNumber” e “ApplicationVersion” header required”}
  • 401 Não Autorizado : {“Mensagem”: “ResourceGUID sem acesso”}
  • 404 Não Autorizado : {“Mensagem”: “ResourceGUID não encontrado”}
  • 500 Erro do Servidor Interno : {“Mensagem”: “Erro do Servidor Interno”}
Updated on maio 10, 2022

Was this article helpful?

Yes No