User Tools

Site Tools


br-134-app-lkup


Solicitação APP / LKUP

O comando LKUP solicita ao webservice, por meio de POST, a pesquisa de novos canais.

A pesquisa de canais retorna uma lista com os primeiros 10 canais que obedecem o argumento de pesquisa. Caso a lista completa possua mais do que 10 canais, a resposta do webservice inclui também a tag more, que será igual à última das 10 tags recebidas.

Quando a tag more é obtida no resultado da pesquisa, o APP apresenta no final da lista de resultados o botão “More…”. Quando o usuário clica nesse botão, o APP submete uma nova pesquisa com o argumento more, informando o webservice que deseja os próximos 10 resultados, e assim por diante.

O resultado da pesquisa com a tag more vazia, indica que não há mais resultados além das tags apresentadas.

A pesquisa inclui também o hash MD5 do ícone do canal, permitindo ao APP obter a imagem do ícone em sua base local ou solicitar a imagem por meio do comando icon.

As imagens de ícones obtidos devem ser armazenadas na base local para o caso de futuras pesquisas.



Variáveis POST

id Código de identificação do dispositivo, sem criptografia (Device-ID)
key Chave AES (temporária), criptografada com a chave pública do dispositivo e codificada em Base64 / URL Encode.
frame String criptografado com a chave AES (temporária), contendo o XML de solicitação codificado em Base64 / URL Encode.



XML de resposta do POST

Após o processamento da solicitação contida no POST, o webservice retorna o seguinte XML para o solicitante:

<?xml version="1.0" encoding="utf-8"?>
<followzup>
<retcode>código-de-retorno</retcode>
<retframe>xml-de-resposta-da-solicitação</retframe>
<retmd5>md5-de-resposta</retmd5>
</followzup>

Onde:

  • código-de-retorno: String não criptografado, contendo o valor “0” (zero) para as solicitações executadas com sucesso, ou o código de erro correspondente, composto por 4 dígitos numéricos.
  • xml-de-resposta-da-solicitação: String criptografado com a mesma chave AES utilizada no envio da solicitação (chave temporária), e codificado em Base64.
  • md5-de-resposta: String contendo o hash md5 do campo acima.



XML de solicitação

<?xml version="1.0" encoding="utf-8"?>
<followzup>
<stp>stamp</stp>
<com>lkup</com>
<seq>sequência-da-solicitação</seq>
<chn>channel-arg</chn>
<mor>more-tag</mor>
</followzup>

Onde:

  • stamp: Código STAMP da Interface.
  • lsub: Comando para obter lista de canais assinados (List subscriptions);
  • sequência-da-solicitação: Número de sequência da solicitação;
  • channel-arg: Argumento de pesquisa de canal;
  • more-tag: Último canal listado na pesquisa parcial.



XML de resposta da solicitação

<?xml version="1.0" encoding="utf-8"?>
<followzup>
<chn>channel-tag;flag-private;flag-private-code;md5-icon;presentation-text</chn>
<chn>...</chn>
<mor>more-tag</mor>
</followzup>

Onde:

  • channel-tag: Nome do canal assinado;
  • flag-private: Indicativo de canal privado;
  • flag-private-code: Indicativo de atributo Private-Code;
  • md5-icon: Hash MD5 do ícone do canal;
  • presentation-text: Texto de apresentação do canal, codificado em BASE64.
  • more-tag: Último canal listado na pesquisa parcial.


XML de resposta da solicitação (sequência inválida):

<?xml version="1.0" encoding="utf-8"?>
<followzup>
<seq>Last-sequence</seq>
</followzup>

Onde:

  • Last-sequence: Número de sequência utilizado na última solicitação.



Códigos de Retorno

0 Execução com sucesso
7101 Sequência inválida
7102 Frame inválido
7103 Comando inválido
7104 Device-ID inválido
7242 Argumento de pesquisa com menos de 3 caracteres
7999 Webservice em manutenção


br-134-app-lkup.txt · Last modified: 2017/03/08 09:19 by admin

Page Tools